From 996911e385ffdfd9644c5a0512958127559dbf26 Mon Sep 17 00:00:00 2001 From: Bradley Schofield Date: Mon, 8 Jul 2024 10:42:27 +0900 Subject: [PATCH 1/6] Update delete authenticator to remove OTP Validation --- app/config/specs/open-api3-latest-client.json | 2 +- .../specs/open-api3-latest-console.json | 2 +- app/config/specs/open-api3-latest-server.json | 2 +- app/config/specs/swagger2-latest-client.json | 2 +- app/config/specs/swagger2-latest-console.json | 2 +- app/config/specs/swagger2-latest-server.json | 2 +- app/controllers/api/account.php | 26 ++----------------- 7 files changed, 8 insertions(+), 30 deletions(-) diff --git a/app/config/specs/open-api3-latest-client.json b/app/config/specs/open-api3-latest-client.json index cc79e05f2f..a42c0f1fb3 100644 --- a/app/config/specs/open-api3-latest-client.json +++ b/app/config/specs/open-api3-latest-client.json @@ -1 +1 @@ -{"openapi":"3.0.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"servers":[{"url":"https:\/\/cloud.appwrite.io\/v1"}],"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":""}},"required":["userId","email","password"]}}}}}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/identityList"}}}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","x-example":false}},"required":["mfa"]}}}}}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaType"}}}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["otp"]}}}}},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["otp"]}}}}}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaChallenge"}}}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}}}},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content","content":{"":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","x-example":""},"otp":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["challengeId","otp"]}}}}}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaFactors"}}}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":""}},"required":["name"]}}}}}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","x-example":"password"}},"required":["password"]}}}}}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["phone","password"]}}}}}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["email","url"]}}}}},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":""},"secret":{"type":"string","description":"Valid reset token.","x-example":""},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null}},"required":["userId","secret","password"]}}}}}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/sessionList"}}}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 session","operationId":"accountCreateOAuth2Session","tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"301":{"description":"File"}},"x-appwrite":{"method":"createOAuth2Session","weight":18,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"schema":{"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/targets\/push":{"post":{"summary":"Create push target","operationId":"accountCreatePushTarget","tags":["account"],"description":"","responses":{"201":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"createPushTarget","weight":53,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":""},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":""}},"required":["targetId","identifier"]}}}}}},"\/account\/targets\/{targetId}\/push":{"put":{"summary":"Update push target","operationId":"accountUpdatePushTarget","tags":["account"],"description":"","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"updatePushTarget","weight":54,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":""}},"required":["identifier"]}}}}},"delete":{"summary":"Delete push target","operationId":"accountDeletePushTarget","tags":["account"],"description":"","responses":{"204":{"description":"No content","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"deletePushTarget","weight":55,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"File"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"schema":{"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"}},"required":["userId","phone"]}}}}}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["url"]}}}}},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"schema":{"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"schema":{"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"schema":{"type":"string","default":""},"in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"schema":{"type":"string","x-example":""},"in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":1,"default":400},"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":1},"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"schema":{"type":"boolean","x-example":false,"default":false},"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/documentList"}}}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"data":{"type":"object","description":"Document data as JSON object.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/executionList"}}}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","x-example":""},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","x-example":""},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/locale"}}}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/localeCodeList"}}}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/continentList"}}}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/phoneList"}}}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/currencyList"}}}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/languageList"}}}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriber"}}}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Session":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","x-example":""},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","x-example":""}},"required":["subscriberId","targetId"]}}}}}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Session":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/fileList"}}}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"fileId":{"type":"string","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"","x-upload-id":true},"file":{"type":"string","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","x-example":null},"permissions":{"type":"array","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["fileId","file"]}}}}}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","x-example":""},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File ID","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"schema":{"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center"},"in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"schema":{"type":"number","format":"float","x-example":0,"default":1},"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"schema":{"type":"integer","format":"int32","x-example":-360,"default":0},"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"schema":{"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":""},"in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/teamList"}}}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"name":{"type":"string","description":"Team name. Max length: 128 chars.","x-example":""},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}}}}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","x-example":""}},"required":["name"]}}}}},"delete":{"summary":"Delete team","operationId":"teamsDelete","tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membershipList"}}}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","x-example":""},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","x-example":""}},"required":["roles"]}}}}}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["roles"]}}}}},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":""},"secret":{"type":"string","description":"Secret key.","x-example":""}},"required":["userId","secret"]}}}}}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"components":{"schemas":{"any":{"description":"Any","type":"object","additionalProperties":true},"error":{"description":"Error","type":"object","properties":{"message":{"type":"string","description":"Error message.","x-example":"Not found"},"code":{"type":"string","description":"Error code.","x-example":"404"},"type":{"type":"string","description":"Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes","x-example":"not_found"},"version":{"type":"string","description":"Server version number.","x-example":"1.0"}},"required":["message","code","type","version"]},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"$ref":"#\/components\/schemas\/document"},"x-example":""}},"required":["total","documents"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"$ref":"#\/components\/schemas\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"$ref":"#\/components\/schemas\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"$ref":"#\/components\/schemas\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"$ref":"#\/components\/schemas\/file"},"x-example":""}},"required":["total","files"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"$ref":"#\/components\/schemas\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"$ref":"#\/components\/schemas\/membership"},"x-example":""}},"required":["total","memberships"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"$ref":"#\/components\/schemas\/execution"},"x-example":""}},"required":["total","executions"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"$ref":"#\/components\/schemas\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"$ref":"#\/components\/schemas\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"$ref":"#\/components\/schemas\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"$ref":"#\/components\/schemas\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"$ref":"#\/components\/schemas\/phone"},"x-example":""}},"required":["total","phones"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"$ref":"#\/components\/schemas\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"oneOf":[{"$ref":"#\/components\/schemas\/algoArgon2"},{"$ref":"#\/components\/schemas\/algoScrypt"},{"$ref":"#\/components\/schemas\/algoScryptModified"},{"$ref":"#\/components\/schemas\/algoBcrypt"},{"$ref":"#\/components\/schemas\/algoPhpass"},{"$ref":"#\/components\/schemas\/algoSha"},{"$ref":"#\/components\/schemas\/algoMd5"}]},"nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"$ref":"#\/components\/schemas\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"$ref":"#\/components\/schemas\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]}},"securitySchemes":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":""}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header"},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Session":{"type":"apiKey","name":"X-Appwrite-Session","description":"The user session to authenticate with","in":"header"}}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file +{"openapi":"3.0.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"servers":[{"url":"https:\/\/cloud.appwrite.io\/v1"}],"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":""}},"required":["userId","email","password"]}}}}}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/identityList"}}}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","x-example":false}},"required":["mfa"]}}}}}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaType"}}}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["otp"]}}}}},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaChallenge"}}}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}}}},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content","content":{"":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","x-example":""},"otp":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["challengeId","otp"]}}}}}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaFactors"}}}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":""}},"required":["name"]}}}}}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","x-example":"password"}},"required":["password"]}}}}}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["phone","password"]}}}}}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["email","url"]}}}}},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":""},"secret":{"type":"string","description":"Valid reset token.","x-example":""},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null}},"required":["userId","secret","password"]}}}}}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/sessionList"}}}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 session","operationId":"accountCreateOAuth2Session","tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"301":{"description":"File"}},"x-appwrite":{"method":"createOAuth2Session","weight":18,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"schema":{"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/targets\/push":{"post":{"summary":"Create push target","operationId":"accountCreatePushTarget","tags":["account"],"description":"","responses":{"201":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"createPushTarget","weight":53,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":""},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":""}},"required":["targetId","identifier"]}}}}}},"\/account\/targets\/{targetId}\/push":{"put":{"summary":"Update push target","operationId":"accountUpdatePushTarget","tags":["account"],"description":"","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"updatePushTarget","weight":54,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":""}},"required":["identifier"]}}}}},"delete":{"summary":"Delete push target","operationId":"accountDeletePushTarget","tags":["account"],"description":"","responses":{"204":{"description":"No content","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"deletePushTarget","weight":55,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"File"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"schema":{"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"}},"required":["userId","phone"]}}}}}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["url"]}}}}},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"schema":{"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"schema":{"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"schema":{"type":"string","default":""},"in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"schema":{"type":"string","x-example":""},"in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":1,"default":400},"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":1},"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"schema":{"type":"boolean","x-example":false,"default":false},"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/documentList"}}}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"data":{"type":"object","description":"Document data as JSON object.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/executionList"}}}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","x-example":""},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","x-example":""},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/locale"}}}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/localeCodeList"}}}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/continentList"}}}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/phoneList"}}}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/currencyList"}}}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/languageList"}}}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriber"}}}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Session":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","x-example":""},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","x-example":""}},"required":["subscriberId","targetId"]}}}}}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Session":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/fileList"}}}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"fileId":{"type":"string","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"","x-upload-id":true},"file":{"type":"string","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","x-example":null},"permissions":{"type":"array","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["fileId","file"]}}}}}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","x-example":""},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File ID","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"schema":{"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center"},"in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"schema":{"type":"number","format":"float","x-example":0,"default":1},"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"schema":{"type":"integer","format":"int32","x-example":-360,"default":0},"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"schema":{"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":""},"in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/teamList"}}}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"name":{"type":"string","description":"Team name. Max length: 128 chars.","x-example":""},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}}}}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","x-example":""}},"required":["name"]}}}}},"delete":{"summary":"Delete team","operationId":"teamsDelete","tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membershipList"}}}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","x-example":""},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","x-example":""}},"required":["roles"]}}}}}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["roles"]}}}}},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":""},"secret":{"type":"string","description":"Secret key.","x-example":""}},"required":["userId","secret"]}}}}}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"components":{"schemas":{"any":{"description":"Any","type":"object","additionalProperties":true},"error":{"description":"Error","type":"object","properties":{"message":{"type":"string","description":"Error message.","x-example":"Not found"},"code":{"type":"string","description":"Error code.","x-example":"404"},"type":{"type":"string","description":"Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes","x-example":"not_found"},"version":{"type":"string","description":"Server version number.","x-example":"1.0"}},"required":["message","code","type","version"]},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"$ref":"#\/components\/schemas\/document"},"x-example":""}},"required":["total","documents"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"$ref":"#\/components\/schemas\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"$ref":"#\/components\/schemas\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"$ref":"#\/components\/schemas\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"$ref":"#\/components\/schemas\/file"},"x-example":""}},"required":["total","files"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"$ref":"#\/components\/schemas\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"$ref":"#\/components\/schemas\/membership"},"x-example":""}},"required":["total","memberships"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"$ref":"#\/components\/schemas\/execution"},"x-example":""}},"required":["total","executions"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"$ref":"#\/components\/schemas\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"$ref":"#\/components\/schemas\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"$ref":"#\/components\/schemas\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"$ref":"#\/components\/schemas\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"$ref":"#\/components\/schemas\/phone"},"x-example":""}},"required":["total","phones"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"$ref":"#\/components\/schemas\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"oneOf":[{"$ref":"#\/components\/schemas\/algoArgon2"},{"$ref":"#\/components\/schemas\/algoScrypt"},{"$ref":"#\/components\/schemas\/algoScryptModified"},{"$ref":"#\/components\/schemas\/algoBcrypt"},{"$ref":"#\/components\/schemas\/algoPhpass"},{"$ref":"#\/components\/schemas\/algoSha"},{"$ref":"#\/components\/schemas\/algoMd5"}]},"nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"$ref":"#\/components\/schemas\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"$ref":"#\/components\/schemas\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]}},"securitySchemes":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":""}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header"},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Session":{"type":"apiKey","name":"X-Appwrite-Session","description":"The user session to authenticate with","in":"header"}}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file diff --git a/app/config/specs/open-api3-latest-console.json b/app/config/specs/open-api3-latest-console.json index 15a9e75ea5..ef29473095 100644 --- a/app/config/specs/open-api3-latest-console.json +++ b/app/config/specs/open-api3-latest-console.json @@ -1 +1 @@ -{"openapi":"3.0.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"servers":[{"url":"https:\/\/cloud.appwrite.io\/v1"}],"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":""}},"required":["userId","email","password"]}}}}},"delete":{"summary":"Delete account","operationId":"accountDelete","tags":["account"],"description":"Delete the currently logged in user.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":9,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/identityList"}}}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","x-example":false}},"required":["mfa"]}}}}}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaType"}}}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["otp"]}}}}},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["otp"]}}}}}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaChallenge"}}}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}}}},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content","content":{"":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","x-example":""},"otp":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["challengeId","otp"]}}}}}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaFactors"}}}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":""}},"required":["name"]}}}}}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","x-example":"password"}},"required":["password"]}}}}}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["phone","password"]}}}}}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["email","url"]}}}}},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":""},"secret":{"type":"string","description":"Valid reset token.","x-example":""},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null}},"required":["userId","secret","password"]}}}}}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/sessionList"}}}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 session","operationId":"accountCreateOAuth2Session","tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"301":{"description":"File"}},"x-appwrite":{"method":"createOAuth2Session","weight":18,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"schema":{"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/targets\/push":{"post":{"summary":"Create push target","operationId":"accountCreatePushTarget","tags":["account"],"description":"","responses":{"201":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"createPushTarget","weight":53,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":""},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":""}},"required":["targetId","identifier"]}}}}}},"\/account\/targets\/{targetId}\/push":{"put":{"summary":"Update push target","operationId":"accountUpdatePushTarget","tags":["account"],"description":"","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"updatePushTarget","weight":54,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":""}},"required":["identifier"]}}}}},"delete":{"summary":"Delete push target","operationId":"accountDeletePushTarget","tags":["account"],"description":"","responses":{"204":{"description":"No content","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"deletePushTarget","weight":55,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"File"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"schema":{"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"}},"required":["userId","phone"]}}}}}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["url"]}}}}},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":""},"secret":{"type":"string","description":"Valid verification token.","x-example":""}},"required":["userId","secret"]}}}}}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"schema":{"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"schema":{"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"schema":{"type":"string","default":""},"in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"schema":{"type":"string","x-example":""},"in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":1,"default":400},"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":1},"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"schema":{"type":"boolean","x-example":false,"default":false},"in":"query"}]}},"\/console\/assistant":{"post":{"summary":"Ask Query","operationId":"assistantChat","tags":["assistant"],"description":"","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"chat","weight":328,"cookies":false,"type":"","deprecated":false,"demo":"assistant\/chat.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/assistant\/chat.md","rate-limit":15,"rate-time":3600,"rate-key":"userId:{userId}","scope":"assistant.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prompt":{"type":"string","description":"Prompt. A string containing questions asked to the AI assistant.","x-example":""}},"required":["prompt"]}}}}}},"\/console\/variables":{"get":{"summary":"Get variables","operationId":"consoleVariables","tags":["console"],"description":"Get all Environment Variables that are relevant for the console.","responses":{"200":{"description":"Console Variables","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/consoleVariables"}}}}},"x-appwrite":{"method":"variables","weight":327,"cookies":false,"type":"","deprecated":false,"demo":"console\/variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/console\/variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/databases":{"get":{"summary":"List databases","operationId":"databasesList","tags":["databases"],"description":"Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.","responses":{"200":{"description":"Databases List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/databaseList"}}}}},"x-appwrite":{"method":"list","weight":69,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create database","operationId":"databasesCreate","tags":["databases"],"description":"Create a new Database.\n","responses":{"201":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"create","weight":68,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"databaseId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"name":{"type":"string","description":"Database name. Max length: 128 chars.","x-example":""},"enabled":{"type":"boolean","description":"Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","x-example":false}},"required":["databaseId","name"]}}}}}},"\/databases\/usage":{"get":{"summary":"Get databases usage stats","operationId":"databasesGetUsage","tags":["databases"],"description":"","responses":{"200":{"description":"UsageDatabases","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageDatabases"}}}}},"x-appwrite":{"method":"getUsage","weight":113,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"`Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/databases\/{databaseId}":{"get":{"summary":"Get database","operationId":"databasesGet","tags":["databases"],"description":"Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.","responses":{"200":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"get","weight":70,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"put":{"summary":"Update database","operationId":"databasesUpdate","tags":["databases"],"description":"Update a database by its unique ID.","responses":{"200":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"update","weight":72,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Database name. Max length: 128 chars.","x-example":""},"enabled":{"type":"boolean","description":"Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete database","operationId":"databasesDelete","tags":["databases"],"description":"Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":73,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/databases\/{databaseId}\/collections":{"get":{"summary":"List collections","operationId":"databasesListCollections","tags":["databases"],"description":"Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.","responses":{"200":{"description":"Collections List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collectionList"}}}}},"x-appwrite":{"method":"listCollections","weight":75,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collections.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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: name, enabled, documentSecurity","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create collection","operationId":"databasesCreateCollection","tags":["databases"],"description":"Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"createCollection","weight":74,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"collectionId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"name":{"type":"string","description":"Collection name. Max length: 128 chars.","x-example":""},"permissions":{"type":"array","description":"An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","x-example":false}},"required":["collectionId","name"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}":{"get":{"summary":"Get collection","operationId":"databasesGetCollection","tags":["databases"],"description":"Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.","responses":{"200":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"getCollection","weight":76,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"put":{"summary":"Update collection","operationId":"databasesUpdateCollection","tags":["databases"],"description":"Update a collection by its unique ID.","responses":{"200":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"updateCollection","weight":78,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name. Max length: 128 chars.","x-example":""},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete collection","operationId":"databasesDeleteCollection","tags":["databases"],"description":"Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteCollection","weight":79,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes":{"get":{"summary":"List attributes","operationId":"databasesListAttributes","tags":["databases"],"description":"List attributes in the collection.","responses":{"200":{"description":"Attributes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeList"}}}}},"x-appwrite":{"method":"listAttributes","weight":90,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-attributes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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: key, type, size, required, array, status, error","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean":{"post":{"summary":"Create boolean attribute","operationId":"databasesCreateBooleanAttribute","tags":["databases"],"description":"Create a boolean attribute.\n","responses":{"202":{"description":"AttributeBoolean","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeBoolean"}}}}},"x-appwrite":{"method":"createBooleanAttribute","weight":87,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}":{"patch":{"summary":"Update boolean attribute","operationId":"databasesUpdateBooleanAttribute","tags":["databases"],"description":"Update a boolean attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeBoolean","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeBoolean"}}}}},"x-appwrite":{"method":"updateBooleanAttribute","weight":99,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime":{"post":{"summary":"Create datetime attribute","operationId":"databasesCreateDatetimeAttribute","tags":["databases"],"description":"Create a date time attribute according to the ISO 8601 standard.","responses":{"202":{"description":"AttributeDatetime","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeDatetime"}}}}},"x-appwrite":{"method":"createDatetimeAttribute","weight":88,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}":{"patch":{"summary":"Update dateTime attribute","operationId":"databasesUpdateDatetimeAttribute","tags":["databases"],"description":"Update a date time attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeDatetime","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeDatetime"}}}}},"x-appwrite":{"method":"updateDatetimeAttribute","weight":100,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email":{"post":{"summary":"Create email attribute","operationId":"databasesCreateEmailAttribute","tags":["databases"],"description":"Create an email attribute.\n","responses":{"202":{"description":"AttributeEmail","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeEmail"}}}}},"x-appwrite":{"method":"createEmailAttribute","weight":81,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"email@example.com"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}":{"patch":{"summary":"Update email attribute","operationId":"databasesUpdateEmailAttribute","tags":["databases"],"description":"Update an email attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEmail","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeEmail"}}}}},"x-appwrite":{"method":"updateEmailAttribute","weight":93,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"email@example.com","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum":{"post":{"summary":"Create enum attribute","operationId":"databasesCreateEnumAttribute","tags":["databases"],"description":"Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n","responses":{"202":{"description":"AttributeEnum","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeEnum"}}}}},"x-appwrite":{"method":"createEnumAttribute","weight":82,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":""},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","elements","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}":{"patch":{"summary":"Update enum attribute","operationId":"databasesUpdateEnumAttribute","tags":["databases"],"description":"Update an enum attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEnum","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeEnum"}}}}},"x-appwrite":{"method":"updateEnumAttribute","weight":94,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"","x-nullable":true}},"required":["elements","required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float":{"post":{"summary":"Create float attribute","operationId":"databasesCreateFloatAttribute","tags":["databases"],"description":"Create a float attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeFloat","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeFloat"}}}}},"x-appwrite":{"method":"createFloatAttribute","weight":86,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float\/{key}":{"patch":{"summary":"Update float attribute","operationId":"databasesUpdateFloatAttribute","tags":["databases"],"description":"Update a float attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeFloat","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeFloat"}}}}},"x-appwrite":{"method":"updateFloatAttribute","weight":98,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer":{"post":{"summary":"Create integer attribute","operationId":"databasesCreateIntegerAttribute","tags":["databases"],"description":"Create an integer attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeInteger","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeInteger"}}}}},"x-appwrite":{"method":"createIntegerAttribute","weight":85,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer\/{key}":{"patch":{"summary":"Update integer attribute","operationId":"databasesUpdateIntegerAttribute","tags":["databases"],"description":"Update an integer attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeInteger","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeInteger"}}}}},"x-appwrite":{"method":"updateIntegerAttribute","weight":97,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip":{"post":{"summary":"Create IP address attribute","operationId":"databasesCreateIpAttribute","tags":["databases"],"description":"Create IP address attribute.\n","responses":{"202":{"description":"AttributeIP","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeIp"}}}}},"x-appwrite":{"method":"createIpAttribute","weight":83,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}":{"patch":{"summary":"Update IP address attribute","operationId":"databasesUpdateIpAttribute","tags":["databases"],"description":"Update an ip attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeIP","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeIp"}}}}},"x-appwrite":{"method":"updateIpAttribute","weight":95,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship":{"post":{"summary":"Create relationship attribute","operationId":"databasesCreateRelationshipAttribute","tags":["databases"],"description":"Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"202":{"description":"AttributeRelationship","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeRelationship"}}}}},"x-appwrite":{"method":"createRelationshipAttribute","weight":89,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"relatedCollectionId":{"type":"string","description":"Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","x-example":""},"type":{"type":"string","description":"Relation type","x-example":"oneToOne","enum":["oneToOne","manyToOne","manyToMany","oneToMany"],"x-enum-name":"RelationshipType","x-enum-keys":[]},"twoWay":{"type":"boolean","description":"Is Two Way?","x-example":false},"key":{"type":"string","description":"Attribute Key.","x-example":null},"twoWayKey":{"type":"string","description":"Two Way Attribute Key.","x-example":null},"onDelete":{"type":"string","description":"Constraints option","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}},"required":["relatedCollectionId","type"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string":{"post":{"summary":"Create string attribute","operationId":"databasesCreateStringAttribute","tags":["databases"],"description":"Create a string attribute.\n","responses":{"202":{"description":"AttributeString","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeString"}}}}},"x-appwrite":{"method":"createStringAttribute","weight":80,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"size":{"type":"integer","description":"Attribute size for text attributes, in number of characters.","x-example":1},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":""},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false},"encrypt":{"type":"boolean","description":"Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.","x-example":false}},"required":["key","size","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}":{"patch":{"summary":"Update string attribute","operationId":"databasesUpdateStringAttribute","tags":["databases"],"description":"Update a string attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeString","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeString"}}}}},"x-appwrite":{"method":"updateStringAttribute","weight":92,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url":{"post":{"summary":"Create URL attribute","operationId":"databasesCreateUrlAttribute","tags":["databases"],"description":"Create a URL attribute.\n","responses":{"202":{"description":"AttributeURL","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeUrl"}}}}},"x-appwrite":{"method":"createUrlAttribute","weight":84,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"https:\/\/example.com"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}":{"patch":{"summary":"Update URL attribute","operationId":"databasesUpdateUrlAttribute","tags":["databases"],"description":"Update an url attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeURL","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeUrl"}}}}},"x-appwrite":{"method":"updateUrlAttribute","weight":96,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"https:\/\/example.com","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}":{"get":{"summary":"Get attribute","operationId":"databasesGetAttribute","tags":["databases"],"description":"Get attribute by ID.","responses":{"200":{"description":"AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]}}}}},"x-appwrite":{"method":"getAttribute","weight":91,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}]},"delete":{"summary":"Delete attribute","operationId":"databasesDeleteAttribute","tags":["databases"],"description":"Deletes an attribute.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteAttribute","weight":102,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship":{"patch":{"summary":"Update relationship attribute","operationId":"databasesUpdateRelationshipAttribute","tags":["databases"],"description":"Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"200":{"description":"AttributeRelationship","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeRelationship"}}}}},"x-appwrite":{"method":"updateRelationshipAttribute","weight":101,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"onDelete":{"type":"string","description":"Constraints option","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}}}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/documentList"}}}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"data":{"type":"object","description":"Document data as JSON object.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs":{"get":{"summary":"List document logs","operationId":"databasesListDocumentLogs","tags":["databases"],"description":"Get the document activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listDocumentLogs","weight":110,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-document-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes":{"get":{"summary":"List indexes","operationId":"databasesListIndexes","tags":["databases"],"description":"List indexes in the collection.","responses":{"200":{"description":"Indexes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/indexList"}}}}},"x-appwrite":{"method":"listIndexes","weight":104,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-indexes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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: key, type, status, attributes, error","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create index","operationId":"databasesCreateIndex","tags":["databases"],"description":"Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.","responses":{"202":{"description":"Index","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/index"}}}}},"x-appwrite":{"method":"createIndex","weight":103,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":null},"type":{"type":"string","description":"Index type.","x-example":"key","enum":["key","fulltext","unique"],"x-enum-name":"IndexType","x-enum-keys":[]},"attributes":{"type":"array","description":"Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}},"orders":{"type":"array","description":"Array of index orders. Maximum of 100 orders are allowed.","x-example":null,"items":{"type":"string"}}},"required":["key","type","attributes"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}":{"get":{"summary":"Get index","operationId":"databasesGetIndex","tags":["databases"],"description":"Get index by ID.","responses":{"200":{"description":"Index","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/index"}}}}},"x-appwrite":{"method":"getIndex","weight":105,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Index Key.","required":true,"schema":{"type":"string"},"in":"path"}]},"delete":{"summary":"Delete index","operationId":"databasesDeleteIndex","tags":["databases"],"description":"Delete an index.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIndex","weight":106,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"key","description":"Index Key.","required":true,"schema":{"type":"string"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/logs":{"get":{"summary":"List collection logs","operationId":"databasesListCollectionLogs","tags":["databases"],"description":"Get the collection activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listCollectionLogs","weight":77,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collection-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/usage":{"get":{"summary":"Get collection usage stats","operationId":"databasesGetCollectionUsage","tags":["databases"],"description":"","responses":{"200":{"description":"UsageCollection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageCollection"}}}}},"x-appwrite":{"method":"getCollectionUsage","weight":115,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/databases\/{databaseId}\/logs":{"get":{"summary":"List database logs","operationId":"databasesListLogs","tags":["databases"],"description":"Get the database activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":71,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/databases\/{databaseId}\/usage":{"get":{"summary":"Get database usage stats","operationId":"databasesGetDatabaseUsage","tags":["databases"],"description":"","responses":{"200":{"description":"UsageDatabase","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageDatabase"}}}}},"x-appwrite":{"method":"getDatabaseUsage","weight":114,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-database-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"range","description":"`Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/functions":{"get":{"summary":"List functions","operationId":"functionsList","tags":["functions"],"description":"Get a list of all the project's functions. You can use the query params to filter your results.","responses":{"200":{"description":"Functions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/functionList"}}}}},"x-appwrite":{"method":"list","weight":287,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create function","operationId":"functionsCreate","tags":["functions"],"description":"Create a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.","responses":{"201":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"create","weight":286,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"functionId":{"type":"string","description":"Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"name":{"type":"string","description":"Function name. Max length: 128 chars.","x-example":""},"runtime":{"type":"string","description":"Execution runtime.","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.21","deno-1.24","deno-1.35","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","x-example":null},"timeout":{"type":"integer","description":"Function maximum execution time in seconds.","x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","x-example":""},"commands":{"type":"string","description":"Build Commands.","x-example":""},"scopes":{"type":"array","description":"List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Control System) deployment.","x-example":""},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function.","x-example":""},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function.","x-example":""},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","x-example":""},"templateRepository":{"type":"string","description":"Repository name of the template.","x-example":""},"templateOwner":{"type":"string","description":"The name of the owner of the template.","x-example":""},"templateRootDirectory":{"type":"string","description":"Path to function code in the template repo.","x-example":""},"templateBranch":{"type":"string","description":"Production branch for the repo linked to the function template.","x-example":""}},"required":["functionId","name","runtime"]}}}}}},"\/functions\/runtimes":{"get":{"summary":"List runtimes","operationId":"functionsListRuntimes","tags":["functions"],"description":"Get a list of all runtimes that are currently active on your instance.","responses":{"200":{"description":"Runtimes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/runtimeList"}}}}},"x-appwrite":{"method":"listRuntimes","weight":288,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-runtimes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-runtimes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/functions\/usage":{"get":{"summary":"Get functions usage","operationId":"functionsGetUsage","tags":["functions"],"description":"","responses":{"200":{"description":"UsageFunctions","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageFunctions"}}}}},"x-appwrite":{"method":"getUsage","weight":291,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"FunctionUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/functions\/{functionId}":{"get":{"summary":"Get function","operationId":"functionsGet","tags":["functions"],"description":"Get a function by its unique ID.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"get","weight":289,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"put":{"summary":"Update function","operationId":"functionsUpdate","tags":["functions"],"description":"Update function by its unique ID.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"update","weight":292,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Function name. Max length: 128 chars.","x-example":""},"runtime":{"type":"string","description":"Execution runtime.","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.21","deno-1.24","deno-1.35","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","x-example":null},"timeout":{"type":"integer","description":"Maximum execution time in seconds.","x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","x-example":""},"commands":{"type":"string","description":"Build Commands.","x-example":""},"scopes":{"type":"array","description":"List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Controle System) deployment.","x-example":""},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function","x-example":""},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function","x-example":""},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","x-example":""}},"required":["name"]}}}}},"delete":{"summary":"Delete function","operationId":"functionsDelete","tags":["functions"],"description":"Delete a function by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":295,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/functions\/{functionId}\/deployments":{"get":{"summary":"List deployments","operationId":"functionsListDeployments","tags":["functions"],"description":"Get a list of all the project's code deployments. You can use the query params to filter your results.","responses":{"200":{"description":"Deployments List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deploymentList"}}}}},"x-appwrite":{"method":"listDeployments","weight":297,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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: size, buildId, activate, entrypoint, commands","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create deployment","operationId":"functionsCreateDeployment","tags":["functions"],"description":"Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.","responses":{"202":{"description":"Deployment","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deployment"}}}}},"x-appwrite":{"method":"createDeployment","weight":296,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":true,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"entrypoint":{"type":"string","description":"Entrypoint File.","x-example":""},"commands":{"type":"string","description":"Build Commands.","x-example":""},"code":{"type":"string","description":"Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.","x-example":null},"activate":{"type":"boolean","description":"Automatically activate the deployment when it is finished building.","x-example":false}},"required":["code","activate"]}}}}}},"\/functions\/{functionId}\/deployments\/{deploymentId}":{"get":{"summary":"Get deployment","operationId":"functionsGetDeployment","tags":["functions"],"description":"Get a code deployment by its unique ID.","responses":{"200":{"description":"Deployment","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deployment"}}}}},"x-appwrite":{"method":"getDeployment","weight":298,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"patch":{"summary":"Update function deployment","operationId":"functionsUpdateDeployment","tags":["functions"],"description":"Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"updateDeployment","weight":294,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"delete":{"summary":"Delete deployment","operationId":"functionsDeleteDeployment","tags":["functions"],"description":"Delete a code deployment by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDeployment","weight":299,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/build":{"post":{"summary":"Rebuild deployment","operationId":"functionsCreateBuild","tags":["functions"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createBuild","weight":300,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"buildId":{"type":"string","description":"Build unique ID.","x-example":""}}}}}}},"patch":{"summary":"Cancel deployment","operationId":"functionsUpdateDeploymentBuild","tags":["functions"],"description":"","responses":{"200":{"description":"Build","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/build"}}}}},"x-appwrite":{"method":"updateDeploymentBuild","weight":301,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/download":{"get":{"summary":"Download Deployment","operationId":"functionsDownloadDeployment","tags":["functions"],"description":"Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"downloadDeployment","weight":293,"cookies":false,"type":"location","deprecated":false,"demo":"functions\/download-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/download-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/executionList"}}}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","x-example":""},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","x-example":""},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"delete":{"summary":"Delete execution","operationId":"functionsDeleteExecution","tags":["functions"],"description":"Delete a function execution by its unique ID.\n","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteExecution","weight":305,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/functions\/{functionId}\/usage":{"get":{"summary":"Get function usage","operationId":"functionsGetFunctionUsage","tags":["functions"],"description":"","responses":{"200":{"description":"UsageFunction","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageFunction"}}}}},"x-appwrite":{"method":"getFunctionUsage","weight":290,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-function-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"FunctionUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/functions\/{functionId}\/variables":{"get":{"summary":"List variables","operationId":"functionsListVariables","tags":["functions"],"description":"Get a list of all variables of a specific function.","responses":{"200":{"description":"Variables List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variableList"}}}}},"x-appwrite":{"method":"listVariables","weight":307,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"post":{"summary":"Create variable","operationId":"functionsCreateVariable","tags":["functions"],"description":"Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.","responses":{"201":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"createVariable","weight":306,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":""},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":""}},"required":["key","value"]}}}}}},"\/functions\/{functionId}\/variables\/{variableId}":{"get":{"summary":"Get variable","operationId":"functionsGetVariable","tags":["functions"],"description":"Get a variable by its unique ID.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"getVariable","weight":308,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]},"put":{"summary":"Update variable","operationId":"functionsUpdateVariable","tags":["functions"],"description":"Update variable by its unique ID.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"updateVariable","weight":309,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":""},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":""}},"required":["key"]}}}}},"delete":{"summary":"Delete variable","operationId":"functionsDeleteVariable","tags":["functions"],"description":"Delete a variable by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":310,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/health":{"get":{"summary":"Get HTTP","operationId":"healthGet","tags":["health"],"description":"Check the Appwrite HTTP server is up and responsive.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"get","weight":124,"cookies":false,"type":"","deprecated":false,"demo":"health\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/anti-virus":{"get":{"summary":"Get antivirus","operationId":"healthGetAntivirus","tags":["health"],"description":"Check the Appwrite Antivirus server is up and connection is successful.","responses":{"200":{"description":"Health Antivirus","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthAntivirus"}}}}},"x-appwrite":{"method":"getAntivirus","weight":146,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-antivirus.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/cache":{"get":{"summary":"Get cache","operationId":"healthGetCache","tags":["health"],"description":"Check the Appwrite in-memory cache servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getCache","weight":127,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-cache.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/certificate":{"get":{"summary":"Get the SSL certificate for a domain","operationId":"healthGetCertificate","tags":["health"],"description":"Get the SSL certificate for a domain","responses":{"200":{"description":"Health Certificate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthCertificate"}}}}},"x-appwrite":{"method":"getCertificate","weight":133,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-certificate.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"domain","description":"string","required":false,"schema":{"type":"string"},"in":"query"}]}},"\/health\/db":{"get":{"summary":"Get DB","operationId":"healthGetDB","tags":["health"],"description":"Check the Appwrite database servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getDB","weight":126,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-d-b.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/pubsub":{"get":{"summary":"Get pubsub","operationId":"healthGetPubSub","tags":["health"],"description":"Check the Appwrite pub-sub servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getPubSub","weight":129,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-pub-sub.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue":{"get":{"summary":"Get queue","operationId":"healthGetQueue","tags":["health"],"description":"Check the Appwrite queue messaging servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getQueue","weight":128,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue\/builds":{"get":{"summary":"Get builds queue","operationId":"healthGetQueueBuilds","tags":["health"],"description":"Get the number of builds that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueBuilds","weight":135,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-builds.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/certificates":{"get":{"summary":"Get certificates queue","operationId":"healthGetQueueCertificates","tags":["health"],"description":"Get the number of certificates that are waiting to be issued against [Letsencrypt](https:\/\/letsencrypt.org\/) in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueCertificates","weight":134,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-certificates.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/databases":{"get":{"summary":"Get databases queue","operationId":"healthGetQueueDatabases","tags":["health"],"description":"Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueDatabases","weight":136,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-databases.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"Queue name for which to check the queue size","required":false,"schema":{"type":"string","x-example":"","default":"database_db_main"},"in":"query"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/deletes":{"get":{"summary":"Get deletes queue","operationId":"healthGetQueueDeletes","tags":["health"],"description":"Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueDeletes","weight":137,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-deletes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/failed\/{name}":{"get":{"summary":"Get number of failed queue jobs","operationId":"healthGetFailedJobs","tags":["health"],"description":"Returns the amount of failed jobs in a given queue.\n","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getFailedJobs","weight":147,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-failed-jobs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"The name of the queue","required":true,"schema":{"type":"string","x-example":"v1-database","enum":["v1-database","v1-deletes","v1-audits","v1-mails","v1-functions","v1-usage","v1-usage-dump","v1-webhooks","v1-certificates","v1-builds","v1-messaging","v1-migrations"],"x-enum-name":null,"x-enum-keys":[]},"in":"path"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/functions":{"get":{"summary":"Get functions queue","operationId":"healthGetQueueFunctions","tags":["health"],"description":"Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueFunctions","weight":141,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-functions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/logs":{"get":{"summary":"Get logs queue","operationId":"healthGetQueueLogs","tags":["health"],"description":"Get the number of logs that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueLogs","weight":132,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/mails":{"get":{"summary":"Get mails queue","operationId":"healthGetQueueMails","tags":["health"],"description":"Get the number of mails that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMails","weight":138,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-mails.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/messaging":{"get":{"summary":"Get messaging queue","operationId":"healthGetQueueMessaging","tags":["health"],"description":"Get the number of messages that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMessaging","weight":139,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-messaging.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/migrations":{"get":{"summary":"Get migrations queue","operationId":"healthGetQueueMigrations","tags":["health"],"description":"Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMigrations","weight":140,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-migrations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/usage":{"get":{"summary":"Get usage queue","operationId":"healthGetQueueUsage","tags":["health"],"description":"Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueUsage","weight":142,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/usage-dump":{"get":{"summary":"Get usage dump queue","operationId":"healthGetQueueUsageDump","tags":["health"],"description":"Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueUsageDump","weight":143,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage-dump.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage-dump.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/webhooks":{"get":{"summary":"Get webhooks queue","operationId":"healthGetQueueWebhooks","tags":["health"],"description":"Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueWebhooks","weight":131,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/storage":{"get":{"summary":"Get storage","operationId":"healthGetStorage","tags":["health"],"description":"Check the Appwrite storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getStorage","weight":145,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/storage\/local":{"get":{"summary":"Get local storage","operationId":"healthGetStorageLocal","tags":["health"],"description":"Check the Appwrite local storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getStorageLocal","weight":144,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage-local.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/time":{"get":{"summary":"Get time","operationId":"healthGetTime","tags":["health"],"description":"Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https:\/\/en.wikipedia.org\/wiki\/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.","responses":{"200":{"description":"Health Time","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthTime"}}}}},"x-appwrite":{"method":"getTime","weight":130,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-time.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/locale"}}}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/localeCodeList"}}}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/continentList"}}}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/phoneList"}}}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/currencyList"}}}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/languageList"}}}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/messaging\/messages":{"get":{"summary":"List messages","operationId":"messagingListMessages","tags":["messaging"],"description":"Get a list of all messages from the current Appwrite project.","responses":{"200":{"description":"Message list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/messageList"}}}}},"x-appwrite":{"method":"listMessages","weight":385,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-messages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"","default":""},"in":"query"}]}},"\/messaging\/messages\/email":{"post":{"summary":"Create email","operationId":"messagingCreateEmail","tags":["messaging"],"description":"Create a new email message.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createEmail","weight":382,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"subject":{"type":"string","description":"Email Subject.","x-example":""},"content":{"type":"string","description":"Email Content.","x-example":""},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","x-example":null,"items":{"type":"string"}},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as :.","x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","subject","content"]}}}}}},"\/messaging\/messages\/email\/{messageId}":{"patch":{"summary":"Update email","operationId":"messagingUpdateEmail","tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updateEmail","weight":389,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":""},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"subject":{"type":"string","description":"Email Subject.","x-example":""},"content":{"type":"string","description":"Email Content.","x-example":""},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","x-example":false},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","x-example":null,"items":{"type":"string"}},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as :.","x-example":null,"items":{"type":"string"}}}}}}}}},"\/messaging\/messages\/push":{"post":{"summary":"Create push notification","operationId":"messagingCreatePush","tags":["messaging"],"description":"Create a new push notification.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createPush","weight":384,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":""},"title":{"type":"string","description":"Title for push notification.","x-example":""},"body":{"type":"string","description":"Body for push notification.","x-example":"<BODY>"},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"data":{"type":"object","description":"Additional Data for push notification.","x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web Platform.","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and IOS Platform.","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android Platform.","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android Platform.","x-example":"<TAG>"},"badge":{"type":"string","description":"Badge for push notification. Available only for IOS Platform.","x-example":"<BADGE>"},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","title","body"]}}}}}},"\/messaging\/messages\/push\/{messageId}":{"patch":{"summary":"Update push notification","operationId":"messagingUpdatePush","tags":["messaging"],"description":"Update a push notification by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updatePush","weight":391,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"title":{"type":"string","description":"Title for push notification.","x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","x-example":"<BODY>"},"data":{"type":"object","description":"Additional Data for push notification.","x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web platforms.","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and iOS platforms.","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android platforms.","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android platforms.","x-example":"<TAG>"},"badge":{"type":"integer","description":"Badge for push notification. Available only for iOS platforms.","x-example":null},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/messaging\/messages\/sms":{"post":{"summary":"Create SMS","operationId":"messagingCreateSms","tags":["messaging"],"description":"Create a new SMS message.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createSms","weight":383,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<MESSAGE_ID>"},"content":{"type":"string","description":"SMS Content.","x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","content"]}}}}}},"\/messaging\/messages\/sms\/{messageId}":{"patch":{"summary":"Update SMS","operationId":"messagingUpdateSms","tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updateSms","weight":390,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"content":{"type":"string","description":"Email Content.","x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/messaging\/messages\/{messageId}":{"get":{"summary":"Get message","operationId":"messagingGetMessage","tags":["messaging"],"description":"Get a message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"getMessage","weight":388,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-message.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}]},"delete":{"summary":"Delete message","operationId":"messagingDelete","tags":["messaging"],"description":"Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":392,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}]}},"\/messaging\/messages\/{messageId}\/logs":{"get":{"summary":"List message logs","operationId":"messagingListMessageLogs","tags":["messaging"],"description":"Get the message activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listMessageLogs","weight":386,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-message-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/messages\/{messageId}\/targets":{"get":{"summary":"List message targets","operationId":"messagingListTargets","tags":["messaging"],"description":"Get a list of the targets associated with a message.","responses":{"200":{"description":"Target list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/targetList"}}}}},"x-appwrite":{"method":"listTargets","weight":387,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"},{"name":"queries","description":"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, providerId, identifier, providerType","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/providers":{"get":{"summary":"List providers","operationId":"messagingListProviders","tags":["messaging"],"description":"Get a list of all providers from the current Appwrite project.","responses":{"200":{"description":"Provider list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/providerList"}}}}},"x-appwrite":{"method":"listProviders","weight":357,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-providers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, provider, type, enabled","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/messaging\/providers\/apns":{"post":{"summary":"Create APNS provider","operationId":"messagingCreateApnsProvider","tags":["messaging"],"description":"Create a new Apple Push Notification service provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createApnsProvider","weight":356,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"authKey":{"type":"string","description":"APNS authentication key.","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/apns\/{providerId}":{"patch":{"summary":"Update APNS provider","operationId":"messagingUpdateApnsProvider","tags":["messaging"],"description":"Update a Apple Push Notification service provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateApnsProvider","weight":369,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"authKey":{"type":"string","description":"APNS authentication key.","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","x-example":false}}}}}}}},"\/messaging\/providers\/fcm":{"post":{"summary":"Create FCM provider","operationId":"messagingCreateFcmProvider","tags":["messaging"],"description":"Create a new Firebase Cloud Messaging provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createFcmProvider","weight":355,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","x-example":"{}"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/fcm\/{providerId}":{"patch":{"summary":"Update FCM provider","operationId":"messagingUpdateFcmProvider","tags":["messaging"],"description":"Update a Firebase Cloud Messaging provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateFcmProvider","weight":368,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","x-example":"{}"}}}}}}}},"\/messaging\/providers\/mailgun":{"post":{"summary":"Create Mailgun provider","operationId":"messagingCreateMailgunProvider","tags":["messaging"],"description":"Create a new Mailgun provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createMailgunProvider","weight":347,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","x-example":false},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/mailgun\/{providerId}":{"patch":{"summary":"Update Mailgun provider","operationId":"messagingUpdateMailgunProvider","tags":["messaging"],"description":"Update a Mailgun provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateMailgunProvider","weight":360,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"<REPLY_TO_EMAIL>"}}}}}}}},"\/messaging\/providers\/msg91":{"post":{"summary":"Create Msg91 provider","operationId":"messagingCreateMsg91Provider","tags":["messaging"],"description":"Create a new MSG91 provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createMsg91Provider","weight":350,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"templateId":{"type":"string","description":"Msg91 template ID","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","x-example":"<AUTH_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/msg91\/{providerId}":{"patch":{"summary":"Update Msg91 provider","operationId":"messagingUpdateMsg91Provider","tags":["messaging"],"description":"Update a MSG91 provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateMsg91Provider","weight":363,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"templateId":{"type":"string","description":"Msg91 template ID.","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","x-example":"<AUTH_KEY>"}}}}}}}},"\/messaging\/providers\/sendgrid":{"post":{"summary":"Create Sendgrid provider","operationId":"messagingCreateSendgridProvider","tags":["messaging"],"description":"Create a new Sendgrid provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createSendgridProvider","weight":348,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Sendgrid API key.","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/sendgrid\/{providerId}":{"patch":{"summary":"Update Sendgrid provider","operationId":"messagingUpdateSendgridProvider","tags":["messaging"],"description":"Update a Sendgrid provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateSendgridProvider","weight":361,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"apiKey":{"type":"string","description":"Sendgrid API key.","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","x-example":"<REPLY_TO_EMAIL>"}}}}}}}},"\/messaging\/providers\/smtp":{"post":{"summary":"Create SMTP provider","operationId":"messagingCreateSmtpProvider","tags":["messaging"],"description":"Create a new SMTP provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createSmtpProvider","weight":349,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","x-example":"<HOST>"},"port":{"type":"integer","description":"The default SMTP server port.","x-example":1},"username":{"type":"string","description":"Authentication username.","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be omitted, 'ssl', or 'tls'","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name","host"]}}}}}},"\/messaging\/providers\/smtp\/{providerId}":{"patch":{"summary":"Update SMTP provider","operationId":"messagingUpdateSmtpProvider","tags":["messaging"],"description":"Update a SMTP provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateSmtpProvider","weight":362,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","x-example":"<HOST>"},"port":{"type":"integer","description":"SMTP port.","x-example":1},"username":{"type":"string","description":"Authentication username.","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be 'ssl' or 'tls'","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","x-example":"<REPLY_TO_EMAIL>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}}}}}}}},"\/messaging\/providers\/telesign":{"post":{"summary":"Create Telesign provider","operationId":"messagingCreateTelesignProvider","tags":["messaging"],"description":"Create a new Telesign provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTelesignProvider","weight":351,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"customerId":{"type":"string","description":"Telesign customer ID.","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/telesign\/{providerId}":{"patch":{"summary":"Update Telesign provider","operationId":"messagingUpdateTelesignProvider","tags":["messaging"],"description":"Update a Telesign provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTelesignProvider","weight":364,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"customerId":{"type":"string","description":"Telesign customer ID.","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/textmagic":{"post":{"summary":"Create Textmagic provider","operationId":"messagingCreateTextmagicProvider","tags":["messaging"],"description":"Create a new Textmagic provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTextmagicProvider","weight":352,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"username":{"type":"string","description":"Textmagic username.","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/textmagic\/{providerId}":{"patch":{"summary":"Update Textmagic provider","operationId":"messagingUpdateTextmagicProvider","tags":["messaging"],"description":"Update a Textmagic provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTextmagicProvider","weight":365,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"username":{"type":"string","description":"Textmagic username.","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/twilio":{"post":{"summary":"Create Twilio provider","operationId":"messagingCreateTwilioProvider","tags":["messaging"],"description":"Create a new Twilio provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTwilioProvider","weight":353,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"accountSid":{"type":"string","description":"Twilio account secret ID.","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","x-example":"<AUTH_TOKEN>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/twilio\/{providerId}":{"patch":{"summary":"Update Twilio provider","operationId":"messagingUpdateTwilioProvider","tags":["messaging"],"description":"Update a Twilio provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTwilioProvider","weight":366,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"accountSid":{"type":"string","description":"Twilio account secret ID.","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","x-example":"<AUTH_TOKEN>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/vonage":{"post":{"summary":"Create Vonage provider","operationId":"messagingCreateVonageProvider","tags":["messaging"],"description":"Create a new Vonage provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createVonageProvider","weight":354,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"apiKey":{"type":"string","description":"Vonage API key.","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","x-example":"<API_SECRET>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/vonage\/{providerId}":{"patch":{"summary":"Update Vonage provider","operationId":"messagingUpdateVonageProvider","tags":["messaging"],"description":"Update a Vonage provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateVonageProvider","weight":367,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"apiKey":{"type":"string","description":"Vonage API key.","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","x-example":"<API_SECRET>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/{providerId}":{"get":{"summary":"Get provider","operationId":"messagingGetProvider","tags":["messaging"],"description":"Get a provider by its unique ID.\n","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"getProvider","weight":359,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}]},"delete":{"summary":"Delete provider","operationId":"messagingDeleteProvider","tags":["messaging"],"description":"Delete a provider by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteProvider","weight":370,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}]}},"\/messaging\/providers\/{providerId}\/logs":{"get":{"summary":"List provider logs","operationId":"messagingListProviderLogs","tags":["messaging"],"description":"Get the provider activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listProviderLogs","weight":358,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-provider-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/subscribers\/{subscriberId}\/logs":{"get":{"summary":"List subscriber logs","operationId":"messagingListSubscriberLogs","tags":["messaging"],"description":"Get the subscriber activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listSubscriberLogs","weight":379,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscriber-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/topics":{"get":{"summary":"List topics","operationId":"messagingListTopics","tags":["messaging"],"description":"Get a list of all topics from the current Appwrite project.","responses":{"200":{"description":"Topic list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topicList"}}}}},"x-appwrite":{"method":"listTopics","weight":372,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topics.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, description, emailTotal, smsTotal, pushTotal","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create topic","operationId":"messagingCreateTopic","tags":["messaging"],"description":"Create a new topic.","responses":{"201":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"createTopic","weight":371,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topicId":{"type":"string","description":"Topic ID. Choose a custom Topic ID or a new Topic ID.","x-example":"<TOPIC_ID>"},"name":{"type":"string","description":"Topic Name.","x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}}},"required":["topicId","name"]}}}}}},"\/messaging\/topics\/{topicId}":{"get":{"summary":"Get topic","operationId":"messagingGetTopic","tags":["messaging"],"description":"Get a topic by its unique ID.\n","responses":{"200":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"getTopic","weight":374,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}]},"patch":{"summary":"Update topic","operationId":"messagingUpdateTopic","tags":["messaging"],"description":"Update a topic by its unique ID.\n","responses":{"200":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"updateTopic","weight":375,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Topic Name.","x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete topic","operationId":"messagingDeleteTopic","tags":["messaging"],"description":"Delete a topic by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTopic","weight":376,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}]}},"\/messaging\/topics\/{topicId}\/logs":{"get":{"summary":"List topic logs","operationId":"messagingListTopicLogs","tags":["messaging"],"description":"Get the topic activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listTopicLogs","weight":373,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topic-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"get":{"summary":"List subscribers","operationId":"messagingListSubscribers","tags":["messaging"],"description":"Get a list of all subscribers from the current Appwrite project.","responses":{"200":{"description":"Subscriber list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriberList"}}}}},"x-appwrite":{"method":"listSubscribers","weight":378,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscribers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"queries","description":"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: name, provider, type, enabled","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriber"}}}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}}}}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"get":{"summary":"Get subscriber","operationId":"messagingGetSubscriber","tags":["messaging"],"description":"Get a subscriber by its unique ID.\n","responses":{"200":{"description":"Subscriber","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriber"}}}}},"x-appwrite":{"method":"getSubscriber","weight":380,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"}]},"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"}]}},"\/migrations":{"get":{"summary":"List Migrations","operationId":"migrationsList","tags":["migrations"],"description":"","responses":{"200":{"description":"Migrations List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationList"}}}}},"x-appwrite":{"method":"list","weight":334,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/list-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, resources, statusCounters, resourceData, errors","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/migrations\/appwrite":{"post":{"summary":"Migrate Appwrite Data","operationId":"migrationsCreateAppwriteMigration","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"createAppwriteMigration","weight":329,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-appwrite-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","x-example":null,"items":{"type":"string"}},"endpoint":{"type":"string","description":"Source's Appwrite Endpoint","x-example":"https:\/\/example.com"},"projectId":{"type":"string","description":"Source's Project ID","x-example":"<PROJECT_ID>"},"apiKey":{"type":"string","description":"Source's API Key","x-example":"<API_KEY>"}},"required":["resources","endpoint","projectId","apiKey"]}}}}}},"\/migrations\/appwrite\/report":{"get":{"summary":"Generate a report on Appwrite Data","operationId":"migrationsGetAppwriteReport","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationReport"}}}}},"x-appwrite":{"method":"getAppwriteReport","weight":336,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-appwrite-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"schema":{"type":"array","items":{"type":"string"}},"in":"query"},{"name":"endpoint","description":"Source's Appwrite Endpoint","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"},{"name":"projectID","description":"Source's Project ID","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"query"},{"name":"key","description":"Source's API Key","required":true,"schema":{"type":"string","x-example":"<KEY>"},"in":"query"}]}},"\/migrations\/firebase":{"post":{"summary":"Migrate Firebase Data (Service Account)","operationId":"migrationsCreateFirebaseMigration","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"createFirebaseMigration","weight":331,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-firebase-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","x-example":null,"items":{"type":"string"}},"serviceAccount":{"type":"string","description":"JSON of the Firebase service account credentials","x-example":"<SERVICE_ACCOUNT>"}},"required":["resources","serviceAccount"]}}}}}},"\/migrations\/firebase\/deauthorize":{"get":{"summary":"Revoke Appwrite's authorization to access Firebase Projects","operationId":"migrationsDeleteFirebaseAuth","tags":["migrations"],"description":"","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"deleteFirebaseAuth","weight":342,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/delete-firebase-auth.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/migrations\/firebase\/oauth":{"post":{"summary":"Migrate Firebase Data (OAuth)","operationId":"migrationsCreateFirebaseOAuthMigration","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"createFirebaseOAuthMigration","weight":330,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-firebase-o-auth-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","x-example":null,"items":{"type":"string"}},"projectId":{"type":"string","description":"Project ID of the Firebase Project","x-example":"<PROJECT_ID>"}},"required":["resources","projectId"]}}}}}},"\/migrations\/firebase\/projects":{"get":{"summary":"List Firebase Projects","operationId":"migrationsListFirebaseProjects","tags":["migrations"],"description":"","responses":{"200":{"description":"Migrations Firebase Projects List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/firebaseProjectList"}}}}},"x-appwrite":{"method":"listFirebaseProjects","weight":341,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/list-firebase-projects.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/migrations\/firebase\/report":{"get":{"summary":"Generate a report on Firebase Data","operationId":"migrationsGetFirebaseReport","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationReport"}}}}},"x-appwrite":{"method":"getFirebaseReport","weight":337,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-firebase-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"schema":{"type":"array","items":{"type":"string"}},"in":"query"},{"name":"serviceAccount","description":"JSON of the Firebase service account credentials","required":true,"schema":{"type":"string","x-example":"<SERVICE_ACCOUNT>"},"in":"query"}]}},"\/migrations\/firebase\/report\/oauth":{"get":{"summary":"Generate a report on Firebase Data using OAuth","operationId":"migrationsGetFirebaseReportOAuth","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationReport"}}}}},"x-appwrite":{"method":"getFirebaseReportOAuth","weight":338,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-firebase-report-o-auth.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"schema":{"type":"array","items":{"type":"string"}},"in":"query"},{"name":"projectId","description":"Project ID","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"query"}]}},"\/migrations\/nhost":{"post":{"summary":"Migrate NHost Data","operationId":"migrationsCreateNHostMigration","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"createNHostMigration","weight":333,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-n-host-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","x-example":null,"items":{"type":"string"}},"subdomain":{"type":"string","description":"Source's Subdomain","x-example":"<SUBDOMAIN>"},"region":{"type":"string","description":"Source's Region","x-example":"<REGION>"},"adminSecret":{"type":"string","description":"Source's Admin Secret","x-example":"<ADMIN_SECRET>"},"database":{"type":"string","description":"Source's Database Name","x-example":"<DATABASE>"},"username":{"type":"string","description":"Source's Database Username","x-example":"<USERNAME>"},"password":{"type":"string","description":"Source's Database Password","x-example":"<PASSWORD>"},"port":{"type":"integer","description":"Source's Database Port","x-example":null}},"required":["resources","subdomain","region","adminSecret","database","username","password"]}}}}}},"\/migrations\/nhost\/report":{"get":{"summary":"Generate a report on NHost Data","operationId":"migrationsGetNHostReport","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationReport"}}}}},"x-appwrite":{"method":"getNHostReport","weight":344,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-n-host-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate.","required":true,"schema":{"type":"array","items":{"type":"string"}},"in":"query"},{"name":"subdomain","description":"Source's Subdomain.","required":true,"schema":{"type":"string","x-example":"<SUBDOMAIN>"},"in":"query"},{"name":"region","description":"Source's Region.","required":true,"schema":{"type":"string","x-example":"<REGION>"},"in":"query"},{"name":"adminSecret","description":"Source's Admin Secret.","required":true,"schema":{"type":"string","x-example":"<ADMIN_SECRET>"},"in":"query"},{"name":"database","description":"Source's Database Name.","required":true,"schema":{"type":"string","x-example":"<DATABASE>"},"in":"query"},{"name":"username","description":"Source's Database Username.","required":true,"schema":{"type":"string","x-example":"<USERNAME>"},"in":"query"},{"name":"password","description":"Source's Database Password.","required":true,"schema":{"type":"string","x-example":"<PASSWORD>"},"in":"query"},{"name":"port","description":"Source's Database Port.","required":false,"schema":{"type":"integer","format":"int32","default":5432},"in":"query"}]}},"\/migrations\/supabase":{"post":{"summary":"Migrate Supabase Data","operationId":"migrationsCreateSupabaseMigration","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"createSupabaseMigration","weight":332,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-supabase-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","x-example":null,"items":{"type":"string"}},"endpoint":{"type":"string","description":"Source's Supabase Endpoint","x-example":"https:\/\/example.com"},"apiKey":{"type":"string","description":"Source's API Key","x-example":"<API_KEY>"},"databaseHost":{"type":"string","description":"Source's Database Host","x-example":"<DATABASE_HOST>"},"username":{"type":"string","description":"Source's Database Username","x-example":"<USERNAME>"},"password":{"type":"string","description":"Source's Database Password","x-example":"<PASSWORD>"},"port":{"type":"integer","description":"Source's Database Port","x-example":null}},"required":["resources","endpoint","apiKey","databaseHost","username","password"]}}}}}},"\/migrations\/supabase\/report":{"get":{"summary":"Generate a report on Supabase Data","operationId":"migrationsGetSupabaseReport","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationReport"}}}}},"x-appwrite":{"method":"getSupabaseReport","weight":343,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-supabase-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"schema":{"type":"array","items":{"type":"string"}},"in":"query"},{"name":"endpoint","description":"Source's Supabase Endpoint.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"},{"name":"apiKey","description":"Source's API Key.","required":true,"schema":{"type":"string","x-example":"<API_KEY>"},"in":"query"},{"name":"databaseHost","description":"Source's Database Host.","required":true,"schema":{"type":"string","x-example":"<DATABASE_HOST>"},"in":"query"},{"name":"username","description":"Source's Database Username.","required":true,"schema":{"type":"string","x-example":"<USERNAME>"},"in":"query"},{"name":"password","description":"Source's Database Password.","required":true,"schema":{"type":"string","x-example":"<PASSWORD>"},"in":"query"},{"name":"port","description":"Source's Database Port.","required":false,"schema":{"type":"integer","format":"int32","default":5432},"in":"query"}]}},"\/migrations\/{migrationId}":{"get":{"summary":"Get Migration","operationId":"migrationsGet","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"get","weight":335,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/get-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration unique ID.","required":true,"schema":{"type":"string","x-example":"<MIGRATION_ID>"},"in":"path"}]},"patch":{"summary":"Retry Migration","operationId":"migrationsRetry","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"retry","weight":345,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/retry.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/retry-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration unique ID.","required":true,"schema":{"type":"string","x-example":"<MIGRATION_ID>"},"in":"path"}]},"delete":{"summary":"Delete Migration","operationId":"migrationsDelete","tags":["migrations"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":346,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/delete-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration ID.","required":true,"schema":{"type":"string","x-example":"<MIGRATION_ID>"},"in":"path"}]}},"\/project\/usage":{"get":{"summary":"Get project usage stats","operationId":"projectGetUsage","tags":["project"],"description":"","responses":{"200":{"description":"UsageProject","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageProject"}}}}},"x-appwrite":{"method":"getUsage","weight":194,"cookies":false,"type":"","deprecated":false,"demo":"project\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"startDate","description":"Starting date for the usage","required":true,"schema":{"type":"string"},"in":"query"},{"name":"endDate","description":"End date for the usage","required":true,"schema":{"type":"string"},"in":"query"},{"name":"period","description":"Period used","required":false,"schema":{"type":"string","x-example":"1h","enum":["1h","1d"],"x-enum-name":"ProjectUsageRange","x-enum-keys":["One Hour","One Day"],"default":"1d"},"in":"query"}]}},"\/project\/variables":{"get":{"summary":"List Variables","operationId":"projectListVariables","tags":["project"],"description":"Get a list of all project variables. These variables will be accessible in all Appwrite Functions at runtime.","responses":{"200":{"description":"Variables List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variableList"}}}}},"x-appwrite":{"method":"listVariables","weight":196,"cookies":false,"type":"","deprecated":false,"demo":"project\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]},"post":{"summary":"Create Variable","operationId":"projectCreateVariable","tags":["project"],"description":"Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.","responses":{"201":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"createVariable","weight":195,"cookies":false,"type":"","deprecated":false,"demo":"project\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":"<VALUE>"}},"required":["key","value"]}}}}}},"\/project\/variables\/{variableId}":{"get":{"summary":"Get Variable","operationId":"projectGetVariable","tags":["project"],"description":"Get a project variable by its unique ID.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"getVariable","weight":197,"cookies":false,"type":"","deprecated":false,"demo":"project\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}]},"put":{"summary":"Update Variable","operationId":"projectUpdateVariable","tags":["project"],"description":"Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"updateVariable","weight":198,"cookies":false,"type":"","deprecated":false,"demo":"project\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":"<VALUE>"}},"required":["key"]}}}}},"delete":{"summary":"Delete Variable","operationId":"projectDeleteVariable","tags":["project"],"description":"Delete a project variable by its unique ID. ","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":199,"cookies":false,"type":"","deprecated":false,"demo":"project\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}]}},"\/projects":{"get":{"summary":"List projects","operationId":"projectsList","tags":["projects"],"description":"","responses":{"200":{"description":"Projects List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/projectList"}}}}},"x-appwrite":{"method":"list","weight":150,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"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: name, teamId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create project","operationId":"projectsCreate","tags":["projects"],"description":"","responses":{"201":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"create","weight":149,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.","x-example":null},"name":{"type":"string","description":"Project name. Max length: 128 chars.","x-example":"<NAME>"},"teamId":{"type":"string","description":"Team unique ID.","x-example":"<TEAM_ID>"},"region":{"type":"string","description":"Project Region.","x-example":"default","enum":["default","fra"],"x-enum-name":null,"x-enum-keys":[]},"description":{"type":"string","description":"Project description. Max length: 256 chars.","x-example":"<DESCRIPTION>"},"logo":{"type":"string","description":"Project logo.","x-example":"<LOGO>"},"url":{"type":"string","description":"Project URL.","x-example":"https:\/\/example.com"},"legalName":{"type":"string","description":"Project legal Name. Max length: 256 chars.","x-example":"<LEGAL_NAME>"},"legalCountry":{"type":"string","description":"Project legal Country. Max length: 256 chars.","x-example":"<LEGAL_COUNTRY>"},"legalState":{"type":"string","description":"Project legal State. Max length: 256 chars.","x-example":"<LEGAL_STATE>"},"legalCity":{"type":"string","description":"Project legal City. Max length: 256 chars.","x-example":"<LEGAL_CITY>"},"legalAddress":{"type":"string","description":"Project legal Address. Max length: 256 chars.","x-example":"<LEGAL_ADDRESS>"},"legalTaxId":{"type":"string","description":"Project legal Tax ID. Max length: 256 chars.","x-example":"<LEGAL_TAX_ID>"}},"required":["projectId","name","teamId"]}}}}}},"\/projects\/{projectId}":{"get":{"summary":"Get project","operationId":"projectsGet","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"get","weight":151,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}]},"patch":{"summary":"Update project","operationId":"projectsUpdate","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"update","weight":152,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Project name. Max length: 128 chars.","x-example":"<NAME>"},"description":{"type":"string","description":"Project description. Max length: 256 chars.","x-example":"<DESCRIPTION>"},"logo":{"type":"string","description":"Project logo.","x-example":"<LOGO>"},"url":{"type":"string","description":"Project URL.","x-example":"https:\/\/example.com"},"legalName":{"type":"string","description":"Project legal name. Max length: 256 chars.","x-example":"<LEGAL_NAME>"},"legalCountry":{"type":"string","description":"Project legal country. Max length: 256 chars.","x-example":"<LEGAL_COUNTRY>"},"legalState":{"type":"string","description":"Project legal state. Max length: 256 chars.","x-example":"<LEGAL_STATE>"},"legalCity":{"type":"string","description":"Project legal city. Max length: 256 chars.","x-example":"<LEGAL_CITY>"},"legalAddress":{"type":"string","description":"Project legal address. Max length: 256 chars.","x-example":"<LEGAL_ADDRESS>"},"legalTaxId":{"type":"string","description":"Project legal tax ID. Max length: 256 chars.","x-example":"<LEGAL_TAX_ID>"}},"required":["name"]}}}}},"delete":{"summary":"Delete project","operationId":"projectsDelete","tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":168,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}]}},"\/projects\/{projectId}\/api":{"patch":{"summary":"Update API status","operationId":"projectsUpdateApiStatus","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateApiStatus","weight":156,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-api-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"api":{"type":"string","description":"API name.","x-example":"rest","enum":["rest","graphql","realtime"],"x-enum-name":null,"x-enum-keys":[]},"status":{"type":"boolean","description":"API status.","x-example":false}},"required":["api","status"]}}}}}},"\/projects\/{projectId}\/api\/all":{"patch":{"summary":"Update all API status","operationId":"projectsUpdateApiStatusAll","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateApiStatusAll","weight":157,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-api-status-all.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"API status.","x-example":false}},"required":["status"]}}}}}},"\/projects\/{projectId}\/auth\/duration":{"patch":{"summary":"Update project authentication duration","operationId":"projectsUpdateAuthDuration","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthDuration","weight":161,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-duration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"duration":{"type":"integer","description":"Project session length in seconds. Max length: 31536000 seconds.","x-example":0}},"required":["duration"]}}}}}},"\/projects\/{projectId}\/auth\/limit":{"patch":{"summary":"Update project users limit","operationId":"projectsUpdateAuthLimit","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthLimit","weight":160,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-limit.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of users allowed in this project. Use 0 for unlimited.","x-example":0}},"required":["limit"]}}}}}},"\/projects\/{projectId}\/auth\/max-sessions":{"patch":{"summary":"Update project user sessions limit","operationId":"projectsUpdateAuthSessionsLimit","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthSessionsLimit","weight":166,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-sessions-limit.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10","x-example":1}},"required":["limit"]}}}}}},"\/projects\/{projectId}\/auth\/mock-numbers":{"patch":{"summary":"Update the mock numbers for the project","operationId":"projectsUpdateMockNumbers","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateMockNumbers","weight":167,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-mock-numbers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","description":"An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.","x-example":null,"items":{"type":"object"}}},"required":["numbers"]}}}}}},"\/projects\/{projectId}\/auth\/password-dictionary":{"patch":{"summary":"Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password","operationId":"projectsUpdateAuthPasswordDictionary","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthPasswordDictionary","weight":164,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-password-dictionary.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Set whether or not to enable checking user's password against most commonly used passwords. Default is false.","x-example":false}},"required":["enabled"]}}}}}},"\/projects\/{projectId}\/auth\/password-history":{"patch":{"summary":"Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.","operationId":"projectsUpdateAuthPasswordHistory","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthPasswordHistory","weight":163,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-password-history.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0","x-example":0}},"required":["limit"]}}}}}},"\/projects\/{projectId}\/auth\/personal-data":{"patch":{"summary":"Enable or disable checking user passwords for similarity with their personal data.","operationId":"projectsUpdatePersonalDataCheck","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updatePersonalDataCheck","weight":165,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-personal-data-check.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Set whether or not to check a password for similarity with personal data. Default is false.","x-example":false}},"required":["enabled"]}}}}}},"\/projects\/{projectId}\/auth\/session-alerts":{"patch":{"summary":"Update project sessions emails","operationId":"projectsUpdateSessionAlerts","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateSessionAlerts","weight":159,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-session-alerts.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"alerts":{"type":"boolean","description":"Set to true to enable session emails.","x-example":false}},"required":["alerts"]}}}}}},"\/projects\/{projectId}\/auth\/{method}":{"patch":{"summary":"Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.","operationId":"projectsUpdateAuthStatus","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthStatus","weight":162,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"method","description":"Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone","required":true,"schema":{"type":"string","x-example":"email-password","enum":["email-password","magic-url","email-otp","anonymous","invites","jwt","phone"],"x-enum-name":"AuthMethod","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"Set the status of this auth method.","x-example":false}},"required":["status"]}}}}}},"\/projects\/{projectId}\/jwts":{"post":{"summary":"Create JWT","operationId":"projectsCreateJWT","tags":["projects"],"description":"","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":180,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"scopes":{"type":"array","description":"List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","x-example":0}},"required":["scopes"]}}}}}},"\/projects\/{projectId}\/keys":{"get":{"summary":"List keys","operationId":"projectsListKeys","tags":["projects"],"description":"","responses":{"200":{"description":"API Keys List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/keyList"}}}}},"x-appwrite":{"method":"listKeys","weight":176,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-keys.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}]},"post":{"summary":"Create key","operationId":"projectsCreateKey","tags":["projects"],"description":"","responses":{"201":{"description":"Key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/key"}}}}},"x-appwrite":{"method":"createKey","weight":175,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Key name. Max length: 128 chars.","x-example":"<NAME>"},"scopes":{"type":"array","description":"Key scopes list. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"expire":{"type":"string","description":"Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.","x-example":null}},"required":["name","scopes"]}}}}}},"\/projects\/{projectId}\/keys\/{keyId}":{"get":{"summary":"Get key","operationId":"projectsGetKey","tags":["projects"],"description":"","responses":{"200":{"description":"Key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/key"}}}}},"x-appwrite":{"method":"getKey","weight":177,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"schema":{"type":"string","x-example":"<KEY_ID>"},"in":"path"}]},"put":{"summary":"Update key","operationId":"projectsUpdateKey","tags":["projects"],"description":"","responses":{"200":{"description":"Key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/key"}}}}},"x-appwrite":{"method":"updateKey","weight":178,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"schema":{"type":"string","x-example":"<KEY_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Key name. Max length: 128 chars.","x-example":"<NAME>"},"scopes":{"type":"array","description":"Key scopes list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"expire":{"type":"string","description":"Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.","x-example":null}},"required":["name","scopes"]}}}}},"delete":{"summary":"Delete key","operationId":"projectsDeleteKey","tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteKey","weight":179,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"schema":{"type":"string","x-example":"<KEY_ID>"},"in":"path"}]}},"\/projects\/{projectId}\/oauth2":{"patch":{"summary":"Update project OAuth2","operationId":"projectsUpdateOAuth2","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateOAuth2","weight":158,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-o-auth2.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","description":"Provider Name","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"appId":{"type":"string","description":"Provider app ID. Max length: 256 chars.","x-example":"<APP_ID>"},"secret":{"type":"string","description":"Provider secret key. Max length: 512 chars.","x-example":"<SECRET>"},"enabled":{"type":"boolean","description":"Provider status. Set to 'false' to disable new session creation.","x-example":false}},"required":["provider"]}}}}}},"\/projects\/{projectId}\/platforms":{"get":{"summary":"List platforms","operationId":"projectsListPlatforms","tags":["projects"],"description":"","responses":{"200":{"description":"Platforms List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/platformList"}}}}},"x-appwrite":{"method":"listPlatforms","weight":182,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-platforms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}]},"post":{"summary":"Create platform","operationId":"projectsCreatePlatform","tags":["projects"],"description":"","responses":{"201":{"description":"Platform","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/platform"}}}}},"x-appwrite":{"method":"createPlatform","weight":181,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Platform type.","x-example":"web","enum":["web","flutter-web","flutter-ios","flutter-android","flutter-linux","flutter-macos","flutter-windows","apple-ios","apple-macos","apple-watchos","apple-tvos","android","unity"],"x-enum-name":"PlatformType","x-enum-keys":[]},"name":{"type":"string","description":"Platform name. Max length: 128 chars.","x-example":"<NAME>"},"key":{"type":"string","description":"Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.","x-example":"<KEY>"},"store":{"type":"string","description":"App store or Google Play store ID. Max length: 256 chars.","x-example":"<STORE>"},"hostname":{"type":"string","description":"Platform client hostname. Max length: 256 chars.","x-example":null}},"required":["type","name"]}}}}}},"\/projects\/{projectId}\/platforms\/{platformId}":{"get":{"summary":"Get platform","operationId":"projectsGetPlatform","tags":["projects"],"description":"","responses":{"200":{"description":"Platform","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/platform"}}}}},"x-appwrite":{"method":"getPlatform","weight":183,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"schema":{"type":"string","x-example":"<PLATFORM_ID>"},"in":"path"}]},"put":{"summary":"Update platform","operationId":"projectsUpdatePlatform","tags":["projects"],"description":"","responses":{"200":{"description":"Platform","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/platform"}}}}},"x-appwrite":{"method":"updatePlatform","weight":184,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"schema":{"type":"string","x-example":"<PLATFORM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Platform name. Max length: 128 chars.","x-example":"<NAME>"},"key":{"type":"string","description":"Package name for android or bundle ID for iOS. Max length: 256 chars.","x-example":"<KEY>"},"store":{"type":"string","description":"App store or Google Play store ID. Max length: 256 chars.","x-example":"<STORE>"},"hostname":{"type":"string","description":"Platform client URL. Max length: 256 chars.","x-example":null}},"required":["name"]}}}}},"delete":{"summary":"Delete platform","operationId":"projectsDeletePlatform","tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deletePlatform","weight":185,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"schema":{"type":"string","x-example":"<PLATFORM_ID>"},"in":"path"}]}},"\/projects\/{projectId}\/service":{"patch":{"summary":"Update service status","operationId":"projectsUpdateServiceStatus","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateServiceStatus","weight":154,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-service-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"service":{"type":"string","description":"Service name.","x-example":"account","enum":["account","avatars","databases","locale","health","storage","teams","users","functions","graphql","messaging"],"x-enum-name":"ApiService","x-enum-keys":[]},"status":{"type":"boolean","description":"Service status.","x-example":false}},"required":["service","status"]}}}}}},"\/projects\/{projectId}\/service\/all":{"patch":{"summary":"Update all service status","operationId":"projectsUpdateServiceStatusAll","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateServiceStatusAll","weight":155,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-service-status-all.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"Service status.","x-example":false}},"required":["status"]}}}}}},"\/projects\/{projectId}\/smtp":{"patch":{"summary":"Update SMTP","operationId":"projectsUpdateSmtp","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateSmtp","weight":186,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-smtp.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable custom SMTP service","x-example":false},"senderName":{"type":"string","description":"Name of the email sender","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","x-example":"email@example.com"},"host":{"type":"string","description":"SMTP server host name","x-example":null},"port":{"type":"integer","description":"SMTP server port","x-example":null},"username":{"type":"string","description":"SMTP server username","x-example":"<USERNAME>"},"password":{"type":"string","description":"SMTP server password","x-example":"<PASSWORD>"},"secure":{"type":"string","description":"Does SMTP server use secure connection","x-example":"tls","enum":["tls","ssl"],"x-enum-name":"SMTPSecure","x-enum-keys":[]}},"required":["enabled"]}}}}}},"\/projects\/{projectId}\/smtp\/tests":{"post":{"summary":"Create SMTP test","operationId":"projectsCreateSmtpTest","tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createSmtpTest","weight":187,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-smtp-test.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"emails":{"type":"array","description":"Array of emails to send test email to. Maximum of 10 emails are allowed.","x-example":null,"items":{"type":"string"}},"senderName":{"type":"string","description":"Name of the email sender","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","x-example":"email@example.com"},"host":{"type":"string","description":"SMTP server host name","x-example":null},"port":{"type":"integer","description":"SMTP server port","x-example":null},"username":{"type":"string","description":"SMTP server username","x-example":"<USERNAME>"},"password":{"type":"string","description":"SMTP server password","x-example":"<PASSWORD>"},"secure":{"type":"string","description":"Does SMTP server use secure connection","x-example":"tls","enum":["tls"],"x-enum-name":"SMTPSecure","x-enum-keys":[]}},"required":["emails","senderName","senderEmail","host"]}}}}}},"\/projects\/{projectId}\/team":{"patch":{"summary":"Update project team","operationId":"projectsUpdateTeam","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateTeam","weight":153,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-team.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID of the team to transfer project to.","x-example":"<TEAM_ID>"}},"required":["teamId"]}}}}}},"\/projects\/{projectId}\/templates\/email\/{type}\/{locale}":{"get":{"summary":"Get custom email template","operationId":"projectsGetEmailTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"EmailTemplate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/emailTemplate"}}}}},"x-appwrite":{"method":"getEmailTemplate","weight":189,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[]},"in":"path"}]},"patch":{"summary":"Update custom email templates","operationId":"projectsUpdateEmailTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateEmailTemplate","weight":191,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"subject":{"type":"string","description":"Email Subject","x-example":"<SUBJECT>"},"message":{"type":"string","description":"Template message","x-example":"<MESSAGE>"},"senderName":{"type":"string","description":"Name of the email sender","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","x-example":"email@example.com"}},"required":["subject","message"]}}}}},"delete":{"summary":"Reset custom email template","operationId":"projectsDeleteEmailTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"EmailTemplate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/emailTemplate"}}}}},"x-appwrite":{"method":"deleteEmailTemplate","weight":193,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[]},"in":"path"}]}},"\/projects\/{projectId}\/templates\/sms\/{type}\/{locale}":{"get":{"summary":"Get custom SMS template","operationId":"projectsGetSmsTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/smsTemplate"}}}}},"x-appwrite":{"method":"getSmsTemplate","weight":188,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[]},"in":"path"}]},"patch":{"summary":"Update custom SMS template","operationId":"projectsUpdateSmsTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/smsTemplate"}}}}},"x-appwrite":{"method":"updateSmsTemplate","weight":190,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Template message","x-example":"<MESSAGE>"}},"required":["message"]}}}}},"delete":{"summary":"Reset custom SMS template","operationId":"projectsDeleteSmsTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/smsTemplate"}}}}},"x-appwrite":{"method":"deleteSmsTemplate","weight":192,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[]},"in":"path"}]}},"\/projects\/{projectId}\/webhooks":{"get":{"summary":"List webhooks","operationId":"projectsListWebhooks","tags":["projects"],"description":"","responses":{"200":{"description":"Webhooks List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/webhookList"}}}}},"x-appwrite":{"method":"listWebhooks","weight":170,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}]},"post":{"summary":"Create webhook","operationId":"projectsCreateWebhook","tags":["projects"],"description":"","responses":{"201":{"description":"Webhook","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/webhook"}}}}},"x-appwrite":{"method":"createWebhook","weight":169,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Webhook name. Max length: 128 chars.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Enable or disable a webhook.","x-example":false},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"Webhook URL.","x-example":null},"security":{"type":"boolean","description":"Certificate verification, false for disabled or true for enabled.","x-example":false},"httpUser":{"type":"string","description":"Webhook HTTP user. Max length: 256 chars.","x-example":"<HTTP_USER>"},"httpPass":{"type":"string","description":"Webhook HTTP password. Max length: 256 chars.","x-example":"<HTTP_PASS>"}},"required":["name","events","url","security"]}}}}}},"\/projects\/{projectId}\/webhooks\/{webhookId}":{"get":{"summary":"Get webhook","operationId":"projectsGetWebhook","tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/webhook"}}}}},"x-appwrite":{"method":"getWebhook","weight":171,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"schema":{"type":"string","x-example":"<WEBHOOK_ID>"},"in":"path"}]},"put":{"summary":"Update webhook","operationId":"projectsUpdateWebhook","tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/webhook"}}}}},"x-appwrite":{"method":"updateWebhook","weight":172,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"schema":{"type":"string","x-example":"<WEBHOOK_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Webhook name. Max length: 128 chars.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Enable or disable a webhook.","x-example":false},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"Webhook URL.","x-example":null},"security":{"type":"boolean","description":"Certificate verification, false for disabled or true for enabled.","x-example":false},"httpUser":{"type":"string","description":"Webhook HTTP user. Max length: 256 chars.","x-example":"<HTTP_USER>"},"httpPass":{"type":"string","description":"Webhook HTTP password. Max length: 256 chars.","x-example":"<HTTP_PASS>"}},"required":["name","events","url","security"]}}}}},"delete":{"summary":"Delete webhook","operationId":"projectsDeleteWebhook","tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteWebhook","weight":174,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"schema":{"type":"string","x-example":"<WEBHOOK_ID>"},"in":"path"}]}},"\/projects\/{projectId}\/webhooks\/{webhookId}\/signature":{"patch":{"summary":"Update webhook signature key","operationId":"projectsUpdateWebhookSignature","tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/webhook"}}}}},"x-appwrite":{"method":"updateWebhookSignature","weight":173,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-webhook-signature.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"schema":{"type":"string","x-example":"<WEBHOOK_ID>"},"in":"path"}]}},"\/proxy\/rules":{"get":{"summary":"List Rules","operationId":"proxyListRules","tags":["proxy"],"description":"Get a list of all the proxy rules. You can use the query params to filter your results.","responses":{"200":{"description":"Rule List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/proxyRuleList"}}}}},"x-appwrite":{"method":"listRules","weight":312,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/list-rules.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/list-rules.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, resourceType, resourceId, url","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create Rule","operationId":"proxyCreateRule","tags":["proxy"],"description":"Create a new proxy rule.","responses":{"201":{"description":"Rule","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/proxyRule"}}}}},"x-appwrite":{"method":"createRule","weight":311,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/create-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/create-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"Domain name.","x-example":null},"resourceType":{"type":"string","description":"Action definition for the rule. Possible values are \"api\", \"function\"","x-example":"api","enum":["api","function"],"x-enum-name":null,"x-enum-keys":[]},"resourceId":{"type":"string","description":"ID of resource for the action type. If resourceType is \"api\", leave empty. If resourceType is \"function\", provide ID of the function.","x-example":"<RESOURCE_ID>"}},"required":["domain","resourceType"]}}}}}},"\/proxy\/rules\/{ruleId}":{"get":{"summary":"Get Rule","operationId":"proxyGetRule","tags":["proxy"],"description":"Get a proxy rule by its unique ID.","responses":{"200":{"description":"Rule","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/proxyRule"}}}}},"x-appwrite":{"method":"getRule","weight":313,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/get-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/get-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"schema":{"type":"string","x-example":"<RULE_ID>"},"in":"path"}]},"delete":{"summary":"Delete Rule","operationId":"proxyDeleteRule","tags":["proxy"],"description":"Delete a proxy rule by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteRule","weight":314,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/delete-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/delete-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"schema":{"type":"string","x-example":"<RULE_ID>"},"in":"path"}]}},"\/proxy\/rules\/{ruleId}\/verification":{"patch":{"summary":"Update Rule Verification Status","operationId":"proxyUpdateRuleVerification","tags":["proxy"],"description":"","responses":{"200":{"description":"Rule","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/proxyRule"}}}}},"x-appwrite":{"method":"updateRuleVerification","weight":315,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/update-rule-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"schema":{"type":"string","x-example":"<RULE_ID>"},"in":"path"}]}},"\/storage\/buckets":{"get":{"summary":"List buckets","operationId":"storageListBuckets","tags":["storage"],"description":"Get a list of all the storage buckets. You can use the query params to filter your results.","responses":{"200":{"description":"Buckets List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucketList"}}}}},"x-appwrite":{"method":"listBuckets","weight":201,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-buckets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create bucket","operationId":"storageCreateBucket","tags":["storage"],"description":"Create a new storage bucket.","responses":{"201":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"createBucket","weight":200,"cookies":false,"type":"","deprecated":false,"demo":"storage\/create-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"bucketId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<BUCKET_ID>"},"name":{"type":"string","description":"Bucket name","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","x-example":false}},"required":["bucketId","name"]}}}}}},"\/storage\/buckets\/{bucketId}":{"get":{"summary":"Get bucket","operationId":"storageGetBucket","tags":["storage"],"description":"Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.","responses":{"200":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"getBucket","weight":202,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}]},"put":{"summary":"Update bucket","operationId":"storageUpdateBucket","tags":["storage"],"description":"Update a storage bucket by its unique ID.","responses":{"200":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"updateBucket","weight":203,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Bucket name","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete bucket","operationId":"storageDeleteBucket","tags":["storage"],"description":"Delete a storage bucket by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteBucket","weight":204,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/fileList"}}}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"fileId":{"type":"string","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<FILE_ID>","x-upload-id":true},"file":{"type":"string","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","x-example":null},"permissions":{"type":"array","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["fileId","file"]}}}}}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"schema":{"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center"},"in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"schema":{"type":"number","format":"float","x-example":0,"default":1},"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"schema":{"type":"integer","format":"int32","x-example":-360,"default":0},"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"schema":{"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":""},"in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/storage\/usage":{"get":{"summary":"Get storage usage stats","operationId":"storageGetUsage","tags":["storage"],"description":"","responses":{"200":{"description":"StorageUsage","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageStorage"}}}}},"x-appwrite":{"method":"getUsage","weight":214,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"StorageUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/storage\/{bucketId}\/usage":{"get":{"summary":"Get bucket usage stats","operationId":"storageGetBucketUsage","tags":["storage"],"description":"","responses":{"200":{"description":"UsageBuckets","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageBuckets"}}}}},"x-appwrite":{"method":"getBucketUsage","weight":215,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"bucketId","description":"Bucket ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"StorageUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/teamList"}}}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}}}}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["name"]}}}}},"delete":{"summary":"Delete team","operationId":"teamsDelete","tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]}},"\/teams\/{teamId}\/logs":{"get":{"summary":"List team logs","operationId":"teamsListLogs","tags":["teams"],"description":"Get the team activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":229,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membershipList"}}}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","x-example":"<NAME>"}},"required":["roles"]}}}}}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["roles"]}}}}},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/users":{"get":{"summary":"List users","operationId":"usersList","tags":["users"],"description":"Get a list of all the project's users. You can use the query params to filter your results.","responses":{"200":{"description":"Users List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/userList"}}}}},"x-appwrite":{"method":"list","weight":239,"cookies":false,"type":"","deprecated":false,"demo":"users\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create user","operationId":"usersCreate","tags":["users"],"description":"Create a new user.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"create","weight":230,"cookies":false,"type":"","deprecated":false,"demo":"users\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"password":{"type":"string","description":"Plain text user password. Must be at least 8 chars.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId"]}}}}}},"\/users\/argon2":{"post":{"summary":"Create user with Argon2 password","operationId":"usersCreateArgon2User","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createArgon2User","weight":233,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-argon2user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Argon2.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/bcrypt":{"post":{"summary":"Create user with bcrypt password","operationId":"usersCreateBcryptUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createBcryptUser","weight":231,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-bcrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Bcrypt.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/identities":{"get":{"summary":"List Identities","operationId":"usersListIdentities","tags":["users"],"description":"Get identities for all users.","responses":{"200":{"description":"Identities List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/identityList"}}}}},"x-appwrite":{"method":"listIdentities","weight":247,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/users\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"usersDeleteIdentity","tags":["users"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":270,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"schema":{"type":"string","x-example":"<IDENTITY_ID>"},"in":"path"}]}},"\/users\/md5":{"post":{"summary":"Create user with MD5 password","operationId":"usersCreateMD5User","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createMD5User","weight":232,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-m-d5user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using MD5.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/phpass":{"post":{"summary":"Create user with PHPass password","operationId":"usersCreatePHPassUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createPHPassUser","weight":235,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-p-h-pass-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using PHPass.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/scrypt":{"post":{"summary":"Create user with Scrypt password","operationId":"usersCreateScryptUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createScryptUser","weight":236,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt.","x-example":"password"},"passwordSalt":{"type":"string","description":"Optional salt used to hash password.","x-example":"<PASSWORD_SALT>"},"passwordCpu":{"type":"integer","description":"Optional CPU cost used to hash password.","x-example":null},"passwordMemory":{"type":"integer","description":"Optional memory cost used to hash password.","x-example":null},"passwordParallel":{"type":"integer","description":"Optional parallelization cost used to hash password.","x-example":null},"passwordLength":{"type":"integer","description":"Optional hash length used to hash password.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordCpu","passwordMemory","passwordParallel","passwordLength"]}}}}}},"\/users\/scrypt-modified":{"post":{"summary":"Create user with Scrypt modified password","operationId":"usersCreateScryptModifiedUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createScryptModifiedUser","weight":237,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-modified-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt Modified.","x-example":"password"},"passwordSalt":{"type":"string","description":"Salt used to hash password.","x-example":"<PASSWORD_SALT>"},"passwordSaltSeparator":{"type":"string","description":"Salt separator used to hash password.","x-example":"<PASSWORD_SALT_SEPARATOR>"},"passwordSignerKey":{"type":"string","description":"Signer key used to hash password.","x-example":"<PASSWORD_SIGNER_KEY>"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordSaltSeparator","passwordSignerKey"]}}}}}},"\/users\/sha":{"post":{"summary":"Create user with SHA password","operationId":"usersCreateSHAUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createSHAUser","weight":234,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-s-h-a-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using SHA.","x-example":"password"},"passwordVersion":{"type":"string","description":"Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'","x-example":"sha1","enum":["sha1","sha224","sha256","sha384","sha512\/224","sha512\/256","sha512","sha3-224","sha3-256","sha3-384","sha3-512"],"x-enum-name":"PasswordHash","x-enum-keys":[]},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/usage":{"get":{"summary":"Get users usage stats","operationId":"usersGetUsage","tags":["users"],"description":"","responses":{"200":{"description":"UsageUsers","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageUsers"}}}}},"x-appwrite":{"method":"getUsage","weight":272,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"UserUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/users\/{userId}":{"get":{"summary":"Get user","operationId":"usersGet","tags":["users"],"description":"Get a user by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"get","weight":240,"cookies":false,"type":"","deprecated":false,"demo":"users\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"delete":{"summary":"Delete user","operationId":"usersDelete","tags":["users"],"description":"Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":268,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/email":{"patch":{"summary":"Update email","operationId":"usersUpdateEmail","tags":["users"],"description":"Update the user email by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmail","weight":253,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"}},"required":["email"]}}}}}},"\/users\/{userId}\/jwts":{"post":{"summary":"Create user JWT","operationId":"usersCreateJWT","tags":["users"],"description":"Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":271,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.","x-example":"<SESSION_ID>"},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","x-example":0}}}}}}}},"\/users\/{userId}\/labels":{"put":{"summary":"Update user labels","operationId":"usersUpdateLabels","tags":["users"],"description":"Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateLabels","weight":249,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-labels.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"labels":{"type":"array","description":"Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.","x-example":null,"items":{"type":"string"}}},"required":["labels"]}}}}}},"\/users\/{userId}\/logs":{"get":{"summary":"List user logs","operationId":"usersListLogs","tags":["users"],"description":"Get the user activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":245,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/users\/{userId}\/memberships":{"get":{"summary":"List user memberships","operationId":"usersListMemberships","tags":["users"],"description":"Get the user membership list by its unique ID.","responses":{"200":{"description":"Memberships List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membershipList"}}}}},"x-appwrite":{"method":"listMemberships","weight":244,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/mfa":{"patch":{"summary":"Update MFA","operationId":"usersUpdateMfa","tags":["users"],"description":"Enable or disable MFA on a user account.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMfa","weight":258,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","x-example":false}},"required":["mfa"]}}}}}},"\/users\/{userId}\/mfa\/authenticators\/{type}":{"delete":{"summary":"Delete Authenticator","operationId":"usersDeleteMfaAuthenticator","tags":["users"],"description":"Delete an authenticator app.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":263,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]}},"\/users\/{userId}\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"usersListMfaFactors","tags":["users"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaFactors"}}}}},"x-appwrite":{"method":"listMfaFactors","weight":259,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"usersGetMfaRecoveryCodes","tags":["users"],"description":"Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":260,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"put":{"summary":"Regenerate MFA Recovery Codes","operationId":"usersUpdateMfaRecoveryCodes","tags":["users"],"description":"Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":262,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"patch":{"summary":"Create MFA Recovery Codes","operationId":"usersCreateMfaRecoveryCodes","tags":["users"],"description":"Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.","responses":{"201":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":261,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/name":{"patch":{"summary":"Update name","operationId":"usersUpdateName","tags":["users"],"description":"Update the user name by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateName","weight":251,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["name"]}}}}}},"\/users\/{userId}\/password":{"patch":{"summary":"Update password","operationId":"usersUpdatePassword","tags":["users"],"description":"Update the user password by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePassword","weight":252,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","x-example":null}},"required":["password"]}}}}}},"\/users\/{userId}\/phone":{"patch":{"summary":"Update phone","operationId":"usersUpdatePhone","tags":["users"],"description":"Update the user phone by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhone","weight":254,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"User phone number.","x-example":"+12065550100"}},"required":["number"]}}}}}},"\/users\/{userId}\/prefs":{"get":{"summary":"Get user preferences","operationId":"usersGetPrefs","tags":["users"],"description":"Get the user preferences by its unique ID.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":241,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"patch":{"summary":"Update user preferences","operationId":"usersUpdatePrefs","tags":["users"],"description":"Update the user preferences by its unique ID. 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.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"updatePrefs","weight":256,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/users\/{userId}\/sessions":{"get":{"summary":"List user sessions","operationId":"usersListSessions","tags":["users"],"description":"Get the user sessions list by its unique ID.","responses":{"200":{"description":"Sessions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/sessionList"}}}}},"x-appwrite":{"method":"listSessions","weight":243,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"post":{"summary":"Create session","operationId":"usersCreateSession","tags":["users"],"description":"Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createSession","weight":264,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"delete":{"summary":"Delete user sessions","operationId":"usersDeleteSessions","tags":["users"],"description":"Delete all user's sessions by using the user's unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":267,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/sessions\/{sessionId}":{"delete":{"summary":"Delete user session","operationId":"usersDeleteSession","tags":["users"],"description":"Delete a user sessions by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":266,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"sessionId","description":"Session ID.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]}},"\/users\/{userId}\/status":{"patch":{"summary":"Update user status","operationId":"usersUpdateStatus","tags":["users"],"description":"Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateStatus","weight":248,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"User Status. To activate the user pass `true` and to block the user pass `false`.","x-example":false}},"required":["status"]}}}}}},"\/users\/{userId}\/targets":{"get":{"summary":"List User Targets","operationId":"usersListTargets","tags":["users"],"description":"List the messaging targets that are associated with a user.","responses":{"200":{"description":"Target list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/targetList"}}}}},"x-appwrite":{"method":"listTargets","weight":246,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create User Target","operationId":"usersCreateTarget","tags":["users"],"description":"Create a messaging target.","responses":{"201":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"createTarget","weight":238,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<TARGET_ID>"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email","enum":["email","sms","push"],"x-enum-name":"MessagingProviderType","x-enum-keys":[]},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","x-example":"<NAME>"}},"required":["targetId","providerType","identifier"]}}}}}},"\/users\/{userId}\/targets\/{targetId}":{"get":{"summary":"Get User Target","operationId":"usersGetTarget","tags":["users"],"description":"Get a user's push notification target by ID.","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"getTarget","weight":242,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}]},"patch":{"summary":"Update User target","operationId":"usersUpdateTarget","tags":["users"],"description":"Update a messaging target.","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"updateTarget","weight":257,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","x-example":"<NAME>"}}}}}}},"delete":{"summary":"Delete user target","operationId":"usersDeleteTarget","tags":["users"],"description":"Delete a messaging target.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTarget","weight":269,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}]}},"\/users\/{userId}\/tokens":{"post":{"summary":"Create token","operationId":"usersCreateToken","tags":["users"],"description":"Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createToken","weight":265,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"length":{"type":"integer","description":"Token length in characters. The default length is 6 characters","x-example":4},"expire":{"type":"integer","description":"Token expiration period in seconds. The default expiration is 15 minutes.","x-example":60}}}}}}}},"\/users\/{userId}\/verification":{"patch":{"summary":"Update email verification","operationId":"usersUpdateEmailVerification","tags":["users"],"description":"Update the user email verification status by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmailVerification","weight":255,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"emailVerification":{"type":"boolean","description":"User email verification status.","x-example":false}},"required":["emailVerification"]}}}}}},"\/users\/{userId}\/verification\/phone":{"patch":{"summary":"Update phone verification","operationId":"usersUpdatePhoneVerification","tags":["users"],"description":"Update the user phone verification status by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhoneVerification","weight":250,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"phoneVerification":{"type":"boolean","description":"User phone verification status.","x-example":false}},"required":["phoneVerification"]}}}}}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories":{"get":{"summary":"List Repositories","operationId":"vcsListRepositories","tags":["vcs"],"description":"","responses":{"200":{"description":"Provider Repositories List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/providerRepositoryList"}}}}},"x-appwrite":{"method":"listRepositories","weight":277,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-repositories.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create repository","operationId":"vcsCreateRepository","tags":["vcs"],"description":"","responses":{"200":{"description":"ProviderRepository","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/providerRepository"}}}}},"x-appwrite":{"method":"createRepository","weight":278,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/create-repository.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Repository name (slug)","x-example":"<NAME>"},"private":{"type":"boolean","description":"Mark repository public or private","x-example":false}},"required":["name","private"]}}}}}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}":{"get":{"summary":"Get repository","operationId":"vcsGetRepository","tags":["vcs"],"description":"","responses":{"200":{"description":"ProviderRepository","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/providerRepository"}}}}},"x-appwrite":{"method":"getRepository","weight":279,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-repository.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"schema":{"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>"},"in":"path"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/branches":{"get":{"summary":"List Repository Branches","operationId":"vcsListRepositoryBranches","tags":["vcs"],"description":"","responses":{"200":{"description":"Branches List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/branchList"}}}}},"x-appwrite":{"method":"listRepositoryBranches","weight":280,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-repository-branches.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"schema":{"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>"},"in":"path"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/contents":{"get":{"summary":"Get files and directories of a VCS repository","operationId":"vcsGetRepositoryContents","tags":["vcs"],"description":"","responses":{"200":{"description":"VCS Content List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/vcsContentList"}}}}},"x-appwrite":{"method":"getRepositoryContents","weight":275,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-repository-contents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"schema":{"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>"},"in":"path"},{"name":"providerRootDirectory","description":"Path to get contents of nested directory","required":false,"schema":{"type":"string","x-example":"<PROVIDER_ROOT_DIRECTORY>","default":""},"in":"query"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/detection":{"post":{"summary":"Detect runtime settings from source code","operationId":"vcsCreateRepositoryDetection","tags":["vcs"],"description":"","responses":{"200":{"description":"Detection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/detection"}}}}},"x-appwrite":{"method":"createRepositoryDetection","weight":276,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/create-repository-detection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"schema":{"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerRootDirectory":{"type":"string","description":"Path to Root Directory","x-example":"<PROVIDER_ROOT_DIRECTORY>"}}}}}}}},"\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}":{"patch":{"summary":"Authorize external deployment","operationId":"vcsUpdateExternalDeployments","tags":["vcs"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateExternalDeployments","weight":285,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/update-external-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"repositoryId","description":"VCS Repository Id","required":true,"schema":{"type":"string","x-example":"<REPOSITORY_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerPullRequestId":{"type":"string","description":"GitHub Pull Request Id","x-example":"<PROVIDER_PULL_REQUEST_ID>"}},"required":["providerPullRequestId"]}}}}}},"\/vcs\/installations":{"get":{"summary":"List installations","operationId":"vcsListInstallations","tags":["vcs"],"description":"","responses":{"200":{"description":"Installations List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/installationList"}}}}},"x-appwrite":{"method":"listInstallations","weight":282,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-installations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-installations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"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: provider, organization","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/vcs\/installations\/{installationId}":{"get":{"summary":"Get installation","operationId":"vcsGetInstallation","tags":["vcs"],"description":"","responses":{"200":{"description":"Installation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/installation"}}}}},"x-appwrite":{"method":"getInstallation","weight":283,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-installation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-installation.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"}]},"delete":{"summary":"Delete Installation","operationId":"vcsDeleteInstallation","tags":["vcs"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteInstallation","weight":284,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/delete-installation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/delete-installation.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"}]}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"components":{"schemas":{"any":{"description":"Any","type":"object","additionalProperties":true},"error":{"description":"Error","type":"object","properties":{"message":{"type":"string","description":"Error message.","x-example":"Not found"},"code":{"type":"string","description":"Error code.","x-example":"404"},"type":{"type":"string","description":"Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes","x-example":"not_found"},"version":{"type":"string","description":"Server version number.","x-example":"1.0"}},"required":["message","code","type","version"]},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"$ref":"#\/components\/schemas\/document"},"x-example":""}},"required":["total","documents"]},"collectionList":{"description":"Collections List","type":"object","properties":{"total":{"type":"integer","description":"Total number of collections documents that matched your query.","x-example":5,"format":"int32"},"collections":{"type":"array","description":"List of collections.","items":{"$ref":"#\/components\/schemas\/collection"},"x-example":""}},"required":["total","collections"]},"databaseList":{"description":"Databases List","type":"object","properties":{"total":{"type":"integer","description":"Total number of databases documents that matched your query.","x-example":5,"format":"int32"},"databases":{"type":"array","description":"List of databases.","items":{"$ref":"#\/components\/schemas\/database"},"x-example":""}},"required":["total","databases"]},"indexList":{"description":"Indexes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of indexes documents that matched your query.","x-example":5,"format":"int32"},"indexes":{"type":"array","description":"List of indexes.","items":{"$ref":"#\/components\/schemas\/index"},"x-example":""}},"required":["total","indexes"]},"userList":{"description":"Users List","type":"object","properties":{"total":{"type":"integer","description":"Total number of users documents that matched your query.","x-example":5,"format":"int32"},"users":{"type":"array","description":"List of users.","items":{"$ref":"#\/components\/schemas\/user"},"x-example":""}},"required":["total","users"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"$ref":"#\/components\/schemas\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"$ref":"#\/components\/schemas\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"$ref":"#\/components\/schemas\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"$ref":"#\/components\/schemas\/file"},"x-example":""}},"required":["total","files"]},"bucketList":{"description":"Buckets List","type":"object","properties":{"total":{"type":"integer","description":"Total number of buckets documents that matched your query.","x-example":5,"format":"int32"},"buckets":{"type":"array","description":"List of buckets.","items":{"$ref":"#\/components\/schemas\/bucket"},"x-example":""}},"required":["total","buckets"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"$ref":"#\/components\/schemas\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"$ref":"#\/components\/schemas\/membership"},"x-example":""}},"required":["total","memberships"]},"functionList":{"description":"Functions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of functions documents that matched your query.","x-example":5,"format":"int32"},"functions":{"type":"array","description":"List of functions.","items":{"$ref":"#\/components\/schemas\/function"},"x-example":""}},"required":["total","functions"]},"installationList":{"description":"Installations List","type":"object","properties":{"total":{"type":"integer","description":"Total number of installations documents that matched your query.","x-example":5,"format":"int32"},"installations":{"type":"array","description":"List of installations.","items":{"$ref":"#\/components\/schemas\/installation"},"x-example":""}},"required":["total","installations"]},"providerRepositoryList":{"description":"Provider Repositories List","type":"object","properties":{"total":{"type":"integer","description":"Total number of providerRepositories documents that matched your query.","x-example":5,"format":"int32"},"providerRepositories":{"type":"array","description":"List of providerRepositories.","items":{"$ref":"#\/components\/schemas\/providerRepository"},"x-example":""}},"required":["total","providerRepositories"]},"branchList":{"description":"Branches List","type":"object","properties":{"total":{"type":"integer","description":"Total number of branches documents that matched your query.","x-example":5,"format":"int32"},"branches":{"type":"array","description":"List of branches.","items":{"$ref":"#\/components\/schemas\/branch"},"x-example":""}},"required":["total","branches"]},"runtimeList":{"description":"Runtimes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of runtimes documents that matched your query.","x-example":5,"format":"int32"},"runtimes":{"type":"array","description":"List of runtimes.","items":{"$ref":"#\/components\/schemas\/runtime"},"x-example":""}},"required":["total","runtimes"]},"deploymentList":{"description":"Deployments List","type":"object","properties":{"total":{"type":"integer","description":"Total number of deployments documents that matched your query.","x-example":5,"format":"int32"},"deployments":{"type":"array","description":"List of deployments.","items":{"$ref":"#\/components\/schemas\/deployment"},"x-example":""}},"required":["total","deployments"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"$ref":"#\/components\/schemas\/execution"},"x-example":""}},"required":["total","executions"]},"projectList":{"description":"Projects List","type":"object","properties":{"total":{"type":"integer","description":"Total number of projects documents that matched your query.","x-example":5,"format":"int32"},"projects":{"type":"array","description":"List of projects.","items":{"$ref":"#\/components\/schemas\/project"},"x-example":""}},"required":["total","projects"]},"webhookList":{"description":"Webhooks List","type":"object","properties":{"total":{"type":"integer","description":"Total number of webhooks documents that matched your query.","x-example":5,"format":"int32"},"webhooks":{"type":"array","description":"List of webhooks.","items":{"$ref":"#\/components\/schemas\/webhook"},"x-example":""}},"required":["total","webhooks"]},"keyList":{"description":"API Keys List","type":"object","properties":{"total":{"type":"integer","description":"Total number of keys documents that matched your query.","x-example":5,"format":"int32"},"keys":{"type":"array","description":"List of keys.","items":{"$ref":"#\/components\/schemas\/key"},"x-example":""}},"required":["total","keys"]},"platformList":{"description":"Platforms List","type":"object","properties":{"total":{"type":"integer","description":"Total number of platforms documents that matched your query.","x-example":5,"format":"int32"},"platforms":{"type":"array","description":"List of platforms.","items":{"$ref":"#\/components\/schemas\/platform"},"x-example":""}},"required":["total","platforms"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"$ref":"#\/components\/schemas\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"$ref":"#\/components\/schemas\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"$ref":"#\/components\/schemas\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"$ref":"#\/components\/schemas\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"$ref":"#\/components\/schemas\/phone"},"x-example":""}},"required":["total","phones"]},"variableList":{"description":"Variables List","type":"object","properties":{"total":{"type":"integer","description":"Total number of variables documents that matched your query.","x-example":5,"format":"int32"},"variables":{"type":"array","description":"List of variables.","items":{"$ref":"#\/components\/schemas\/variable"},"x-example":""}},"required":["total","variables"]},"proxyRuleList":{"description":"Rule List","type":"object","properties":{"total":{"type":"integer","description":"Total number of rules documents that matched your query.","x-example":5,"format":"int32"},"rules":{"type":"array","description":"List of rules.","items":{"$ref":"#\/components\/schemas\/proxyRule"},"x-example":""}},"required":["total","rules"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"$ref":"#\/components\/schemas\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"providerList":{"description":"Provider list","type":"object","properties":{"total":{"type":"integer","description":"Total number of providers documents that matched your query.","x-example":5,"format":"int32"},"providers":{"type":"array","description":"List of providers.","items":{"$ref":"#\/components\/schemas\/provider"},"x-example":""}},"required":["total","providers"]},"messageList":{"description":"Message list","type":"object","properties":{"total":{"type":"integer","description":"Total number of messages documents that matched your query.","x-example":5,"format":"int32"},"messages":{"type":"array","description":"List of messages.","items":{"$ref":"#\/components\/schemas\/message"},"x-example":""}},"required":["total","messages"]},"topicList":{"description":"Topic list","type":"object","properties":{"total":{"type":"integer","description":"Total number of topics documents that matched your query.","x-example":5,"format":"int32"},"topics":{"type":"array","description":"List of topics.","items":{"$ref":"#\/components\/schemas\/topic"},"x-example":""}},"required":["total","topics"]},"subscriberList":{"description":"Subscriber list","type":"object","properties":{"total":{"type":"integer","description":"Total number of subscribers documents that matched your query.","x-example":5,"format":"int32"},"subscribers":{"type":"array","description":"List of subscribers.","items":{"$ref":"#\/components\/schemas\/subscriber"},"x-example":""}},"required":["total","subscribers"]},"targetList":{"description":"Target list","type":"object","properties":{"total":{"type":"integer","description":"Total number of targets documents that matched your query.","x-example":5,"format":"int32"},"targets":{"type":"array","description":"List of targets.","items":{"$ref":"#\/components\/schemas\/target"},"x-example":""}},"required":["total","targets"]},"migrationList":{"description":"Migrations List","type":"object","properties":{"total":{"type":"integer","description":"Total number of migrations documents that matched your query.","x-example":5,"format":"int32"},"migrations":{"type":"array","description":"List of migrations.","items":{"$ref":"#\/components\/schemas\/migration"},"x-example":""}},"required":["total","migrations"]},"firebaseProjectList":{"description":"Migrations Firebase Projects List","type":"object","properties":{"total":{"type":"integer","description":"Total number of projects documents that matched your query.","x-example":5,"format":"int32"},"projects":{"type":"array","description":"List of projects.","items":{"$ref":"#\/components\/schemas\/firebaseProject"},"x-example":""}},"required":["total","projects"]},"vcsContentList":{"description":"VCS Content List","type":"object","properties":{"total":{"type":"integer","description":"Total number of contents documents that matched your query.","x-example":5,"format":"int32"},"contents":{"type":"array","description":"List of contents.","items":{"$ref":"#\/components\/schemas\/vcsContent"},"x-example":""}},"required":["total","contents"]},"database":{"description":"Database","type":"object","properties":{"$id":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Database name.","x-example":"My Database"},"$createdAt":{"type":"string","description":"Database creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Database update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"enabled":{"type":"boolean","description":"If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false}},"required":["$id","name","$createdAt","$updatedAt","enabled"]},"collection":{"description":"Collection","type":"object","properties":{"$id":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Collection creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Collection update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Collection name.","x-example":"My Collection"},"enabled":{"type":"boolean","description":"Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false},"documentSecurity":{"type":"boolean","description":"Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"attributes":{"type":"array","description":"Collection attributes.","items":{"anyOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]},"x-example":{}},"indexes":{"type":"array","description":"Collection indexes.","items":{"$ref":"#\/components\/schemas\/index"},"x-example":{}}},"required":["$id","$createdAt","$updatedAt","$permissions","databaseId","name","enabled","documentSecurity","attributes","indexes"]},"attributeList":{"description":"Attributes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of attributes in the given collection.","x-example":5,"format":"int32"},"attributes":{"type":"array","description":"List of attributes.","items":{"anyOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]},"x-example":""}},"required":["total","attributes"]},"attributeString":{"description":"AttributeString","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"size":{"type":"integer","description":"Attribute size.","x-example":128,"format":"int32"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default","nullable":true}},"required":["key","type","status","error","required","size"]},"attributeInteger":{"description":"AttributeInteger","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"count"},"type":{"type":"string","description":"Attribute type.","x-example":"integer"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"min":{"type":"integer","description":"Minimum value to enforce for new documents.","x-example":1,"format":"int32","nullable":true},"max":{"type":"integer","description":"Maximum value to enforce for new documents.","x-example":10,"format":"int32","nullable":true},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":10,"format":"int32","nullable":true}},"required":["key","type","status","error","required"]},"attributeFloat":{"description":"AttributeFloat","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"percentageCompleted"},"type":{"type":"string","description":"Attribute type.","x-example":"double"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"min":{"type":"number","description":"Minimum value to enforce for new documents.","x-example":1.5,"format":"double","nullable":true},"max":{"type":"number","description":"Maximum value to enforce for new documents.","x-example":10.5,"format":"double","nullable":true},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":2.5,"format":"double","nullable":true}},"required":["key","type","status","error","required"]},"attributeBoolean":{"description":"AttributeBoolean","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"isEnabled"},"type":{"type":"string","description":"Attribute type.","x-example":"boolean"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"nullable":true}},"required":["key","type","status","error","required"]},"attributeEmail":{"description":"AttributeEmail","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"userEmail"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"email"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default@example.com","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeEnum":{"description":"AttributeEnum","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"status"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"elements":{"type":"array","description":"Array of elements in enumerated type.","items":{"type":"string"},"x-example":"element"},"format":{"type":"string","description":"String format.","x-example":"enum"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"element","nullable":true}},"required":["key","type","status","error","required","elements","format"]},"attributeIp":{"description":"AttributeIP","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"ipAddress"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"ip"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"192.0.2.0","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeUrl":{"description":"AttributeURL","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"githubUrl"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"url"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"http:\/\/example.com","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeDatetime":{"description":"AttributeDatetime","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"birthDay"},"type":{"type":"string","description":"Attribute type.","x-example":"datetime"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"ISO 8601 format.","x-example":"datetime"},"default":{"type":"string","description":"Default value for attribute when not provided. Only null is optional","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeRelationship":{"description":"AttributeRelationship","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"relatedCollection":{"type":"string","description":"The ID of the related collection.","x-example":"collection"},"relationType":{"type":"string","description":"The type of the relationship.","x-example":"oneToOne|oneToMany|manyToOne|manyToMany"},"twoWay":{"type":"boolean","description":"Is the relationship two-way?","x-example":false},"twoWayKey":{"type":"string","description":"The key of the two-way relationship.","x-example":"string"},"onDelete":{"type":"string","description":"How deleting the parent document will propagate to child documents.","x-example":"restrict|cascade|setNull"},"side":{"type":"string","description":"Whether this is the parent or child side of the relationship","x-example":"parent|child"}},"required":["key","type","status","error","required","relatedCollection","relationType","twoWay","twoWayKey","onDelete","side"]},"index":{"description":"Index","type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":"index1"},"type":{"type":"string","description":"Index type.","x-example":"primary"},"status":{"type":"string","description":"Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an index.","x-example":"string"},"attributes":{"type":"array","description":"Index attributes.","items":{"type":"string"},"x-example":[]},"orders":{"type":"array","description":"Index orders.","items":{"type":"string"},"x-example":[],"nullable":true}},"required":["key","type","status","error","attributes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"oneOf":[{"$ref":"#\/components\/schemas\/algoArgon2"},{"$ref":"#\/components\/schemas\/algoScrypt"},{"$ref":"#\/components\/schemas\/algoScryptModified"},{"$ref":"#\/components\/schemas\/algoBcrypt"},{"$ref":"#\/components\/schemas\/algoPhpass"},{"$ref":"#\/components\/schemas\/algoSha"},{"$ref":"#\/components\/schemas\/algoMd5"}]},"nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"$ref":"#\/components\/schemas\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"bucket":{"description":"Bucket","type":"object","properties":{"$id":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Bucket creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Bucket update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"fileSecurity":{"type":"boolean","description":"Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"name":{"type":"string","description":"Bucket name.","x-example":"Documents"},"enabled":{"type":"boolean","description":"Bucket enabled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size supported.","x-example":100,"format":"int32"},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions.","items":{"type":"string"},"x-example":["jpg","png"]},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).","x-example":"gzip"},"encryption":{"type":"boolean","description":"Bucket is encrypted.","x-example":false},"antivirus":{"type":"boolean","description":"Virus scanning is enabled.","x-example":false}},"required":["$id","$createdAt","$updatedAt","$permissions","fileSecurity","name","enabled","maximumFileSize","allowedFileExtensions","compression","encryption","antivirus"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"function":{"description":"Function","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"execute":{"type":"array","description":"Execution permissions.","items":{"type":"string"},"x-example":"users"},"name":{"type":"string","description":"Function name.","x-example":"My Function"},"enabled":{"type":"boolean","description":"Function enabled.","x-example":false},"live":{"type":"boolean","description":"Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"runtime":{"type":"string","description":"Function execution runtime.","x-example":"python-3.8"},"deployment":{"type":"string","description":"Function's active deployment ID.","x-example":"5e5ea5c16897e"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"vars":{"type":"array","description":"Function variables.","items":{"$ref":"#\/components\/schemas\/variable"},"x-example":[]},"events":{"type":"array","description":"Function trigger events.","items":{"type":"string"},"x-example":"account.create"},"schedule":{"type":"string","description":"Function execution schedult in CRON format.","x-example":"5 4 * * *"},"timeout":{"type":"integer","description":"Function execution timeout in seconds.","x-example":300,"format":"int32"},"entrypoint":{"type":"string","description":"The entrypoint file used to execute the deployment.","x-example":"index.js"},"commands":{"type":"string","description":"The build command used to build the deployment.","x-example":"npm install"},"version":{"type":"string","description":"Version of Open Runtimes used for the function.","x-example":"v2"},"installationId":{"type":"string","description":"Function VCS (Version Control System) installation id.","x-example":"6m40at4ejk5h2u9s1hboo"},"providerRepositoryId":{"type":"string","description":"VCS (Version Control System) Repository ID","x-example":"appwrite"},"providerBranch":{"type":"string","description":"VCS (Version Control System) branch name","x-example":"main"},"providerRootDirectory":{"type":"string","description":"Path to function in VCS (Version Control System) repository","x-example":"functions\/helloWorld"},"providerSilentMode":{"type":"boolean","description":"Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests","x-example":false}},"required":["$id","$createdAt","$updatedAt","execute","name","enabled","live","logging","runtime","deployment","scopes","vars","events","schedule","timeout","entrypoint","commands","version","installationId","providerRepositoryId","providerBranch","providerRootDirectory","providerSilentMode"]},"installation":{"description":"Installation","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"VCS (Version Control System) provider name.","x-example":"github"},"organization":{"type":"string","description":"VCS (Version Control System) organization name.","x-example":"appwrite"},"providerInstallationId":{"type":"string","description":"VCS (Version Control System) installation ID.","x-example":"5322"}},"required":["$id","$createdAt","$updatedAt","provider","organization","providerInstallationId"]},"providerRepository":{"description":"ProviderRepository","type":"object","properties":{"id":{"type":"string","description":"VCS (Version Control System) repository ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"VCS (Version Control System) repository name.","x-example":"appwrite"},"organization":{"type":"string","description":"VCS (Version Control System) organization name","x-example":"appwrite"},"provider":{"type":"string","description":"VCS (Version Control System) provider name.","x-example":"github"},"private":{"type":"boolean","description":"Is VCS (Version Control System) repository private?","x-example":true},"runtime":{"type":"string","description":"Auto-detected runtime suggestion. Empty if getting response of getRuntime().","x-example":"node"},"pushedAt":{"type":"string","description":"Last commit date in ISO 8601 format.","x-example":"datetime"}},"required":["id","name","organization","provider","private","runtime","pushedAt"]},"detection":{"description":"Detection","type":"object","properties":{"runtime":{"type":"string","description":"Runtime","x-example":"node"}},"required":["runtime"]},"vcsContent":{"description":"VcsContents","type":"object","properties":{"size":{"type":"integer","description":"Content size in bytes. Only files have size, and for directories, 0 is returned.","x-example":1523,"format":"int32","nullable":true},"isDirectory":{"type":"boolean","description":"If a content is a directory. Directories can be used to check nested contents.","x-example":true,"nullable":true},"name":{"type":"string","description":"Name of directory or file.","x-example":"Main.java"}},"required":["name"]},"branch":{"description":"Branch","type":"object","properties":{"name":{"type":"string","description":"Branch Name.","x-example":"main"}},"required":["name"]},"runtime":{"description":"Runtime","type":"object","properties":{"$id":{"type":"string","description":"Runtime ID.","x-example":"python-3.8"},"name":{"type":"string","description":"Runtime Name.","x-example":"Python"},"version":{"type":"string","description":"Runtime version.","x-example":"3.8"},"base":{"type":"string","description":"Base Docker image used to build the runtime.","x-example":"python:3.8-alpine"},"image":{"type":"string","description":"Image name of Docker Hub.","x-example":"appwrite\\\/runtime-for-python:3.8"},"logo":{"type":"string","description":"Name of the logo image.","x-example":"python.png"},"supports":{"type":"array","description":"List of supported architectures.","items":{"type":"string"},"x-example":"amd64"}},"required":["$id","name","version","base","image","logo","supports"]},"deployment":{"description":"Deployment","type":"object","properties":{"$id":{"type":"string","description":"Deployment ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Deployment update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"type":{"type":"string","description":"Type of deployment.","x-example":"vcs"},"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea6g16897e"},"resourceType":{"type":"string","description":"Resource type.","x-example":"functions"},"entrypoint":{"type":"string","description":"The entrypoint file to use to execute the deployment code.","x-example":"index.js"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"},"buildId":{"type":"string","description":"The current build ID.","x-example":"5e5ea5c16897e"},"activate":{"type":"boolean","description":"Whether the deployment should be automatically activated.","x-example":true},"status":{"type":"string","description":"The deployment status. Possible values are \"processing\", \"building\", \"waiting\", \"ready\", and \"failed\".","x-example":"ready"},"buildLogs":{"type":"string","description":"The build logs.","x-example":"Compiling source files..."},"buildTime":{"type":"integer","description":"The current build time in seconds.","x-example":128,"format":"int32"},"providerRepositoryName":{"type":"string","description":"The name of the vcs provider repository","x-example":"database"},"providerRepositoryOwner":{"type":"string","description":"The name of the vcs provider repository owner","x-example":"utopia"},"providerRepositoryUrl":{"type":"string","description":"The url of the vcs provider repository","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function"},"providerBranch":{"type":"string","description":"The branch of the vcs repository","x-example":"0.7.x"},"providerCommitHash":{"type":"string","description":"The commit hash of the vcs commit","x-example":"7c3f25d"},"providerCommitAuthorUrl":{"type":"string","description":"The url of vcs commit author","x-example":"https:\/\/github.com\/vermakhushboo"},"providerCommitAuthor":{"type":"string","description":"The name of vcs commit author","x-example":"Khushboo Verma"},"providerCommitMessage":{"type":"string","description":"The commit message","x-example":"Update index.js"},"providerCommitUrl":{"type":"string","description":"The url of the vcs commit","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"},"providerBranchUrl":{"type":"string","description":"The branch of the vcs repository","x-example":"https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"}},"required":["$id","$createdAt","$updatedAt","type","resourceId","resourceType","entrypoint","size","buildId","activate","status","buildLogs","buildTime","providerRepositoryName","providerRepositoryOwner","providerRepositoryUrl","providerBranch","providerCommitHash","providerCommitAuthorUrl","providerCommitAuthor","providerCommitMessage","providerCommitUrl","providerBranchUrl"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"build":{"description":"Build","type":"object","properties":{"$id":{"type":"string","description":"Build ID.","x-example":"5e5ea5c16897e"},"deploymentId":{"type":"string","description":"The deployment that created this build.","x-example":"5e5ea5c16897e"},"status":{"type":"string","description":"The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built","x-example":"ready"},"stdout":{"type":"string","description":"The stdout of the build.","x-example":""},"stderr":{"type":"string","description":"The stderr of the build.","x-example":""},"startTime":{"type":"string","description":"The deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"endTime":{"type":"string","description":"The time the build was finished in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"duration":{"type":"integer","description":"The build duration in seconds.","x-example":0,"format":"int32"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"}},"required":["$id","deploymentId","status","stdout","stderr","startTime","endTime","duration","size"]},"project":{"description":"Project","type":"object","properties":{"$id":{"type":"string","description":"Project ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Project creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Project update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Project name.","x-example":"New Project"},"description":{"type":"string","description":"Project description.","x-example":"This is a new project."},"teamId":{"type":"string","description":"Project team ID.","x-example":"1592981250"},"logo":{"type":"string","description":"Project logo file ID.","x-example":"5f5c451b403cb"},"url":{"type":"string","description":"Project website URL.","x-example":"5f5c451b403cb"},"legalName":{"type":"string","description":"Company legal name.","x-example":"Company LTD."},"legalCountry":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.","x-example":"US"},"legalState":{"type":"string","description":"State name.","x-example":"New York"},"legalCity":{"type":"string","description":"City name.","x-example":"New York City."},"legalAddress":{"type":"string","description":"Company Address.","x-example":"620 Eighth Avenue, New York, NY 10018"},"legalTaxId":{"type":"string","description":"Company Tax ID.","x-example":"131102020"},"authDuration":{"type":"integer","description":"Session duration in seconds.","x-example":60,"format":"int32"},"authLimit":{"type":"integer","description":"Max users allowed. 0 is unlimited.","x-example":100,"format":"int32"},"authSessionsLimit":{"type":"integer","description":"Max sessions allowed per user. 100 maximum.","x-example":10,"format":"int32"},"authPasswordHistory":{"type":"integer","description":"Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.","x-example":5,"format":"int32"},"authPasswordDictionary":{"type":"boolean","description":"Whether or not to check user's password against most commonly used passwords.","x-example":true},"authPersonalDataCheck":{"type":"boolean","description":"Whether or not to check the user password for similarity with their personal data.","x-example":true},"authMockNumbers":{"type":"array","description":"An array of mock numbers and their corresponding verification codes (OTPs).","items":{"$ref":"#\/components\/schemas\/mockNumber"},"x-example":[{}]},"authSessionAlerts":{"type":"boolean","description":"Whether or not to send session alert emails to users.","x-example":true},"oAuthProviders":{"type":"array","description":"List of Auth Providers.","items":{"$ref":"#\/components\/schemas\/authProvider"},"x-example":[{}]},"platforms":{"type":"array","description":"List of Platforms.","items":{"$ref":"#\/components\/schemas\/platform"},"x-example":{}},"webhooks":{"type":"array","description":"List of Webhooks.","items":{"$ref":"#\/components\/schemas\/webhook"},"x-example":{}},"keys":{"type":"array","description":"List of API Keys.","items":{"$ref":"#\/components\/schemas\/key"},"x-example":{}},"smtpEnabled":{"type":"boolean","description":"Status for custom SMTP","x-example":false},"smtpSenderName":{"type":"string","description":"SMTP sender name","x-example":"John Appwrite"},"smtpSenderEmail":{"type":"string","description":"SMTP sender email","x-example":"john@appwrite.io"},"smtpReplyTo":{"type":"string","description":"SMTP reply to email","x-example":"support@appwrite.io"},"smtpHost":{"type":"string","description":"SMTP server host name","x-example":"mail.appwrite.io"},"smtpPort":{"type":"integer","description":"SMTP server port","x-example":25,"format":"int32"},"smtpUsername":{"type":"string","description":"SMTP server username","x-example":"emailuser"},"smtpPassword":{"type":"string","description":"SMTP server password","x-example":"securepassword"},"smtpSecure":{"type":"string","description":"SMTP server secure protocol","x-example":"tls"},"authEmailPassword":{"type":"boolean","description":"Email\/Password auth method status","x-example":true},"authUsersAuthMagicURL":{"type":"boolean","description":"Magic URL auth method status","x-example":true},"authEmailOtp":{"type":"boolean","description":"Email (OTP) auth method status","x-example":true},"authAnonymous":{"type":"boolean","description":"Anonymous auth method status","x-example":true},"authInvites":{"type":"boolean","description":"Invites auth method status","x-example":true},"authJWT":{"type":"boolean","description":"JWT auth method status","x-example":true},"authPhone":{"type":"boolean","description":"Phone auth method status","x-example":true},"serviceStatusForAccount":{"type":"boolean","description":"Account service status","x-example":true},"serviceStatusForAvatars":{"type":"boolean","description":"Avatars service status","x-example":true},"serviceStatusForDatabases":{"type":"boolean","description":"Databases service status","x-example":true},"serviceStatusForLocale":{"type":"boolean","description":"Locale service status","x-example":true},"serviceStatusForHealth":{"type":"boolean","description":"Health service status","x-example":true},"serviceStatusForStorage":{"type":"boolean","description":"Storage service status","x-example":true},"serviceStatusForTeams":{"type":"boolean","description":"Teams service status","x-example":true},"serviceStatusForUsers":{"type":"boolean","description":"Users service status","x-example":true},"serviceStatusForFunctions":{"type":"boolean","description":"Functions service status","x-example":true},"serviceStatusForGraphql":{"type":"boolean","description":"GraphQL service status","x-example":true},"serviceStatusForMessaging":{"type":"boolean","description":"Messaging service status","x-example":true}},"required":["$id","$createdAt","$updatedAt","name","description","teamId","logo","url","legalName","legalCountry","legalState","legalCity","legalAddress","legalTaxId","authDuration","authLimit","authSessionsLimit","authPasswordHistory","authPasswordDictionary","authPersonalDataCheck","authMockNumbers","authSessionAlerts","oAuthProviders","platforms","webhooks","keys","smtpEnabled","smtpSenderName","smtpSenderEmail","smtpReplyTo","smtpHost","smtpPort","smtpUsername","smtpPassword","smtpSecure","authEmailPassword","authUsersAuthMagicURL","authEmailOtp","authAnonymous","authInvites","authJWT","authPhone","serviceStatusForAccount","serviceStatusForAvatars","serviceStatusForDatabases","serviceStatusForLocale","serviceStatusForHealth","serviceStatusForStorage","serviceStatusForTeams","serviceStatusForUsers","serviceStatusForFunctions","serviceStatusForGraphql","serviceStatusForMessaging"]},"webhook":{"description":"Webhook","type":"object","properties":{"$id":{"type":"string","description":"Webhook ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Webhook creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Webhook update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Webhook name.","x-example":"My Webhook"},"url":{"type":"string","description":"Webhook URL endpoint.","x-example":"https:\/\/example.com\/webhook"},"events":{"type":"array","description":"Webhook trigger events.","items":{"type":"string"},"x-example":"database.collections.update"},"security":{"type":"boolean","description":"Indicated if SSL \/ TLS Certificate verification is enabled.","x-example":true},"httpUser":{"type":"string","description":"HTTP basic authentication username.","x-example":"username"},"httpPass":{"type":"string","description":"HTTP basic authentication password.","x-example":"password"},"signatureKey":{"type":"string","description":"Signature key which can be used to validated incoming","x-example":"ad3d581ca230e2b7059c545e5a"},"enabled":{"type":"boolean","description":"Indicates if this webhook is enabled.","x-example":true},"logs":{"type":"string","description":"Webhook error logs from the most recent failure.","x-example":"Failed to connect to remote server."},"attempts":{"type":"integer","description":"Number of consecutive failed webhook attempts.","x-example":10,"format":"int32"}},"required":["$id","$createdAt","$updatedAt","name","url","events","security","httpUser","httpPass","signatureKey","enabled","logs","attempts"]},"key":{"description":"Key","type":"object","properties":{"$id":{"type":"string","description":"Key ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Key creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Key update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Key name.","x-example":"My API Key"},"expire":{"type":"string","description":"Key expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"secret":{"type":"string","description":"Secret key.","x-example":"919c2d18fb5d4...a2ae413da83346ad2"},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"},"sdks":{"type":"array","description":"List of SDK user agents that used this key.","items":{"type":"string"},"x-example":"appwrite:flutter"}},"required":["$id","$createdAt","$updatedAt","name","expire","scopes","secret","accessedAt","sdks"]},"mockNumber":{"description":"Mock Number","type":"object","properties":{"phone":{"type":"string","description":"Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.","x-example":"+1612842323"},"otp":{"type":"string","description":"Mock OTP for the number. ","x-example":"123456"}},"required":["phone","otp"]},"authProvider":{"description":"AuthProvider","type":"object","properties":{"key":{"type":"string","description":"Auth Provider.","x-example":"github"},"name":{"type":"string","description":"Auth Provider name.","x-example":"GitHub"},"appId":{"type":"string","description":"OAuth 2.0 application ID.","x-example":"259125845563242502"},"secret":{"type":"string","description":"OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.","x-example":"Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ"},"enabled":{"type":"boolean","description":"Auth Provider is active and can be used to create session.","x-example":""}},"required":["key","name","appId","secret","enabled"]},"platform":{"description":"Platform","type":"object","properties":{"$id":{"type":"string","description":"Platform ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Platform creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Platform update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Platform name.","x-example":"My Web App"},"type":{"type":"string","description":"Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, ios, android, and unity.","x-example":"web"},"key":{"type":"string","description":"Platform Key. iOS bundle ID or Android package name. Empty string for other platforms.","x-example":"com.company.appname"},"store":{"type":"string","description":"App store or Google Play store ID.","x-example":""},"hostname":{"type":"string","description":"Web app hostname. Empty string for other platforms.","x-example":true},"httpUser":{"type":"string","description":"HTTP basic authentication username.","x-example":"username"},"httpPass":{"type":"string","description":"HTTP basic authentication password.","x-example":"password"}},"required":["$id","$createdAt","$updatedAt","name","type","key","store","hostname","httpUser","httpPass"]},"variable":{"description":"Variable","type":"object","properties":{"$id":{"type":"string","description":"Variable ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"key":{"type":"string","description":"Variable key.","x-example":"API_KEY"},"value":{"type":"string","description":"Variable value.","x-example":"myPa$$word1"},"resourceType":{"type":"string","description":"Service to which the variable belongs. Possible values are \"project\", \"function\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"}},"required":["$id","$createdAt","$updatedAt","key","value","resourceType","resourceId"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"healthAntivirus":{"description":"Health Antivirus","type":"object","properties":{"version":{"type":"string","description":"Antivirus version.","x-example":"1.0.0"},"status":{"type":"string","description":"Antivirus status. Possible values can are: `disabled`, `offline`, `online`","x-example":"online"}},"required":["version","status"]},"healthQueue":{"description":"Health Queue","type":"object","properties":{"size":{"type":"integer","description":"Amount of actions in the queue.","x-example":8,"format":"int32"}},"required":["size"]},"healthStatus":{"description":"Health Status","type":"object","properties":{"name":{"type":"string","description":"Name of the service.","x-example":"database"},"ping":{"type":"integer","description":"Duration in milliseconds how long the health check took.","x-example":128,"format":"int32"},"status":{"type":"string","description":"Service status. Possible values can are: `pass`, `fail`","x-example":"pass"}},"required":["name","ping","status"]},"healthCertificate":{"description":"Health Certificate","type":"object","properties":{"name":{"type":"string","description":"Certificate name","x-example":"\/CN=www.google.com"},"subjectSN":{"type":"string","description":"Subject SN","x-example":""},"issuerOrganisation":{"type":"string","description":"Issuer organisation","x-example":""},"validFrom":{"type":"string","description":"Valid from","x-example":"1704200998"},"validTo":{"type":"string","description":"Valid to","x-example":"1711458597"},"signatureTypeSN":{"type":"string","description":"Signature type SN","x-example":"RSA-SHA256"}},"required":["name","subjectSN","issuerOrganisation","validFrom","validTo","signatureTypeSN"]},"healthTime":{"description":"Health Time","type":"object","properties":{"remoteTime":{"type":"integer","description":"Current unix timestamp on trustful remote server.","x-example":1639490751,"format":"int32"},"localTime":{"type":"integer","description":"Current unix timestamp of local server where Appwrite runs.","x-example":1639490844,"format":"int32"},"diff":{"type":"integer","description":"Difference of unix remote and local timestamps in milliseconds.","x-example":93,"format":"int32"}},"required":["remoteTime","localTime","diff"]},"metric":{"description":"Metric","type":"object","properties":{"value":{"type":"integer","description":"The value of this metric at the timestamp.","x-example":1,"format":"int32"},"date":{"type":"string","description":"The date at which this metric was aggregated in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["value","date"]},"metricBreakdown":{"description":"Metric Breakdown","type":"object","properties":{"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Resource name.","x-example":"Documents"},"value":{"type":"integer","description":"The value of this metric at the timestamp.","x-example":1,"format":"int32"}},"required":["resourceId","name","value"]},"usageDatabases":{"description":"UsageDatabases","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"databasesTotal":{"type":"integer","description":"Total aggregated number of databases.","x-example":0,"format":"int32"},"collectionsTotal":{"type":"integer","description":"Total aggregated number of collections.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"databases":{"type":"array","description":"Aggregated number of databases per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"collections":{"type":"array","description":"Aggregated number of collections per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","databasesTotal","collectionsTotal","documentsTotal","databases","collections","documents"]},"usageDatabase":{"description":"UsageDatabase","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"collectionsTotal":{"type":"integer","description":"Total aggregated number of collections.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"collections":{"type":"array","description":"Aggregated number of collections per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","collectionsTotal","documentsTotal","collections","documents"]},"usageCollection":{"description":"UsageCollection","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"documentsTotal":{"type":"integer","description":"Total aggregated number of of documents.","x-example":0,"format":"int32"},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","documentsTotal","documents"]},"usageUsers":{"description":"UsageUsers","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"usersTotal":{"type":"integer","description":"Total aggregated number of statistics of users.","x-example":0,"format":"int32"},"sessionsTotal":{"type":"integer","description":"Total aggregated number of active sessions.","x-example":0,"format":"int32"},"users":{"type":"array","description":"Aggregated number of users per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"sessions":{"type":"array","description":"Aggregated number of active sessions per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","usersTotal","sessionsTotal","users","sessions"]},"usageStorage":{"description":"StorageUsage","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"bucketsTotal":{"type":"integer","description":"Total aggregated number of buckets","x-example":0,"format":"int32"},"filesTotal":{"type":"integer","description":"Total aggregated number of files.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated number of files storage (in bytes).","x-example":0,"format":"int32"},"buckets":{"type":"array","description":"Aggregated number of buckets per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"files":{"type":"array","description":"Aggregated number of files per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"storage":{"type":"array","description":"Aggregated number of files storage (in bytes) per period .","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","bucketsTotal","filesTotal","filesStorageTotal","buckets","files","storage"]},"usageBuckets":{"description":"UsageBuckets","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"filesTotal":{"type":"integer","description":"Total aggregated number of bucket files.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated number of bucket files storage (in bytes).","x-example":0,"format":"int32"},"files":{"type":"array","description":"Aggregated number of bucket files per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"storage":{"type":"array","description":"Aggregated number of bucket storage files (in bytes) per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","filesTotal","filesStorageTotal","files","storage"]},"usageFunctions":{"description":"UsageFunctions","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"functionsTotal":{"type":"integer","description":"Total aggregated number of functions.","x-example":0,"format":"int32"},"deploymentsTotal":{"type":"integer","description":"Total aggregated number of functions deployments.","x-example":0,"format":"int32"},"deploymentsStorageTotal":{"type":"integer","description":"Total aggregated sum of functions deployment storage.","x-example":0,"format":"int32"},"buildsTotal":{"type":"integer","description":"Total aggregated number of functions build.","x-example":0,"format":"int32"},"buildsStorageTotal":{"type":"integer","description":"total aggregated sum of functions build storage.","x-example":0,"format":"int32"},"buildsTimeTotal":{"type":"integer","description":"Total aggregated sum of functions build compute time.","x-example":0,"format":"int32"},"executionsTotal":{"type":"integer","description":"Total aggregated number of functions execution.","x-example":0,"format":"int32"},"executionsTimeTotal":{"type":"integer","description":"Total aggregated sum of functions execution compute time.","x-example":0,"format":"int32"},"functions":{"type":"array","description":"Aggregated number of functions per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":0},"deployments":{"type":"array","description":"Aggregated number of functions deployment per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"deploymentsStorage":{"type":"array","description":"Aggregated number of functions deployment storage per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"builds":{"type":"array","description":"Aggregated number of functions build per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"buildsStorage":{"type":"array","description":"Aggregated sum of functions build storage per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"buildsTime":{"type":"array","description":"Aggregated sum of functions build compute time per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of functions execution per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executionsTime":{"type":"array","description":"Aggregated number of functions execution compute time per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","functionsTotal","deploymentsTotal","deploymentsStorageTotal","buildsTotal","buildsStorageTotal","buildsTimeTotal","executionsTotal","executionsTimeTotal","functions","deployments","deploymentsStorage","builds","buildsStorage","buildsTime","executions","executionsTime"]},"usageFunction":{"description":"UsageFunction","type":"object","properties":{"range":{"type":"string","description":"The time range of the usage stats.","x-example":"30d"},"deploymentsTotal":{"type":"integer","description":"Total aggregated number of function deployments.","x-example":0,"format":"int32"},"deploymentsStorageTotal":{"type":"integer","description":"Total aggregated sum of function deployments storage.","x-example":0,"format":"int32"},"buildsTotal":{"type":"integer","description":"Total aggregated number of function builds.","x-example":0,"format":"int32"},"buildsStorageTotal":{"type":"integer","description":"total aggregated sum of function builds storage.","x-example":0,"format":"int32"},"buildsTimeTotal":{"type":"integer","description":"Total aggregated sum of function builds compute time.","x-example":0,"format":"int32"},"executionsTotal":{"type":"integer","description":"Total aggregated number of function executions.","x-example":0,"format":"int32"},"executionsTimeTotal":{"type":"integer","description":"Total aggregated sum of function executions compute time.","x-example":0,"format":"int32"},"deployments":{"type":"array","description":"Aggregated number of function deployments per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"deploymentsStorage":{"type":"array","description":"Aggregated number of function deployments storage per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"builds":{"type":"array","description":"Aggregated number of function builds per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"buildsStorage":{"type":"array","description":"Aggregated sum of function builds storage per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"buildsTime":{"type":"array","description":"Aggregated sum of function builds compute time per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of function executions per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executionsTime":{"type":"array","description":"Aggregated number of function executions compute time per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","deploymentsTotal","deploymentsStorageTotal","buildsTotal","buildsStorageTotal","buildsTimeTotal","executionsTotal","executionsTimeTotal","deployments","deploymentsStorage","builds","buildsStorage","buildsTime","executions","executionsTime"]},"usageProject":{"description":"UsageProject","type":"object","properties":{"executionsTotal":{"type":"integer","description":"Total aggregated number of function executions.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"databasesTotal":{"type":"integer","description":"Total aggregated number of databases.","x-example":0,"format":"int32"},"usersTotal":{"type":"integer","description":"Total aggregated number of users.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated sum of files storage size (in bytes).","x-example":0,"format":"int32"},"bucketsTotal":{"type":"integer","description":"Total aggregated number of buckets.","x-example":0,"format":"int32"},"requests":{"type":"array","description":"Aggregated number of requests per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"network":{"type":"array","description":"Aggregated number of consumed bandwidth per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"users":{"type":"array","description":"Aggregated number of users per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of executions per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executionsBreakdown":{"type":"array","description":"Aggregated breakdown in totals of executions by functions.","items":{"$ref":"#\/components\/schemas\/metricBreakdown"},"x-example":[]},"bucketsBreakdown":{"type":"array","description":"Aggregated breakdown in totals of usage by buckets.","items":{"$ref":"#\/components\/schemas\/metricBreakdown"},"x-example":[]}},"required":["executionsTotal","documentsTotal","databasesTotal","usersTotal","filesStorageTotal","bucketsTotal","requests","network","users","executions","executionsBreakdown","bucketsBreakdown"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"proxyRule":{"description":"Rule","type":"object","properties":{"$id":{"type":"string","description":"Rule ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Rule creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Rule update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"domain":{"type":"string","description":"Domain name.","x-example":"appwrite.company.com"},"resourceType":{"type":"string","description":"Action definition for the rule. Possible values are \"api\", \"function\", or \"redirect\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource for the action type. If resourceType is \"api\" or \"url\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"},"status":{"type":"string","description":"Domain verification status. Possible values are \"created\", \"verifying\", \"verified\" and \"unverified\"","x-example":"verified"},"logs":{"type":"string","description":"Certificate generation logs. This will return an empty string if generation did not run, or succeeded.","x-example":"HTTP challegne failed."},"renewAt":{"type":"string","description":"Certificate auto-renewal date in ISO 8601 format.","x-example":"datetime"}},"required":["$id","$createdAt","$updatedAt","domain","resourceType","resourceId","status","logs","renewAt"]},"smsTemplate":{"description":"SmsTemplate","type":"object","properties":{"type":{"type":"string","description":"Template type","x-example":"verification"},"locale":{"type":"string","description":"Template locale","x-example":"en_us"},"message":{"type":"string","description":"Template message","x-example":"Click on the link to verify your account."}},"required":["type","locale","message"]},"emailTemplate":{"description":"EmailTemplate","type":"object","properties":{"type":{"type":"string","description":"Template type","x-example":"verification"},"locale":{"type":"string","description":"Template locale","x-example":"en_us"},"message":{"type":"string","description":"Template message","x-example":"Click on the link to verify your account."},"senderName":{"type":"string","description":"Name of the sender","x-example":"My User"},"senderEmail":{"type":"string","description":"Email of the sender","x-example":"mail@appwrite.io"},"replyTo":{"type":"string","description":"Reply to email address","x-example":"emails@appwrite.io"},"subject":{"type":"string","description":"Email subject","x-example":"Please verify your email address"}},"required":["type","locale","message","senderName","senderEmail","replyTo","subject"]},"consoleVariables":{"description":"Console Variables","type":"object","properties":{"_APP_DOMAIN_TARGET":{"type":"string","description":"CNAME target for your Appwrite custom domains.","x-example":"appwrite.io"},"_APP_STORAGE_LIMIT":{"type":"integer","description":"Maximum file size allowed for file upload in bytes.","x-example":"30000000","format":"int32"},"_APP_FUNCTIONS_SIZE_LIMIT":{"type":"integer","description":"Maximum file size allowed for deployment in bytes.","x-example":"30000000","format":"int32"},"_APP_USAGE_STATS":{"type":"string","description":"Defines if usage stats are enabled. This value is set to 'enabled' by default, to disable the usage stats set the value to 'disabled'.","x-example":"enabled"},"_APP_VCS_ENABLED":{"type":"boolean","description":"Defines if VCS (Version Control System) is enabled.","x-example":true},"_APP_DOMAIN_ENABLED":{"type":"boolean","description":"Defines if main domain is configured. If so, custom domains can be created.","x-example":true},"_APP_ASSISTANT_ENABLED":{"type":"boolean","description":"Defines if AI assistant is enabled.","x-example":true}},"required":["_APP_DOMAIN_TARGET","_APP_STORAGE_LIMIT","_APP_FUNCTIONS_SIZE_LIMIT","_APP_USAGE_STATS","_APP_VCS_ENABLED","_APP_DOMAIN_ENABLED","_APP_ASSISTANT_ENABLED"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"provider":{"description":"Provider","type":"object","properties":{"$id":{"type":"string","description":"Provider ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Provider creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Provider update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name for the provider instance.","x-example":"Mailgun"},"provider":{"type":"string","description":"The name of the provider service.","x-example":"mailgun"},"enabled":{"type":"boolean","description":"Is provider enabled?","x-example":true},"type":{"type":"string","description":"Type of provider.","x-example":"sms"},"credentials":{"type":"object","description":"Provider credentials.","x-example":{"key":"123456789"}},"options":{"type":"object","description":"Provider options.","x-example":{"from":"sender-email@mydomain"},"nullable":true}},"required":["$id","$createdAt","$updatedAt","name","provider","enabled","type","credentials"]},"message":{"description":"Message","type":"object","properties":{"$id":{"type":"string","description":"Message ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Message creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Message update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerType":{"type":"string","description":"Message provider type.","x-example":"email"},"topics":{"type":"array","description":"Topic IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"users":{"type":"array","description":"User IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"targets":{"type":"array","description":"Target IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"scheduledAt":{"type":"string","description":"The scheduled time for message.","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true},"deliveredAt":{"type":"string","description":"The time when the message was delivered.","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true},"deliveryErrors":{"type":"array","description":"Delivery errors if any.","items":{"type":"string"},"x-example":["Failed to send message to target 5e5ea5c16897e: Credentials not valid."],"nullable":true},"deliveredTotal":{"type":"integer","description":"Number of recipients the message was delivered to.","x-example":1,"format":"int32"},"data":{"type":"object","description":"Data of the message.","x-example":{"subject":"Welcome to Appwrite","content":"Hi there, welcome to Appwrite family."}},"status":{"type":"string","description":"Status of delivery.","x-example":"Message status can be one of the following: draft, processing, scheduled, sent, or failed."}},"required":["$id","$createdAt","$updatedAt","providerType","topics","users","targets","deliveredTotal","data","status"]},"topic":{"description":"Topic","type":"object","properties":{"$id":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Topic creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Topic update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name of the topic.","x-example":"events"},"emailTotal":{"type":"integer","description":"Total count of email subscribers subscribed to the topic.","x-example":100,"format":"int32"},"smsTotal":{"type":"integer","description":"Total count of SMS subscribers subscribed to the topic.","x-example":100,"format":"int32"},"pushTotal":{"type":"integer","description":"Total count of push subscribers subscribed to the topic.","x-example":100,"format":"int32"},"subscribe":{"type":"array","description":"Subscribe permissions.","items":{"type":"string"},"x-example":"users"}},"required":["$id","$createdAt","$updatedAt","name","emailTotal","smsTotal","pushTotal","subscribe"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"$ref":"#\/components\/schemas\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]},"migration":{"description":"Migration","type":"object","properties":{"$id":{"type":"string","description":"Migration ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"string","description":"Migration status ( pending, processing, failed, completed ) ","x-example":"pending"},"stage":{"type":"string","description":"Migration stage ( init, processing, source-check, destination-check, migrating, finished )","x-example":"init"},"source":{"type":"string","description":"A string containing the type of source of the migration.","x-example":"Appwrite"},"resources":{"type":"array","description":"Resources to migration.","items":{"type":"string"},"x-example":["user"]},"statusCounters":{"type":"object","description":"A group of counters that represent the total progress of the migration.","x-example":"{\"Database\": {\"PENDING\": 0, \"SUCCESS\": 1, \"ERROR\": 0, \"SKIP\": 0, \"PROCESSING\": 0, \"WARNING\": 0}}"},"resourceData":{"type":"object","description":"An array of objects containing the report data of the resources that were migrated.","x-example":"[{\"resource\":\"Database\",\"id\":\"public\",\"status\":\"SUCCESS\",\"message\":\"\"}]"},"errors":{"type":"array","description":"All errors that occurred during the migration process.","items":{"type":"string"},"x-example":[]}},"required":["$id","$createdAt","$updatedAt","status","stage","source","resources","statusCounters","resourceData","errors"]},"migrationReport":{"description":"Migration Report","type":"object","properties":{"user":{"type":"integer","description":"Number of users to be migrated.","x-example":20,"format":"int32"},"team":{"type":"integer","description":"Number of teams to be migrated.","x-example":20,"format":"int32"},"database":{"type":"integer","description":"Number of databases to be migrated.","x-example":20,"format":"int32"},"document":{"type":"integer","description":"Number of documents to be migrated.","x-example":20,"format":"int32"},"file":{"type":"integer","description":"Number of files to be migrated.","x-example":20,"format":"int32"},"bucket":{"type":"integer","description":"Number of buckets to be migrated.","x-example":20,"format":"int32"},"function":{"type":"integer","description":"Number of functions to be migrated.","x-example":20,"format":"int32"},"size":{"type":"integer","description":"Size of files to be migrated in mb.","x-example":30000,"format":"int32"},"version":{"type":"string","description":"Version of the Appwrite instance to be migrated.","x-example":"1.4.0"}},"required":["user","team","database","document","file","bucket","function","size","version"]},"firebaseProject":{"description":"MigrationFirebaseProject","type":"object","properties":{"projectId":{"type":"string","description":"Project ID.","x-example":"my-project"},"displayName":{"type":"string","description":"Project display name.","x-example":"My Project"}},"required":["projectId","displayName"]}},"securitySchemes":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"Key":{"type":"apiKey","name":"X-Appwrite-Key","description":"Your secret API key","in":"header","x-appwrite":{"demo":"<YOUR_API_KEY>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header"},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Mode":{"type":"apiKey","name":"X-Appwrite-Mode","description":"","in":"header","x-appwrite":{"demo":""}}}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file +{"openapi":"3.0.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"servers":[{"url":"https:\/\/cloud.appwrite.io\/v1"}],"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}},"delete":{"summary":"Delete account","operationId":"accountDelete","tags":["account"],"description":"Delete the currently logged in user.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":9,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/identityList"}}}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"schema":{"type":"string","x-example":"<IDENTITY_ID>"},"in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","x-example":false}},"required":["mfa"]}}}}}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaType"}}}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","x-example":"<OTP>"}},"required":["otp"]}}}}},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaChallenge"}}}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}}}},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content","content":{"":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","x-example":"<OTP>"}},"required":["challengeId","otp"]}}}}}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaFactors"}}}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["name"]}}}}}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","x-example":"password"}},"required":["password"]}}}}}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["phone","password"]}}}}}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["email","url"]}}}}},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null}},"required":["userId","secret","password"]}}}}}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/sessionList"}}}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 session","operationId":"accountCreateOAuth2Session","tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"301":{"description":"File"}},"x-appwrite":{"method":"createOAuth2Session","weight":18,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"schema":{"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/targets\/push":{"post":{"summary":"Create push target","operationId":"accountCreatePushTarget","tags":["account"],"description":"","responses":{"201":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"createPushTarget","weight":53,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<TARGET_ID>"},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":"<PROVIDER_ID>"}},"required":["targetId","identifier"]}}}}}},"\/account\/targets\/{targetId}\/push":{"put":{"summary":"Update push target","operationId":"accountUpdatePushTarget","tags":["account"],"description":"","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"updatePushTarget","weight":54,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":"<IDENTIFIER>"}},"required":["identifier"]}}}}},"delete":{"summary":"Delete push target","operationId":"accountDeletePushTarget","tags":["account"],"description":"","responses":{"204":{"description":"No content","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"deletePushTarget","weight":55,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"File"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"schema":{"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"}},"required":["userId","phone"]}}}}}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["url"]}}}}},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"schema":{"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"schema":{"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"schema":{"type":"string","x-example":"<NAME>","default":""},"in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"schema":{"type":"string","default":""},"in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"schema":{"type":"string","x-example":"<TEXT>"},"in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":1,"default":400},"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":1},"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"schema":{"type":"boolean","x-example":false,"default":false},"in":"query"}]}},"\/console\/assistant":{"post":{"summary":"Ask Query","operationId":"assistantChat","tags":["assistant"],"description":"","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"chat","weight":328,"cookies":false,"type":"","deprecated":false,"demo":"assistant\/chat.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/assistant\/chat.md","rate-limit":15,"rate-time":3600,"rate-key":"userId:{userId}","scope":"assistant.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prompt":{"type":"string","description":"Prompt. A string containing questions asked to the AI assistant.","x-example":"<PROMPT>"}},"required":["prompt"]}}}}}},"\/console\/variables":{"get":{"summary":"Get variables","operationId":"consoleVariables","tags":["console"],"description":"Get all Environment Variables that are relevant for the console.","responses":{"200":{"description":"Console Variables","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/consoleVariables"}}}}},"x-appwrite":{"method":"variables","weight":327,"cookies":false,"type":"","deprecated":false,"demo":"console\/variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/console\/variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/databases":{"get":{"summary":"List databases","operationId":"databasesList","tags":["databases"],"description":"Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.","responses":{"200":{"description":"Databases List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/databaseList"}}}}},"x-appwrite":{"method":"list","weight":69,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create database","operationId":"databasesCreate","tags":["databases"],"description":"Create a new Database.\n","responses":{"201":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"create","weight":68,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"databaseId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<DATABASE_ID>"},"name":{"type":"string","description":"Database name. Max length: 128 chars.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","x-example":false}},"required":["databaseId","name"]}}}}}},"\/databases\/usage":{"get":{"summary":"Get databases usage stats","operationId":"databasesGetUsage","tags":["databases"],"description":"","responses":{"200":{"description":"UsageDatabases","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageDatabases"}}}}},"x-appwrite":{"method":"getUsage","weight":113,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"`Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/databases\/{databaseId}":{"get":{"summary":"Get database","operationId":"databasesGet","tags":["databases"],"description":"Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.","responses":{"200":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"get","weight":70,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}]},"put":{"summary":"Update database","operationId":"databasesUpdate","tags":["databases"],"description":"Update a database by its unique ID.","responses":{"200":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"update","weight":72,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Database name. Max length: 128 chars.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete database","operationId":"databasesDelete","tags":["databases"],"description":"Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":73,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}]}},"\/databases\/{databaseId}\/collections":{"get":{"summary":"List collections","operationId":"databasesListCollections","tags":["databases"],"description":"Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.","responses":{"200":{"description":"Collections List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collectionList"}}}}},"x-appwrite":{"method":"listCollections","weight":75,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collections.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"queries","description":"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: name, enabled, documentSecurity","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create collection","operationId":"databasesCreateCollection","tags":["databases"],"description":"Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"createCollection","weight":74,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"collectionId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<COLLECTION_ID>"},"name":{"type":"string","description":"Collection name. Max length: 128 chars.","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","x-example":false}},"required":["collectionId","name"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}":{"get":{"summary":"Get collection","operationId":"databasesGetCollection","tags":["databases"],"description":"Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.","responses":{"200":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"getCollection","weight":76,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}]},"put":{"summary":"Update collection","operationId":"databasesUpdateCollection","tags":["databases"],"description":"Update a collection by its unique ID.","responses":{"200":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"updateCollection","weight":78,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name. Max length: 128 chars.","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete collection","operationId":"databasesDeleteCollection","tags":["databases"],"description":"Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteCollection","weight":79,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes":{"get":{"summary":"List attributes","operationId":"databasesListAttributes","tags":["databases"],"description":"List attributes in the collection.","responses":{"200":{"description":"Attributes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeList"}}}}},"x-appwrite":{"method":"listAttributes","weight":90,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-attributes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"queries","description":"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: key, type, size, required, array, status, error","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean":{"post":{"summary":"Create boolean attribute","operationId":"databasesCreateBooleanAttribute","tags":["databases"],"description":"Create a boolean attribute.\n","responses":{"202":{"description":"AttributeBoolean","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeBoolean"}}}}},"x-appwrite":{"method":"createBooleanAttribute","weight":87,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}":{"patch":{"summary":"Update boolean attribute","operationId":"databasesUpdateBooleanAttribute","tags":["databases"],"description":"Update a boolean attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeBoolean","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeBoolean"}}}}},"x-appwrite":{"method":"updateBooleanAttribute","weight":99,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime":{"post":{"summary":"Create datetime attribute","operationId":"databasesCreateDatetimeAttribute","tags":["databases"],"description":"Create a date time attribute according to the ISO 8601 standard.","responses":{"202":{"description":"AttributeDatetime","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeDatetime"}}}}},"x-appwrite":{"method":"createDatetimeAttribute","weight":88,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}":{"patch":{"summary":"Update dateTime attribute","operationId":"databasesUpdateDatetimeAttribute","tags":["databases"],"description":"Update a date time attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeDatetime","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeDatetime"}}}}},"x-appwrite":{"method":"updateDatetimeAttribute","weight":100,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email":{"post":{"summary":"Create email attribute","operationId":"databasesCreateEmailAttribute","tags":["databases"],"description":"Create an email attribute.\n","responses":{"202":{"description":"AttributeEmail","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeEmail"}}}}},"x-appwrite":{"method":"createEmailAttribute","weight":81,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"email@example.com"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}":{"patch":{"summary":"Update email attribute","operationId":"databasesUpdateEmailAttribute","tags":["databases"],"description":"Update an email attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEmail","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeEmail"}}}}},"x-appwrite":{"method":"updateEmailAttribute","weight":93,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"email@example.com","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum":{"post":{"summary":"Create enum attribute","operationId":"databasesCreateEnumAttribute","tags":["databases"],"description":"Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n","responses":{"202":{"description":"AttributeEnum","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeEnum"}}}}},"x-appwrite":{"method":"createEnumAttribute","weight":82,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","elements","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}":{"patch":{"summary":"Update enum attribute","operationId":"databasesUpdateEnumAttribute","tags":["databases"],"description":"Update an enum attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEnum","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeEnum"}}}}},"x-appwrite":{"method":"updateEnumAttribute","weight":94,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>","x-nullable":true}},"required":["elements","required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float":{"post":{"summary":"Create float attribute","operationId":"databasesCreateFloatAttribute","tags":["databases"],"description":"Create a float attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeFloat","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeFloat"}}}}},"x-appwrite":{"method":"createFloatAttribute","weight":86,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float\/{key}":{"patch":{"summary":"Update float attribute","operationId":"databasesUpdateFloatAttribute","tags":["databases"],"description":"Update a float attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeFloat","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeFloat"}}}}},"x-appwrite":{"method":"updateFloatAttribute","weight":98,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer":{"post":{"summary":"Create integer attribute","operationId":"databasesCreateIntegerAttribute","tags":["databases"],"description":"Create an integer attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeInteger","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeInteger"}}}}},"x-appwrite":{"method":"createIntegerAttribute","weight":85,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer\/{key}":{"patch":{"summary":"Update integer attribute","operationId":"databasesUpdateIntegerAttribute","tags":["databases"],"description":"Update an integer attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeInteger","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeInteger"}}}}},"x-appwrite":{"method":"updateIntegerAttribute","weight":97,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip":{"post":{"summary":"Create IP address attribute","operationId":"databasesCreateIpAttribute","tags":["databases"],"description":"Create IP address attribute.\n","responses":{"202":{"description":"AttributeIP","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeIp"}}}}},"x-appwrite":{"method":"createIpAttribute","weight":83,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}":{"patch":{"summary":"Update IP address attribute","operationId":"databasesUpdateIpAttribute","tags":["databases"],"description":"Update an ip attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeIP","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeIp"}}}}},"x-appwrite":{"method":"updateIpAttribute","weight":95,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship":{"post":{"summary":"Create relationship attribute","operationId":"databasesCreateRelationshipAttribute","tags":["databases"],"description":"Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"202":{"description":"AttributeRelationship","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeRelationship"}}}}},"x-appwrite":{"method":"createRelationshipAttribute","weight":89,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"relatedCollectionId":{"type":"string","description":"Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","x-example":"<RELATED_COLLECTION_ID>"},"type":{"type":"string","description":"Relation type","x-example":"oneToOne","enum":["oneToOne","manyToOne","manyToMany","oneToMany"],"x-enum-name":"RelationshipType","x-enum-keys":[]},"twoWay":{"type":"boolean","description":"Is Two Way?","x-example":false},"key":{"type":"string","description":"Attribute Key.","x-example":null},"twoWayKey":{"type":"string","description":"Two Way Attribute Key.","x-example":null},"onDelete":{"type":"string","description":"Constraints option","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}},"required":["relatedCollectionId","type"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string":{"post":{"summary":"Create string attribute","operationId":"databasesCreateStringAttribute","tags":["databases"],"description":"Create a string attribute.\n","responses":{"202":{"description":"AttributeString","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeString"}}}}},"x-appwrite":{"method":"createStringAttribute","weight":80,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"size":{"type":"integer","description":"Attribute size for text attributes, in number of characters.","x-example":1},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false},"encrypt":{"type":"boolean","description":"Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.","x-example":false}},"required":["key","size","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}":{"patch":{"summary":"Update string attribute","operationId":"databasesUpdateStringAttribute","tags":["databases"],"description":"Update a string attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeString","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeString"}}}}},"x-appwrite":{"method":"updateStringAttribute","weight":92,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url":{"post":{"summary":"Create URL attribute","operationId":"databasesCreateUrlAttribute","tags":["databases"],"description":"Create a URL attribute.\n","responses":{"202":{"description":"AttributeURL","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeUrl"}}}}},"x-appwrite":{"method":"createUrlAttribute","weight":84,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"https:\/\/example.com"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}":{"patch":{"summary":"Update URL attribute","operationId":"databasesUpdateUrlAttribute","tags":["databases"],"description":"Update an url attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeURL","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeUrl"}}}}},"x-appwrite":{"method":"updateUrlAttribute","weight":96,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"https:\/\/example.com","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}":{"get":{"summary":"Get attribute","operationId":"databasesGetAttribute","tags":["databases"],"description":"Get attribute by ID.","responses":{"200":{"description":"AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]}}}}},"x-appwrite":{"method":"getAttribute","weight":91,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}]},"delete":{"summary":"Delete attribute","operationId":"databasesDeleteAttribute","tags":["databases"],"description":"Deletes an attribute.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteAttribute","weight":102,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship":{"patch":{"summary":"Update relationship attribute","operationId":"databasesUpdateRelationshipAttribute","tags":["databases"],"description":"Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"200":{"description":"AttributeRelationship","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeRelationship"}}}}},"x-appwrite":{"method":"updateRelationshipAttribute","weight":101,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"onDelete":{"type":"string","description":"Constraints option","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}}}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/documentList"}}}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":"<DOCUMENT_ID>"},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":"<DOCUMENT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":"<DOCUMENT_ID>"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs":{"get":{"summary":"List document logs","operationId":"databasesListDocumentLogs","tags":["databases"],"description":"Get the document activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listDocumentLogs","weight":110,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-document-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":"<DOCUMENT_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes":{"get":{"summary":"List indexes","operationId":"databasesListIndexes","tags":["databases"],"description":"List indexes in the collection.","responses":{"200":{"description":"Indexes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/indexList"}}}}},"x-appwrite":{"method":"listIndexes","weight":104,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-indexes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"queries","description":"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: key, type, status, attributes, error","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create index","operationId":"databasesCreateIndex","tags":["databases"],"description":"Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.","responses":{"202":{"description":"Index","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/index"}}}}},"x-appwrite":{"method":"createIndex","weight":103,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":null},"type":{"type":"string","description":"Index type.","x-example":"key","enum":["key","fulltext","unique"],"x-enum-name":"IndexType","x-enum-keys":[]},"attributes":{"type":"array","description":"Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}},"orders":{"type":"array","description":"Array of index orders. Maximum of 100 orders are allowed.","x-example":null,"items":{"type":"string"}}},"required":["key","type","attributes"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}":{"get":{"summary":"Get index","operationId":"databasesGetIndex","tags":["databases"],"description":"Get index by ID.","responses":{"200":{"description":"Index","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/index"}}}}},"x-appwrite":{"method":"getIndex","weight":105,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Index Key.","required":true,"schema":{"type":"string"},"in":"path"}]},"delete":{"summary":"Delete index","operationId":"databasesDeleteIndex","tags":["databases"],"description":"Delete an index.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIndex","weight":106,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Index Key.","required":true,"schema":{"type":"string"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/logs":{"get":{"summary":"List collection logs","operationId":"databasesListCollectionLogs","tags":["databases"],"description":"Get the collection activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listCollectionLogs","weight":77,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collection-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/usage":{"get":{"summary":"Get collection usage stats","operationId":"databasesGetCollectionUsage","tags":["databases"],"description":"","responses":{"200":{"description":"UsageCollection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageCollection"}}}}},"x-appwrite":{"method":"getCollectionUsage","weight":115,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}]}},"\/databases\/{databaseId}\/logs":{"get":{"summary":"List database logs","operationId":"databasesListLogs","tags":["databases"],"description":"Get the database activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":71,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/databases\/{databaseId}\/usage":{"get":{"summary":"Get database usage stats","operationId":"databasesGetDatabaseUsage","tags":["databases"],"description":"","responses":{"200":{"description":"UsageDatabase","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageDatabase"}}}}},"x-appwrite":{"method":"getDatabaseUsage","weight":114,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-database-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"range","description":"`Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/functions":{"get":{"summary":"List functions","operationId":"functionsList","tags":["functions"],"description":"Get a list of all the project's functions. You can use the query params to filter your results.","responses":{"200":{"description":"Functions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/functionList"}}}}},"x-appwrite":{"method":"list","weight":287,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create function","operationId":"functionsCreate","tags":["functions"],"description":"Create a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.","responses":{"201":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"create","weight":286,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"functionId":{"type":"string","description":"Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<FUNCTION_ID>"},"name":{"type":"string","description":"Function name. Max length: 128 chars.","x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","x-example":null},"timeout":{"type":"integer","description":"Function maximum execution time in seconds.","x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Control System) deployment.","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function.","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function.","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","x-example":"<PROVIDER_ROOT_DIRECTORY>"},"templateRepository":{"type":"string","description":"Repository name of the template.","x-example":"<TEMPLATE_REPOSITORY>"},"templateOwner":{"type":"string","description":"The name of the owner of the template.","x-example":"<TEMPLATE_OWNER>"},"templateRootDirectory":{"type":"string","description":"Path to function code in the template repo.","x-example":"<TEMPLATE_ROOT_DIRECTORY>"},"templateBranch":{"type":"string","description":"Production branch for the repo linked to the function template.","x-example":"<TEMPLATE_BRANCH>"}},"required":["functionId","name","runtime"]}}}}}},"\/functions\/runtimes":{"get":{"summary":"List runtimes","operationId":"functionsListRuntimes","tags":["functions"],"description":"Get a list of all runtimes that are currently active on your instance.","responses":{"200":{"description":"Runtimes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/runtimeList"}}}}},"x-appwrite":{"method":"listRuntimes","weight":288,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-runtimes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-runtimes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/functions\/usage":{"get":{"summary":"Get functions usage","operationId":"functionsGetUsage","tags":["functions"],"description":"","responses":{"200":{"description":"UsageFunctions","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageFunctions"}}}}},"x-appwrite":{"method":"getUsage","weight":291,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"FunctionUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/functions\/{functionId}":{"get":{"summary":"Get function","operationId":"functionsGet","tags":["functions"],"description":"Get a function by its unique ID.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"get","weight":289,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}]},"put":{"summary":"Update function","operationId":"functionsUpdate","tags":["functions"],"description":"Update function by its unique ID.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"update","weight":292,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Function name. Max length: 128 chars.","x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","x-example":null},"timeout":{"type":"integer","description":"Maximum execution time in seconds.","x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Controle System) deployment.","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","x-example":"<PROVIDER_ROOT_DIRECTORY>"}},"required":["name"]}}}}},"delete":{"summary":"Delete function","operationId":"functionsDelete","tags":["functions"],"description":"Delete a function by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":295,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/deployments":{"get":{"summary":"List deployments","operationId":"functionsListDeployments","tags":["functions"],"description":"Get a list of all the project's code deployments. You can use the query params to filter your results.","responses":{"200":{"description":"Deployments List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deploymentList"}}}}},"x-appwrite":{"method":"listDeployments","weight":297,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"queries","description":"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: size, buildId, activate, entrypoint, commands","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create deployment","operationId":"functionsCreateDeployment","tags":["functions"],"description":"Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.","responses":{"202":{"description":"Deployment","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deployment"}}}}},"x-appwrite":{"method":"createDeployment","weight":296,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":true,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"entrypoint":{"type":"string","description":"Entrypoint File.","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","x-example":"<COMMANDS>"},"code":{"type":"string","description":"Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.","x-example":null},"activate":{"type":"boolean","description":"Automatically activate the deployment when it is finished building.","x-example":false}},"required":["code","activate"]}}}}}},"\/functions\/{functionId}\/deployments\/{deploymentId}":{"get":{"summary":"Get deployment","operationId":"functionsGetDeployment","tags":["functions"],"description":"Get a code deployment by its unique ID.","responses":{"200":{"description":"Deployment","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deployment"}}}}},"x-appwrite":{"method":"getDeployment","weight":298,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]},"patch":{"summary":"Update function deployment","operationId":"functionsUpdateDeployment","tags":["functions"],"description":"Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"updateDeployment","weight":294,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]},"delete":{"summary":"Delete deployment","operationId":"functionsDeleteDeployment","tags":["functions"],"description":"Delete a code deployment by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDeployment","weight":299,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/build":{"post":{"summary":"Rebuild deployment","operationId":"functionsCreateBuild","tags":["functions"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createBuild","weight":300,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"buildId":{"type":"string","description":"Build unique ID.","x-example":"<BUILD_ID>"}}}}}}},"patch":{"summary":"Cancel deployment","operationId":"functionsUpdateDeploymentBuild","tags":["functions"],"description":"","responses":{"200":{"description":"Build","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/build"}}}}},"x-appwrite":{"method":"updateDeploymentBuild","weight":301,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/download":{"get":{"summary":"Download Deployment","operationId":"functionsDownloadDeployment","tags":["functions"],"description":"Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"downloadDeployment","weight":293,"cookies":false,"type":"location","deprecated":false,"demo":"functions\/download-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/download-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/executionList"}}}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"schema":{"type":"string","x-example":"<EXECUTION_ID>"},"in":"path"}]},"delete":{"summary":"Delete execution","operationId":"functionsDeleteExecution","tags":["functions"],"description":"Delete a function execution by its unique ID.\n","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteExecution","weight":305,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"schema":{"type":"string","x-example":"<EXECUTION_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/usage":{"get":{"summary":"Get function usage","operationId":"functionsGetFunctionUsage","tags":["functions"],"description":"","responses":{"200":{"description":"UsageFunction","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageFunction"}}}}},"x-appwrite":{"method":"getFunctionUsage","weight":290,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-function-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"FunctionUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/functions\/{functionId}\/variables":{"get":{"summary":"List variables","operationId":"functionsListVariables","tags":["functions"],"description":"Get a list of all variables of a specific function.","responses":{"200":{"description":"Variables List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variableList"}}}}},"x-appwrite":{"method":"listVariables","weight":307,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}]},"post":{"summary":"Create variable","operationId":"functionsCreateVariable","tags":["functions"],"description":"Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.","responses":{"201":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"createVariable","weight":306,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":"<VALUE>"}},"required":["key","value"]}}}}}},"\/functions\/{functionId}\/variables\/{variableId}":{"get":{"summary":"Get variable","operationId":"functionsGetVariable","tags":["functions"],"description":"Get a variable by its unique ID.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"getVariable","weight":308,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}]},"put":{"summary":"Update variable","operationId":"functionsUpdateVariable","tags":["functions"],"description":"Update variable by its unique ID.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"updateVariable","weight":309,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":"<VALUE>"}},"required":["key"]}}}}},"delete":{"summary":"Delete variable","operationId":"functionsDeleteVariable","tags":["functions"],"description":"Delete a variable by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":310,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/health":{"get":{"summary":"Get HTTP","operationId":"healthGet","tags":["health"],"description":"Check the Appwrite HTTP server is up and responsive.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"get","weight":124,"cookies":false,"type":"","deprecated":false,"demo":"health\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/anti-virus":{"get":{"summary":"Get antivirus","operationId":"healthGetAntivirus","tags":["health"],"description":"Check the Appwrite Antivirus server is up and connection is successful.","responses":{"200":{"description":"Health Antivirus","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthAntivirus"}}}}},"x-appwrite":{"method":"getAntivirus","weight":146,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-antivirus.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/cache":{"get":{"summary":"Get cache","operationId":"healthGetCache","tags":["health"],"description":"Check the Appwrite in-memory cache servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getCache","weight":127,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-cache.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/certificate":{"get":{"summary":"Get the SSL certificate for a domain","operationId":"healthGetCertificate","tags":["health"],"description":"Get the SSL certificate for a domain","responses":{"200":{"description":"Health Certificate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthCertificate"}}}}},"x-appwrite":{"method":"getCertificate","weight":133,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-certificate.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"domain","description":"string","required":false,"schema":{"type":"string"},"in":"query"}]}},"\/health\/db":{"get":{"summary":"Get DB","operationId":"healthGetDB","tags":["health"],"description":"Check the Appwrite database servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getDB","weight":126,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-d-b.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/pubsub":{"get":{"summary":"Get pubsub","operationId":"healthGetPubSub","tags":["health"],"description":"Check the Appwrite pub-sub servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getPubSub","weight":129,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-pub-sub.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue":{"get":{"summary":"Get queue","operationId":"healthGetQueue","tags":["health"],"description":"Check the Appwrite queue messaging servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getQueue","weight":128,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue\/builds":{"get":{"summary":"Get builds queue","operationId":"healthGetQueueBuilds","tags":["health"],"description":"Get the number of builds that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueBuilds","weight":135,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-builds.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/certificates":{"get":{"summary":"Get certificates queue","operationId":"healthGetQueueCertificates","tags":["health"],"description":"Get the number of certificates that are waiting to be issued against [Letsencrypt](https:\/\/letsencrypt.org\/) in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueCertificates","weight":134,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-certificates.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/databases":{"get":{"summary":"Get databases queue","operationId":"healthGetQueueDatabases","tags":["health"],"description":"Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueDatabases","weight":136,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-databases.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"Queue name for which to check the queue size","required":false,"schema":{"type":"string","x-example":"<NAME>","default":"database_db_main"},"in":"query"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/deletes":{"get":{"summary":"Get deletes queue","operationId":"healthGetQueueDeletes","tags":["health"],"description":"Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueDeletes","weight":137,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-deletes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/failed\/{name}":{"get":{"summary":"Get number of failed queue jobs","operationId":"healthGetFailedJobs","tags":["health"],"description":"Returns the amount of failed jobs in a given queue.\n","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getFailedJobs","weight":147,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-failed-jobs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"The name of the queue","required":true,"schema":{"type":"string","x-example":"v1-database","enum":["v1-database","v1-deletes","v1-audits","v1-mails","v1-functions","v1-usage","v1-usage-dump","v1-webhooks","v1-certificates","v1-builds","v1-messaging","v1-migrations"],"x-enum-name":null,"x-enum-keys":[]},"in":"path"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/functions":{"get":{"summary":"Get functions queue","operationId":"healthGetQueueFunctions","tags":["health"],"description":"Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueFunctions","weight":141,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-functions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/logs":{"get":{"summary":"Get logs queue","operationId":"healthGetQueueLogs","tags":["health"],"description":"Get the number of logs that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueLogs","weight":132,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/mails":{"get":{"summary":"Get mails queue","operationId":"healthGetQueueMails","tags":["health"],"description":"Get the number of mails that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMails","weight":138,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-mails.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/messaging":{"get":{"summary":"Get messaging queue","operationId":"healthGetQueueMessaging","tags":["health"],"description":"Get the number of messages that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMessaging","weight":139,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-messaging.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/migrations":{"get":{"summary":"Get migrations queue","operationId":"healthGetQueueMigrations","tags":["health"],"description":"Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMigrations","weight":140,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-migrations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/usage":{"get":{"summary":"Get usage queue","operationId":"healthGetQueueUsage","tags":["health"],"description":"Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueUsage","weight":142,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/usage-dump":{"get":{"summary":"Get usage dump queue","operationId":"healthGetQueueUsageDump","tags":["health"],"description":"Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueUsageDump","weight":143,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage-dump.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage-dump.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/webhooks":{"get":{"summary":"Get webhooks queue","operationId":"healthGetQueueWebhooks","tags":["health"],"description":"Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueWebhooks","weight":131,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/storage":{"get":{"summary":"Get storage","operationId":"healthGetStorage","tags":["health"],"description":"Check the Appwrite storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getStorage","weight":145,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/storage\/local":{"get":{"summary":"Get local storage","operationId":"healthGetStorageLocal","tags":["health"],"description":"Check the Appwrite local storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getStorageLocal","weight":144,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage-local.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/time":{"get":{"summary":"Get time","operationId":"healthGetTime","tags":["health"],"description":"Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https:\/\/en.wikipedia.org\/wiki\/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.","responses":{"200":{"description":"Health Time","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthTime"}}}}},"x-appwrite":{"method":"getTime","weight":130,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-time.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/locale"}}}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/localeCodeList"}}}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/continentList"}}}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/phoneList"}}}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/currencyList"}}}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/languageList"}}}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/messaging\/messages":{"get":{"summary":"List messages","operationId":"messagingListMessages","tags":["messaging"],"description":"Get a list of all messages from the current Appwrite project.","responses":{"200":{"description":"Message list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/messageList"}}}}},"x-appwrite":{"method":"listMessages","weight":385,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-messages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/messaging\/messages\/email":{"post":{"summary":"Create email","operationId":"messagingCreateEmail","tags":["messaging"],"description":"Create a new email message.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createEmail","weight":382,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<MESSAGE_ID>"},"subject":{"type":"string","description":"Email Subject.","x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","x-example":null,"items":{"type":"string"}},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","subject","content"]}}}}}},"\/messaging\/messages\/email\/{messageId}":{"patch":{"summary":"Update email","operationId":"messagingUpdateEmail","tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updateEmail","weight":389,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"subject":{"type":"string","description":"Email Subject.","x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","x-example":false},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","x-example":null,"items":{"type":"string"}},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":null,"items":{"type":"string"}}}}}}}}},"\/messaging\/messages\/push":{"post":{"summary":"Create push notification","operationId":"messagingCreatePush","tags":["messaging"],"description":"Create a new push notification.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createPush","weight":384,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<MESSAGE_ID>"},"title":{"type":"string","description":"Title for push notification.","x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","x-example":"<BODY>"},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"data":{"type":"object","description":"Additional Data for push notification.","x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web Platform.","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and IOS Platform.","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android Platform.","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android Platform.","x-example":"<TAG>"},"badge":{"type":"string","description":"Badge for push notification. Available only for IOS Platform.","x-example":"<BADGE>"},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","title","body"]}}}}}},"\/messaging\/messages\/push\/{messageId}":{"patch":{"summary":"Update push notification","operationId":"messagingUpdatePush","tags":["messaging"],"description":"Update a push notification by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updatePush","weight":391,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"title":{"type":"string","description":"Title for push notification.","x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","x-example":"<BODY>"},"data":{"type":"object","description":"Additional Data for push notification.","x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web platforms.","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and iOS platforms.","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android platforms.","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android platforms.","x-example":"<TAG>"},"badge":{"type":"integer","description":"Badge for push notification. Available only for iOS platforms.","x-example":null},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/messaging\/messages\/sms":{"post":{"summary":"Create SMS","operationId":"messagingCreateSms","tags":["messaging"],"description":"Create a new SMS message.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createSms","weight":383,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<MESSAGE_ID>"},"content":{"type":"string","description":"SMS Content.","x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","content"]}}}}}},"\/messaging\/messages\/sms\/{messageId}":{"patch":{"summary":"Update SMS","operationId":"messagingUpdateSms","tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updateSms","weight":390,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"content":{"type":"string","description":"Email Content.","x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/messaging\/messages\/{messageId}":{"get":{"summary":"Get message","operationId":"messagingGetMessage","tags":["messaging"],"description":"Get a message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"getMessage","weight":388,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-message.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}]},"delete":{"summary":"Delete message","operationId":"messagingDelete","tags":["messaging"],"description":"Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":392,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}]}},"\/messaging\/messages\/{messageId}\/logs":{"get":{"summary":"List message logs","operationId":"messagingListMessageLogs","tags":["messaging"],"description":"Get the message activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listMessageLogs","weight":386,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-message-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/messages\/{messageId}\/targets":{"get":{"summary":"List message targets","operationId":"messagingListTargets","tags":["messaging"],"description":"Get a list of the targets associated with a message.","responses":{"200":{"description":"Target list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/targetList"}}}}},"x-appwrite":{"method":"listTargets","weight":387,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"},{"name":"queries","description":"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, providerId, identifier, providerType","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/providers":{"get":{"summary":"List providers","operationId":"messagingListProviders","tags":["messaging"],"description":"Get a list of all providers from the current Appwrite project.","responses":{"200":{"description":"Provider list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/providerList"}}}}},"x-appwrite":{"method":"listProviders","weight":357,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-providers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, provider, type, enabled","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/messaging\/providers\/apns":{"post":{"summary":"Create APNS provider","operationId":"messagingCreateApnsProvider","tags":["messaging"],"description":"Create a new Apple Push Notification service provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createApnsProvider","weight":356,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"authKey":{"type":"string","description":"APNS authentication key.","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/apns\/{providerId}":{"patch":{"summary":"Update APNS provider","operationId":"messagingUpdateApnsProvider","tags":["messaging"],"description":"Update a Apple Push Notification service provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateApnsProvider","weight":369,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"authKey":{"type":"string","description":"APNS authentication key.","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","x-example":false}}}}}}}},"\/messaging\/providers\/fcm":{"post":{"summary":"Create FCM provider","operationId":"messagingCreateFcmProvider","tags":["messaging"],"description":"Create a new Firebase Cloud Messaging provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createFcmProvider","weight":355,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","x-example":"{}"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/fcm\/{providerId}":{"patch":{"summary":"Update FCM provider","operationId":"messagingUpdateFcmProvider","tags":["messaging"],"description":"Update a Firebase Cloud Messaging provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateFcmProvider","weight":368,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","x-example":"{}"}}}}}}}},"\/messaging\/providers\/mailgun":{"post":{"summary":"Create Mailgun provider","operationId":"messagingCreateMailgunProvider","tags":["messaging"],"description":"Create a new Mailgun provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createMailgunProvider","weight":347,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","x-example":false},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/mailgun\/{providerId}":{"patch":{"summary":"Update Mailgun provider","operationId":"messagingUpdateMailgunProvider","tags":["messaging"],"description":"Update a Mailgun provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateMailgunProvider","weight":360,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"<REPLY_TO_EMAIL>"}}}}}}}},"\/messaging\/providers\/msg91":{"post":{"summary":"Create Msg91 provider","operationId":"messagingCreateMsg91Provider","tags":["messaging"],"description":"Create a new MSG91 provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createMsg91Provider","weight":350,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"templateId":{"type":"string","description":"Msg91 template ID","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","x-example":"<AUTH_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/msg91\/{providerId}":{"patch":{"summary":"Update Msg91 provider","operationId":"messagingUpdateMsg91Provider","tags":["messaging"],"description":"Update a MSG91 provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateMsg91Provider","weight":363,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"templateId":{"type":"string","description":"Msg91 template ID.","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","x-example":"<AUTH_KEY>"}}}}}}}},"\/messaging\/providers\/sendgrid":{"post":{"summary":"Create Sendgrid provider","operationId":"messagingCreateSendgridProvider","tags":["messaging"],"description":"Create a new Sendgrid provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createSendgridProvider","weight":348,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Sendgrid API key.","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/sendgrid\/{providerId}":{"patch":{"summary":"Update Sendgrid provider","operationId":"messagingUpdateSendgridProvider","tags":["messaging"],"description":"Update a Sendgrid provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateSendgridProvider","weight":361,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"apiKey":{"type":"string","description":"Sendgrid API key.","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","x-example":"<REPLY_TO_EMAIL>"}}}}}}}},"\/messaging\/providers\/smtp":{"post":{"summary":"Create SMTP provider","operationId":"messagingCreateSmtpProvider","tags":["messaging"],"description":"Create a new SMTP provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createSmtpProvider","weight":349,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","x-example":"<HOST>"},"port":{"type":"integer","description":"The default SMTP server port.","x-example":1},"username":{"type":"string","description":"Authentication username.","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be omitted, 'ssl', or 'tls'","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name","host"]}}}}}},"\/messaging\/providers\/smtp\/{providerId}":{"patch":{"summary":"Update SMTP provider","operationId":"messagingUpdateSmtpProvider","tags":["messaging"],"description":"Update a SMTP provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateSmtpProvider","weight":362,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","x-example":"<HOST>"},"port":{"type":"integer","description":"SMTP port.","x-example":1},"username":{"type":"string","description":"Authentication username.","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be 'ssl' or 'tls'","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","x-example":"<REPLY_TO_EMAIL>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}}}}}}}},"\/messaging\/providers\/telesign":{"post":{"summary":"Create Telesign provider","operationId":"messagingCreateTelesignProvider","tags":["messaging"],"description":"Create a new Telesign provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTelesignProvider","weight":351,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"customerId":{"type":"string","description":"Telesign customer ID.","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/telesign\/{providerId}":{"patch":{"summary":"Update Telesign provider","operationId":"messagingUpdateTelesignProvider","tags":["messaging"],"description":"Update a Telesign provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTelesignProvider","weight":364,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"customerId":{"type":"string","description":"Telesign customer ID.","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/textmagic":{"post":{"summary":"Create Textmagic provider","operationId":"messagingCreateTextmagicProvider","tags":["messaging"],"description":"Create a new Textmagic provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTextmagicProvider","weight":352,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"username":{"type":"string","description":"Textmagic username.","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/textmagic\/{providerId}":{"patch":{"summary":"Update Textmagic provider","operationId":"messagingUpdateTextmagicProvider","tags":["messaging"],"description":"Update a Textmagic provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTextmagicProvider","weight":365,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"username":{"type":"string","description":"Textmagic username.","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/twilio":{"post":{"summary":"Create Twilio provider","operationId":"messagingCreateTwilioProvider","tags":["messaging"],"description":"Create a new Twilio provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTwilioProvider","weight":353,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"accountSid":{"type":"string","description":"Twilio account secret ID.","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","x-example":"<AUTH_TOKEN>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/twilio\/{providerId}":{"patch":{"summary":"Update Twilio provider","operationId":"messagingUpdateTwilioProvider","tags":["messaging"],"description":"Update a Twilio provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTwilioProvider","weight":366,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"accountSid":{"type":"string","description":"Twilio account secret ID.","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","x-example":"<AUTH_TOKEN>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/vonage":{"post":{"summary":"Create Vonage provider","operationId":"messagingCreateVonageProvider","tags":["messaging"],"description":"Create a new Vonage provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createVonageProvider","weight":354,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"apiKey":{"type":"string","description":"Vonage API key.","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","x-example":"<API_SECRET>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/vonage\/{providerId}":{"patch":{"summary":"Update Vonage provider","operationId":"messagingUpdateVonageProvider","tags":["messaging"],"description":"Update a Vonage provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateVonageProvider","weight":367,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"apiKey":{"type":"string","description":"Vonage API key.","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","x-example":"<API_SECRET>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/{providerId}":{"get":{"summary":"Get provider","operationId":"messagingGetProvider","tags":["messaging"],"description":"Get a provider by its unique ID.\n","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"getProvider","weight":359,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}]},"delete":{"summary":"Delete provider","operationId":"messagingDeleteProvider","tags":["messaging"],"description":"Delete a provider by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteProvider","weight":370,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}]}},"\/messaging\/providers\/{providerId}\/logs":{"get":{"summary":"List provider logs","operationId":"messagingListProviderLogs","tags":["messaging"],"description":"Get the provider activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listProviderLogs","weight":358,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-provider-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/subscribers\/{subscriberId}\/logs":{"get":{"summary":"List subscriber logs","operationId":"messagingListSubscriberLogs","tags":["messaging"],"description":"Get the subscriber activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listSubscriberLogs","weight":379,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscriber-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/topics":{"get":{"summary":"List topics","operationId":"messagingListTopics","tags":["messaging"],"description":"Get a list of all topics from the current Appwrite project.","responses":{"200":{"description":"Topic list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topicList"}}}}},"x-appwrite":{"method":"listTopics","weight":372,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topics.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, description, emailTotal, smsTotal, pushTotal","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create topic","operationId":"messagingCreateTopic","tags":["messaging"],"description":"Create a new topic.","responses":{"201":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"createTopic","weight":371,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topicId":{"type":"string","description":"Topic ID. Choose a custom Topic ID or a new Topic ID.","x-example":"<TOPIC_ID>"},"name":{"type":"string","description":"Topic Name.","x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}}},"required":["topicId","name"]}}}}}},"\/messaging\/topics\/{topicId}":{"get":{"summary":"Get topic","operationId":"messagingGetTopic","tags":["messaging"],"description":"Get a topic by its unique ID.\n","responses":{"200":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"getTopic","weight":374,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}]},"patch":{"summary":"Update topic","operationId":"messagingUpdateTopic","tags":["messaging"],"description":"Update a topic by its unique ID.\n","responses":{"200":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"updateTopic","weight":375,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Topic Name.","x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete topic","operationId":"messagingDeleteTopic","tags":["messaging"],"description":"Delete a topic by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTopic","weight":376,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}]}},"\/messaging\/topics\/{topicId}\/logs":{"get":{"summary":"List topic logs","operationId":"messagingListTopicLogs","tags":["messaging"],"description":"Get the topic activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listTopicLogs","weight":373,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topic-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"get":{"summary":"List subscribers","operationId":"messagingListSubscribers","tags":["messaging"],"description":"Get a list of all subscribers from the current Appwrite project.","responses":{"200":{"description":"Subscriber list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriberList"}}}}},"x-appwrite":{"method":"listSubscribers","weight":378,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscribers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"queries","description":"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: name, provider, type, enabled","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriber"}}}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}}}}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"get":{"summary":"Get subscriber","operationId":"messagingGetSubscriber","tags":["messaging"],"description":"Get a subscriber by its unique ID.\n","responses":{"200":{"description":"Subscriber","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriber"}}}}},"x-appwrite":{"method":"getSubscriber","weight":380,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"}]},"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"}]}},"\/migrations":{"get":{"summary":"List Migrations","operationId":"migrationsList","tags":["migrations"],"description":"","responses":{"200":{"description":"Migrations List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationList"}}}}},"x-appwrite":{"method":"list","weight":334,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/list-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, resources, statusCounters, resourceData, errors","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/migrations\/appwrite":{"post":{"summary":"Migrate Appwrite Data","operationId":"migrationsCreateAppwriteMigration","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"createAppwriteMigration","weight":329,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-appwrite-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","x-example":null,"items":{"type":"string"}},"endpoint":{"type":"string","description":"Source's Appwrite Endpoint","x-example":"https:\/\/example.com"},"projectId":{"type":"string","description":"Source's Project ID","x-example":"<PROJECT_ID>"},"apiKey":{"type":"string","description":"Source's API Key","x-example":"<API_KEY>"}},"required":["resources","endpoint","projectId","apiKey"]}}}}}},"\/migrations\/appwrite\/report":{"get":{"summary":"Generate a report on Appwrite Data","operationId":"migrationsGetAppwriteReport","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationReport"}}}}},"x-appwrite":{"method":"getAppwriteReport","weight":336,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-appwrite-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"schema":{"type":"array","items":{"type":"string"}},"in":"query"},{"name":"endpoint","description":"Source's Appwrite Endpoint","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"},{"name":"projectID","description":"Source's Project ID","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"query"},{"name":"key","description":"Source's API Key","required":true,"schema":{"type":"string","x-example":"<KEY>"},"in":"query"}]}},"\/migrations\/firebase":{"post":{"summary":"Migrate Firebase Data (Service Account)","operationId":"migrationsCreateFirebaseMigration","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"createFirebaseMigration","weight":331,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-firebase-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","x-example":null,"items":{"type":"string"}},"serviceAccount":{"type":"string","description":"JSON of the Firebase service account credentials","x-example":"<SERVICE_ACCOUNT>"}},"required":["resources","serviceAccount"]}}}}}},"\/migrations\/firebase\/deauthorize":{"get":{"summary":"Revoke Appwrite's authorization to access Firebase Projects","operationId":"migrationsDeleteFirebaseAuth","tags":["migrations"],"description":"","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"deleteFirebaseAuth","weight":342,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/delete-firebase-auth.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/migrations\/firebase\/oauth":{"post":{"summary":"Migrate Firebase Data (OAuth)","operationId":"migrationsCreateFirebaseOAuthMigration","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"createFirebaseOAuthMigration","weight":330,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-firebase-o-auth-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","x-example":null,"items":{"type":"string"}},"projectId":{"type":"string","description":"Project ID of the Firebase Project","x-example":"<PROJECT_ID>"}},"required":["resources","projectId"]}}}}}},"\/migrations\/firebase\/projects":{"get":{"summary":"List Firebase Projects","operationId":"migrationsListFirebaseProjects","tags":["migrations"],"description":"","responses":{"200":{"description":"Migrations Firebase Projects List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/firebaseProjectList"}}}}},"x-appwrite":{"method":"listFirebaseProjects","weight":341,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/list-firebase-projects.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/migrations\/firebase\/report":{"get":{"summary":"Generate a report on Firebase Data","operationId":"migrationsGetFirebaseReport","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationReport"}}}}},"x-appwrite":{"method":"getFirebaseReport","weight":337,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-firebase-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"schema":{"type":"array","items":{"type":"string"}},"in":"query"},{"name":"serviceAccount","description":"JSON of the Firebase service account credentials","required":true,"schema":{"type":"string","x-example":"<SERVICE_ACCOUNT>"},"in":"query"}]}},"\/migrations\/firebase\/report\/oauth":{"get":{"summary":"Generate a report on Firebase Data using OAuth","operationId":"migrationsGetFirebaseReportOAuth","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationReport"}}}}},"x-appwrite":{"method":"getFirebaseReportOAuth","weight":338,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-firebase-report-o-auth.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"schema":{"type":"array","items":{"type":"string"}},"in":"query"},{"name":"projectId","description":"Project ID","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"query"}]}},"\/migrations\/nhost":{"post":{"summary":"Migrate NHost Data","operationId":"migrationsCreateNHostMigration","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"createNHostMigration","weight":333,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-n-host-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","x-example":null,"items":{"type":"string"}},"subdomain":{"type":"string","description":"Source's Subdomain","x-example":"<SUBDOMAIN>"},"region":{"type":"string","description":"Source's Region","x-example":"<REGION>"},"adminSecret":{"type":"string","description":"Source's Admin Secret","x-example":"<ADMIN_SECRET>"},"database":{"type":"string","description":"Source's Database Name","x-example":"<DATABASE>"},"username":{"type":"string","description":"Source's Database Username","x-example":"<USERNAME>"},"password":{"type":"string","description":"Source's Database Password","x-example":"<PASSWORD>"},"port":{"type":"integer","description":"Source's Database Port","x-example":null}},"required":["resources","subdomain","region","adminSecret","database","username","password"]}}}}}},"\/migrations\/nhost\/report":{"get":{"summary":"Generate a report on NHost Data","operationId":"migrationsGetNHostReport","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationReport"}}}}},"x-appwrite":{"method":"getNHostReport","weight":344,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-n-host-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate.","required":true,"schema":{"type":"array","items":{"type":"string"}},"in":"query"},{"name":"subdomain","description":"Source's Subdomain.","required":true,"schema":{"type":"string","x-example":"<SUBDOMAIN>"},"in":"query"},{"name":"region","description":"Source's Region.","required":true,"schema":{"type":"string","x-example":"<REGION>"},"in":"query"},{"name":"adminSecret","description":"Source's Admin Secret.","required":true,"schema":{"type":"string","x-example":"<ADMIN_SECRET>"},"in":"query"},{"name":"database","description":"Source's Database Name.","required":true,"schema":{"type":"string","x-example":"<DATABASE>"},"in":"query"},{"name":"username","description":"Source's Database Username.","required":true,"schema":{"type":"string","x-example":"<USERNAME>"},"in":"query"},{"name":"password","description":"Source's Database Password.","required":true,"schema":{"type":"string","x-example":"<PASSWORD>"},"in":"query"},{"name":"port","description":"Source's Database Port.","required":false,"schema":{"type":"integer","format":"int32","default":5432},"in":"query"}]}},"\/migrations\/supabase":{"post":{"summary":"Migrate Supabase Data","operationId":"migrationsCreateSupabaseMigration","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"createSupabaseMigration","weight":332,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-supabase-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","x-example":null,"items":{"type":"string"}},"endpoint":{"type":"string","description":"Source's Supabase Endpoint","x-example":"https:\/\/example.com"},"apiKey":{"type":"string","description":"Source's API Key","x-example":"<API_KEY>"},"databaseHost":{"type":"string","description":"Source's Database Host","x-example":"<DATABASE_HOST>"},"username":{"type":"string","description":"Source's Database Username","x-example":"<USERNAME>"},"password":{"type":"string","description":"Source's Database Password","x-example":"<PASSWORD>"},"port":{"type":"integer","description":"Source's Database Port","x-example":null}},"required":["resources","endpoint","apiKey","databaseHost","username","password"]}}}}}},"\/migrations\/supabase\/report":{"get":{"summary":"Generate a report on Supabase Data","operationId":"migrationsGetSupabaseReport","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migrationReport"}}}}},"x-appwrite":{"method":"getSupabaseReport","weight":343,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-supabase-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"schema":{"type":"array","items":{"type":"string"}},"in":"query"},{"name":"endpoint","description":"Source's Supabase Endpoint.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"},{"name":"apiKey","description":"Source's API Key.","required":true,"schema":{"type":"string","x-example":"<API_KEY>"},"in":"query"},{"name":"databaseHost","description":"Source's Database Host.","required":true,"schema":{"type":"string","x-example":"<DATABASE_HOST>"},"in":"query"},{"name":"username","description":"Source's Database Username.","required":true,"schema":{"type":"string","x-example":"<USERNAME>"},"in":"query"},{"name":"password","description":"Source's Database Password.","required":true,"schema":{"type":"string","x-example":"<PASSWORD>"},"in":"query"},{"name":"port","description":"Source's Database Port.","required":false,"schema":{"type":"integer","format":"int32","default":5432},"in":"query"}]}},"\/migrations\/{migrationId}":{"get":{"summary":"Get Migration","operationId":"migrationsGet","tags":["migrations"],"description":"","responses":{"200":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"get","weight":335,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/get-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration unique ID.","required":true,"schema":{"type":"string","x-example":"<MIGRATION_ID>"},"in":"path"}]},"patch":{"summary":"Retry Migration","operationId":"migrationsRetry","tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/migration"}}}}},"x-appwrite":{"method":"retry","weight":345,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/retry.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/retry-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration unique ID.","required":true,"schema":{"type":"string","x-example":"<MIGRATION_ID>"},"in":"path"}]},"delete":{"summary":"Delete Migration","operationId":"migrationsDelete","tags":["migrations"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":346,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/delete-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration ID.","required":true,"schema":{"type":"string","x-example":"<MIGRATION_ID>"},"in":"path"}]}},"\/project\/usage":{"get":{"summary":"Get project usage stats","operationId":"projectGetUsage","tags":["project"],"description":"","responses":{"200":{"description":"UsageProject","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageProject"}}}}},"x-appwrite":{"method":"getUsage","weight":194,"cookies":false,"type":"","deprecated":false,"demo":"project\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"startDate","description":"Starting date for the usage","required":true,"schema":{"type":"string"},"in":"query"},{"name":"endDate","description":"End date for the usage","required":true,"schema":{"type":"string"},"in":"query"},{"name":"period","description":"Period used","required":false,"schema":{"type":"string","x-example":"1h","enum":["1h","1d"],"x-enum-name":"ProjectUsageRange","x-enum-keys":["One Hour","One Day"],"default":"1d"},"in":"query"}]}},"\/project\/variables":{"get":{"summary":"List Variables","operationId":"projectListVariables","tags":["project"],"description":"Get a list of all project variables. These variables will be accessible in all Appwrite Functions at runtime.","responses":{"200":{"description":"Variables List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variableList"}}}}},"x-appwrite":{"method":"listVariables","weight":196,"cookies":false,"type":"","deprecated":false,"demo":"project\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]},"post":{"summary":"Create Variable","operationId":"projectCreateVariable","tags":["project"],"description":"Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.","responses":{"201":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"createVariable","weight":195,"cookies":false,"type":"","deprecated":false,"demo":"project\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":"<VALUE>"}},"required":["key","value"]}}}}}},"\/project\/variables\/{variableId}":{"get":{"summary":"Get Variable","operationId":"projectGetVariable","tags":["project"],"description":"Get a project variable by its unique ID.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"getVariable","weight":197,"cookies":false,"type":"","deprecated":false,"demo":"project\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}]},"put":{"summary":"Update Variable","operationId":"projectUpdateVariable","tags":["project"],"description":"Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"updateVariable","weight":198,"cookies":false,"type":"","deprecated":false,"demo":"project\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":"<VALUE>"}},"required":["key"]}}}}},"delete":{"summary":"Delete Variable","operationId":"projectDeleteVariable","tags":["project"],"description":"Delete a project variable by its unique ID. ","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":199,"cookies":false,"type":"","deprecated":false,"demo":"project\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}]}},"\/projects":{"get":{"summary":"List projects","operationId":"projectsList","tags":["projects"],"description":"","responses":{"200":{"description":"Projects List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/projectList"}}}}},"x-appwrite":{"method":"list","weight":150,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"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: name, teamId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create project","operationId":"projectsCreate","tags":["projects"],"description":"","responses":{"201":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"create","weight":149,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"projectId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.","x-example":null},"name":{"type":"string","description":"Project name. Max length: 128 chars.","x-example":"<NAME>"},"teamId":{"type":"string","description":"Team unique ID.","x-example":"<TEAM_ID>"},"region":{"type":"string","description":"Project Region.","x-example":"default","enum":["default","fra"],"x-enum-name":null,"x-enum-keys":[]},"description":{"type":"string","description":"Project description. Max length: 256 chars.","x-example":"<DESCRIPTION>"},"logo":{"type":"string","description":"Project logo.","x-example":"<LOGO>"},"url":{"type":"string","description":"Project URL.","x-example":"https:\/\/example.com"},"legalName":{"type":"string","description":"Project legal Name. Max length: 256 chars.","x-example":"<LEGAL_NAME>"},"legalCountry":{"type":"string","description":"Project legal Country. Max length: 256 chars.","x-example":"<LEGAL_COUNTRY>"},"legalState":{"type":"string","description":"Project legal State. Max length: 256 chars.","x-example":"<LEGAL_STATE>"},"legalCity":{"type":"string","description":"Project legal City. Max length: 256 chars.","x-example":"<LEGAL_CITY>"},"legalAddress":{"type":"string","description":"Project legal Address. Max length: 256 chars.","x-example":"<LEGAL_ADDRESS>"},"legalTaxId":{"type":"string","description":"Project legal Tax ID. Max length: 256 chars.","x-example":"<LEGAL_TAX_ID>"}},"required":["projectId","name","teamId"]}}}}}},"\/projects\/{projectId}":{"get":{"summary":"Get project","operationId":"projectsGet","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"get","weight":151,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}]},"patch":{"summary":"Update project","operationId":"projectsUpdate","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"update","weight":152,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Project name. Max length: 128 chars.","x-example":"<NAME>"},"description":{"type":"string","description":"Project description. Max length: 256 chars.","x-example":"<DESCRIPTION>"},"logo":{"type":"string","description":"Project logo.","x-example":"<LOGO>"},"url":{"type":"string","description":"Project URL.","x-example":"https:\/\/example.com"},"legalName":{"type":"string","description":"Project legal name. Max length: 256 chars.","x-example":"<LEGAL_NAME>"},"legalCountry":{"type":"string","description":"Project legal country. Max length: 256 chars.","x-example":"<LEGAL_COUNTRY>"},"legalState":{"type":"string","description":"Project legal state. Max length: 256 chars.","x-example":"<LEGAL_STATE>"},"legalCity":{"type":"string","description":"Project legal city. Max length: 256 chars.","x-example":"<LEGAL_CITY>"},"legalAddress":{"type":"string","description":"Project legal address. Max length: 256 chars.","x-example":"<LEGAL_ADDRESS>"},"legalTaxId":{"type":"string","description":"Project legal tax ID. Max length: 256 chars.","x-example":"<LEGAL_TAX_ID>"}},"required":["name"]}}}}},"delete":{"summary":"Delete project","operationId":"projectsDelete","tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":168,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}]}},"\/projects\/{projectId}\/api":{"patch":{"summary":"Update API status","operationId":"projectsUpdateApiStatus","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateApiStatus","weight":156,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-api-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"api":{"type":"string","description":"API name.","x-example":"rest","enum":["rest","graphql","realtime"],"x-enum-name":null,"x-enum-keys":[]},"status":{"type":"boolean","description":"API status.","x-example":false}},"required":["api","status"]}}}}}},"\/projects\/{projectId}\/api\/all":{"patch":{"summary":"Update all API status","operationId":"projectsUpdateApiStatusAll","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateApiStatusAll","weight":157,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-api-status-all.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"API status.","x-example":false}},"required":["status"]}}}}}},"\/projects\/{projectId}\/auth\/duration":{"patch":{"summary":"Update project authentication duration","operationId":"projectsUpdateAuthDuration","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthDuration","weight":161,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-duration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"duration":{"type":"integer","description":"Project session length in seconds. Max length: 31536000 seconds.","x-example":0}},"required":["duration"]}}}}}},"\/projects\/{projectId}\/auth\/limit":{"patch":{"summary":"Update project users limit","operationId":"projectsUpdateAuthLimit","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthLimit","weight":160,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-limit.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of users allowed in this project. Use 0 for unlimited.","x-example":0}},"required":["limit"]}}}}}},"\/projects\/{projectId}\/auth\/max-sessions":{"patch":{"summary":"Update project user sessions limit","operationId":"projectsUpdateAuthSessionsLimit","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthSessionsLimit","weight":166,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-sessions-limit.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10","x-example":1}},"required":["limit"]}}}}}},"\/projects\/{projectId}\/auth\/mock-numbers":{"patch":{"summary":"Update the mock numbers for the project","operationId":"projectsUpdateMockNumbers","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateMockNumbers","weight":167,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-mock-numbers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"numbers":{"type":"array","description":"An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.","x-example":null,"items":{"type":"object"}}},"required":["numbers"]}}}}}},"\/projects\/{projectId}\/auth\/password-dictionary":{"patch":{"summary":"Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password","operationId":"projectsUpdateAuthPasswordDictionary","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthPasswordDictionary","weight":164,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-password-dictionary.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Set whether or not to enable checking user's password against most commonly used passwords. Default is false.","x-example":false}},"required":["enabled"]}}}}}},"\/projects\/{projectId}\/auth\/password-history":{"patch":{"summary":"Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.","operationId":"projectsUpdateAuthPasswordHistory","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthPasswordHistory","weight":163,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-password-history.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0","x-example":0}},"required":["limit"]}}}}}},"\/projects\/{projectId}\/auth\/personal-data":{"patch":{"summary":"Enable or disable checking user passwords for similarity with their personal data.","operationId":"projectsUpdatePersonalDataCheck","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updatePersonalDataCheck","weight":165,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-personal-data-check.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Set whether or not to check a password for similarity with personal data. Default is false.","x-example":false}},"required":["enabled"]}}}}}},"\/projects\/{projectId}\/auth\/session-alerts":{"patch":{"summary":"Update project sessions emails","operationId":"projectsUpdateSessionAlerts","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateSessionAlerts","weight":159,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-session-alerts.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"alerts":{"type":"boolean","description":"Set to true to enable session emails.","x-example":false}},"required":["alerts"]}}}}}},"\/projects\/{projectId}\/auth\/{method}":{"patch":{"summary":"Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.","operationId":"projectsUpdateAuthStatus","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateAuthStatus","weight":162,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"method","description":"Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone","required":true,"schema":{"type":"string","x-example":"email-password","enum":["email-password","magic-url","email-otp","anonymous","invites","jwt","phone"],"x-enum-name":"AuthMethod","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"Set the status of this auth method.","x-example":false}},"required":["status"]}}}}}},"\/projects\/{projectId}\/jwts":{"post":{"summary":"Create JWT","operationId":"projectsCreateJWT","tags":["projects"],"description":"","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":180,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"scopes":{"type":"array","description":"List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","x-example":0}},"required":["scopes"]}}}}}},"\/projects\/{projectId}\/keys":{"get":{"summary":"List keys","operationId":"projectsListKeys","tags":["projects"],"description":"","responses":{"200":{"description":"API Keys List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/keyList"}}}}},"x-appwrite":{"method":"listKeys","weight":176,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-keys.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}]},"post":{"summary":"Create key","operationId":"projectsCreateKey","tags":["projects"],"description":"","responses":{"201":{"description":"Key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/key"}}}}},"x-appwrite":{"method":"createKey","weight":175,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Key name. Max length: 128 chars.","x-example":"<NAME>"},"scopes":{"type":"array","description":"Key scopes list. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"expire":{"type":"string","description":"Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.","x-example":null}},"required":["name","scopes"]}}}}}},"\/projects\/{projectId}\/keys\/{keyId}":{"get":{"summary":"Get key","operationId":"projectsGetKey","tags":["projects"],"description":"","responses":{"200":{"description":"Key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/key"}}}}},"x-appwrite":{"method":"getKey","weight":177,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"schema":{"type":"string","x-example":"<KEY_ID>"},"in":"path"}]},"put":{"summary":"Update key","operationId":"projectsUpdateKey","tags":["projects"],"description":"","responses":{"200":{"description":"Key","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/key"}}}}},"x-appwrite":{"method":"updateKey","weight":178,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"schema":{"type":"string","x-example":"<KEY_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Key name. Max length: 128 chars.","x-example":"<NAME>"},"scopes":{"type":"array","description":"Key scopes list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"expire":{"type":"string","description":"Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.","x-example":null}},"required":["name","scopes"]}}}}},"delete":{"summary":"Delete key","operationId":"projectsDeleteKey","tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteKey","weight":179,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"schema":{"type":"string","x-example":"<KEY_ID>"},"in":"path"}]}},"\/projects\/{projectId}\/oauth2":{"patch":{"summary":"Update project OAuth2","operationId":"projectsUpdateOAuth2","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateOAuth2","weight":158,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-o-auth2.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"provider":{"type":"string","description":"Provider Name","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"appId":{"type":"string","description":"Provider app ID. Max length: 256 chars.","x-example":"<APP_ID>"},"secret":{"type":"string","description":"Provider secret key. Max length: 512 chars.","x-example":"<SECRET>"},"enabled":{"type":"boolean","description":"Provider status. Set to 'false' to disable new session creation.","x-example":false}},"required":["provider"]}}}}}},"\/projects\/{projectId}\/platforms":{"get":{"summary":"List platforms","operationId":"projectsListPlatforms","tags":["projects"],"description":"","responses":{"200":{"description":"Platforms List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/platformList"}}}}},"x-appwrite":{"method":"listPlatforms","weight":182,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-platforms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}]},"post":{"summary":"Create platform","operationId":"projectsCreatePlatform","tags":["projects"],"description":"","responses":{"201":{"description":"Platform","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/platform"}}}}},"x-appwrite":{"method":"createPlatform","weight":181,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Platform type.","x-example":"web","enum":["web","flutter-web","flutter-ios","flutter-android","flutter-linux","flutter-macos","flutter-windows","apple-ios","apple-macos","apple-watchos","apple-tvos","android","unity"],"x-enum-name":"PlatformType","x-enum-keys":[]},"name":{"type":"string","description":"Platform name. Max length: 128 chars.","x-example":"<NAME>"},"key":{"type":"string","description":"Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.","x-example":"<KEY>"},"store":{"type":"string","description":"App store or Google Play store ID. Max length: 256 chars.","x-example":"<STORE>"},"hostname":{"type":"string","description":"Platform client hostname. Max length: 256 chars.","x-example":null}},"required":["type","name"]}}}}}},"\/projects\/{projectId}\/platforms\/{platformId}":{"get":{"summary":"Get platform","operationId":"projectsGetPlatform","tags":["projects"],"description":"","responses":{"200":{"description":"Platform","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/platform"}}}}},"x-appwrite":{"method":"getPlatform","weight":183,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"schema":{"type":"string","x-example":"<PLATFORM_ID>"},"in":"path"}]},"put":{"summary":"Update platform","operationId":"projectsUpdatePlatform","tags":["projects"],"description":"","responses":{"200":{"description":"Platform","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/platform"}}}}},"x-appwrite":{"method":"updatePlatform","weight":184,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"schema":{"type":"string","x-example":"<PLATFORM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Platform name. Max length: 128 chars.","x-example":"<NAME>"},"key":{"type":"string","description":"Package name for android or bundle ID for iOS. Max length: 256 chars.","x-example":"<KEY>"},"store":{"type":"string","description":"App store or Google Play store ID. Max length: 256 chars.","x-example":"<STORE>"},"hostname":{"type":"string","description":"Platform client URL. Max length: 256 chars.","x-example":null}},"required":["name"]}}}}},"delete":{"summary":"Delete platform","operationId":"projectsDeletePlatform","tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deletePlatform","weight":185,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"schema":{"type":"string","x-example":"<PLATFORM_ID>"},"in":"path"}]}},"\/projects\/{projectId}\/service":{"patch":{"summary":"Update service status","operationId":"projectsUpdateServiceStatus","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateServiceStatus","weight":154,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-service-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"service":{"type":"string","description":"Service name.","x-example":"account","enum":["account","avatars","databases","locale","health","storage","teams","users","functions","graphql","messaging"],"x-enum-name":"ApiService","x-enum-keys":[]},"status":{"type":"boolean","description":"Service status.","x-example":false}},"required":["service","status"]}}}}}},"\/projects\/{projectId}\/service\/all":{"patch":{"summary":"Update all service status","operationId":"projectsUpdateServiceStatusAll","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateServiceStatusAll","weight":155,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-service-status-all.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"Service status.","x-example":false}},"required":["status"]}}}}}},"\/projects\/{projectId}\/smtp":{"patch":{"summary":"Update SMTP","operationId":"projectsUpdateSmtp","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateSmtp","weight":186,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-smtp.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable custom SMTP service","x-example":false},"senderName":{"type":"string","description":"Name of the email sender","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","x-example":"email@example.com"},"host":{"type":"string","description":"SMTP server host name","x-example":null},"port":{"type":"integer","description":"SMTP server port","x-example":null},"username":{"type":"string","description":"SMTP server username","x-example":"<USERNAME>"},"password":{"type":"string","description":"SMTP server password","x-example":"<PASSWORD>"},"secure":{"type":"string","description":"Does SMTP server use secure connection","x-example":"tls","enum":["tls","ssl"],"x-enum-name":"SMTPSecure","x-enum-keys":[]}},"required":["enabled"]}}}}}},"\/projects\/{projectId}\/smtp\/tests":{"post":{"summary":"Create SMTP test","operationId":"projectsCreateSmtpTest","tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createSmtpTest","weight":187,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-smtp-test.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"emails":{"type":"array","description":"Array of emails to send test email to. Maximum of 10 emails are allowed.","x-example":null,"items":{"type":"string"}},"senderName":{"type":"string","description":"Name of the email sender","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","x-example":"email@example.com"},"host":{"type":"string","description":"SMTP server host name","x-example":null},"port":{"type":"integer","description":"SMTP server port","x-example":null},"username":{"type":"string","description":"SMTP server username","x-example":"<USERNAME>"},"password":{"type":"string","description":"SMTP server password","x-example":"<PASSWORD>"},"secure":{"type":"string","description":"Does SMTP server use secure connection","x-example":"tls","enum":["tls"],"x-enum-name":"SMTPSecure","x-enum-keys":[]}},"required":["emails","senderName","senderEmail","host"]}}}}}},"\/projects\/{projectId}\/team":{"patch":{"summary":"Update project team","operationId":"projectsUpdateTeam","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateTeam","weight":153,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-team.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID of the team to transfer project to.","x-example":"<TEAM_ID>"}},"required":["teamId"]}}}}}},"\/projects\/{projectId}\/templates\/email\/{type}\/{locale}":{"get":{"summary":"Get custom email template","operationId":"projectsGetEmailTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"EmailTemplate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/emailTemplate"}}}}},"x-appwrite":{"method":"getEmailTemplate","weight":189,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[]},"in":"path"}]},"patch":{"summary":"Update custom email templates","operationId":"projectsUpdateEmailTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"Project","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/project"}}}}},"x-appwrite":{"method":"updateEmailTemplate","weight":191,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"subject":{"type":"string","description":"Email Subject","x-example":"<SUBJECT>"},"message":{"type":"string","description":"Template message","x-example":"<MESSAGE>"},"senderName":{"type":"string","description":"Name of the email sender","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","x-example":"email@example.com"}},"required":["subject","message"]}}}}},"delete":{"summary":"Reset custom email template","operationId":"projectsDeleteEmailTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"EmailTemplate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/emailTemplate"}}}}},"x-appwrite":{"method":"deleteEmailTemplate","weight":193,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[]},"in":"path"}]}},"\/projects\/{projectId}\/templates\/sms\/{type}\/{locale}":{"get":{"summary":"Get custom SMS template","operationId":"projectsGetSmsTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/smsTemplate"}}}}},"x-appwrite":{"method":"getSmsTemplate","weight":188,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[]},"in":"path"}]},"patch":{"summary":"Update custom SMS template","operationId":"projectsUpdateSmsTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/smsTemplate"}}}}},"x-appwrite":{"method":"updateSmsTemplate","weight":190,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Template message","x-example":"<MESSAGE>"}},"required":["message"]}}}}},"delete":{"summary":"Reset custom SMS template","operationId":"projectsDeleteSmsTemplate","tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/smsTemplate"}}}}},"x-appwrite":{"method":"deleteSmsTemplate","weight":192,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"type","description":"Template type","required":true,"schema":{"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[]},"in":"path"},{"name":"locale","description":"Template locale","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[]},"in":"path"}]}},"\/projects\/{projectId}\/webhooks":{"get":{"summary":"List webhooks","operationId":"projectsListWebhooks","tags":["projects"],"description":"","responses":{"200":{"description":"Webhooks List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/webhookList"}}}}},"x-appwrite":{"method":"listWebhooks","weight":170,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}]},"post":{"summary":"Create webhook","operationId":"projectsCreateWebhook","tags":["projects"],"description":"","responses":{"201":{"description":"Webhook","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/webhook"}}}}},"x-appwrite":{"method":"createWebhook","weight":169,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Webhook name. Max length: 128 chars.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Enable or disable a webhook.","x-example":false},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"Webhook URL.","x-example":null},"security":{"type":"boolean","description":"Certificate verification, false for disabled or true for enabled.","x-example":false},"httpUser":{"type":"string","description":"Webhook HTTP user. Max length: 256 chars.","x-example":"<HTTP_USER>"},"httpPass":{"type":"string","description":"Webhook HTTP password. Max length: 256 chars.","x-example":"<HTTP_PASS>"}},"required":["name","events","url","security"]}}}}}},"\/projects\/{projectId}\/webhooks\/{webhookId}":{"get":{"summary":"Get webhook","operationId":"projectsGetWebhook","tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/webhook"}}}}},"x-appwrite":{"method":"getWebhook","weight":171,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"schema":{"type":"string","x-example":"<WEBHOOK_ID>"},"in":"path"}]},"put":{"summary":"Update webhook","operationId":"projectsUpdateWebhook","tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/webhook"}}}}},"x-appwrite":{"method":"updateWebhook","weight":172,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"schema":{"type":"string","x-example":"<WEBHOOK_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Webhook name. Max length: 128 chars.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Enable or disable a webhook.","x-example":false},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"Webhook URL.","x-example":null},"security":{"type":"boolean","description":"Certificate verification, false for disabled or true for enabled.","x-example":false},"httpUser":{"type":"string","description":"Webhook HTTP user. Max length: 256 chars.","x-example":"<HTTP_USER>"},"httpPass":{"type":"string","description":"Webhook HTTP password. Max length: 256 chars.","x-example":"<HTTP_PASS>"}},"required":["name","events","url","security"]}}}}},"delete":{"summary":"Delete webhook","operationId":"projectsDeleteWebhook","tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteWebhook","weight":174,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"schema":{"type":"string","x-example":"<WEBHOOK_ID>"},"in":"path"}]}},"\/projects\/{projectId}\/webhooks\/{webhookId}\/signature":{"patch":{"summary":"Update webhook signature key","operationId":"projectsUpdateWebhookSignature","tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/webhook"}}}}},"x-appwrite":{"method":"updateWebhookSignature","weight":173,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-webhook-signature.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"schema":{"type":"string","x-example":"<PROJECT_ID>"},"in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"schema":{"type":"string","x-example":"<WEBHOOK_ID>"},"in":"path"}]}},"\/proxy\/rules":{"get":{"summary":"List Rules","operationId":"proxyListRules","tags":["proxy"],"description":"Get a list of all the proxy rules. You can use the query params to filter your results.","responses":{"200":{"description":"Rule List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/proxyRuleList"}}}}},"x-appwrite":{"method":"listRules","weight":312,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/list-rules.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/list-rules.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, resourceType, resourceId, url","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create Rule","operationId":"proxyCreateRule","tags":["proxy"],"description":"Create a new proxy rule.","responses":{"201":{"description":"Rule","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/proxyRule"}}}}},"x-appwrite":{"method":"createRule","weight":311,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/create-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/create-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","description":"Domain name.","x-example":null},"resourceType":{"type":"string","description":"Action definition for the rule. Possible values are \"api\", \"function\"","x-example":"api","enum":["api","function"],"x-enum-name":null,"x-enum-keys":[]},"resourceId":{"type":"string","description":"ID of resource for the action type. If resourceType is \"api\", leave empty. If resourceType is \"function\", provide ID of the function.","x-example":"<RESOURCE_ID>"}},"required":["domain","resourceType"]}}}}}},"\/proxy\/rules\/{ruleId}":{"get":{"summary":"Get Rule","operationId":"proxyGetRule","tags":["proxy"],"description":"Get a proxy rule by its unique ID.","responses":{"200":{"description":"Rule","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/proxyRule"}}}}},"x-appwrite":{"method":"getRule","weight":313,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/get-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/get-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"schema":{"type":"string","x-example":"<RULE_ID>"},"in":"path"}]},"delete":{"summary":"Delete Rule","operationId":"proxyDeleteRule","tags":["proxy"],"description":"Delete a proxy rule by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteRule","weight":314,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/delete-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/delete-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"schema":{"type":"string","x-example":"<RULE_ID>"},"in":"path"}]}},"\/proxy\/rules\/{ruleId}\/verification":{"patch":{"summary":"Update Rule Verification Status","operationId":"proxyUpdateRuleVerification","tags":["proxy"],"description":"","responses":{"200":{"description":"Rule","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/proxyRule"}}}}},"x-appwrite":{"method":"updateRuleVerification","weight":315,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/update-rule-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"schema":{"type":"string","x-example":"<RULE_ID>"},"in":"path"}]}},"\/storage\/buckets":{"get":{"summary":"List buckets","operationId":"storageListBuckets","tags":["storage"],"description":"Get a list of all the storage buckets. You can use the query params to filter your results.","responses":{"200":{"description":"Buckets List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucketList"}}}}},"x-appwrite":{"method":"listBuckets","weight":201,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-buckets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create bucket","operationId":"storageCreateBucket","tags":["storage"],"description":"Create a new storage bucket.","responses":{"201":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"createBucket","weight":200,"cookies":false,"type":"","deprecated":false,"demo":"storage\/create-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"bucketId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<BUCKET_ID>"},"name":{"type":"string","description":"Bucket name","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","x-example":false}},"required":["bucketId","name"]}}}}}},"\/storage\/buckets\/{bucketId}":{"get":{"summary":"Get bucket","operationId":"storageGetBucket","tags":["storage"],"description":"Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.","responses":{"200":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"getBucket","weight":202,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}]},"put":{"summary":"Update bucket","operationId":"storageUpdateBucket","tags":["storage"],"description":"Update a storage bucket by its unique ID.","responses":{"200":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"updateBucket","weight":203,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Bucket name","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete bucket","operationId":"storageDeleteBucket","tags":["storage"],"description":"Delete a storage bucket by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteBucket","weight":204,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/fileList"}}}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"fileId":{"type":"string","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<FILE_ID>","x-upload-id":true},"file":{"type":"string","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","x-example":null},"permissions":{"type":"array","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["fileId","file"]}}}}}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"schema":{"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center"},"in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"schema":{"type":"number","format":"float","x-example":0,"default":1},"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"schema":{"type":"integer","format":"int32","x-example":-360,"default":0},"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"schema":{"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":""},"in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/storage\/usage":{"get":{"summary":"Get storage usage stats","operationId":"storageGetUsage","tags":["storage"],"description":"","responses":{"200":{"description":"StorageUsage","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageStorage"}}}}},"x-appwrite":{"method":"getUsage","weight":214,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"StorageUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/storage\/{bucketId}\/usage":{"get":{"summary":"Get bucket usage stats","operationId":"storageGetBucketUsage","tags":["storage"],"description":"","responses":{"200":{"description":"UsageBuckets","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageBuckets"}}}}},"x-appwrite":{"method":"getBucketUsage","weight":215,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"bucketId","description":"Bucket ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"StorageUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/teamList"}}}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}}}}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["name"]}}}}},"delete":{"summary":"Delete team","operationId":"teamsDelete","tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]}},"\/teams\/{teamId}\/logs":{"get":{"summary":"List team logs","operationId":"teamsListLogs","tags":["teams"],"description":"Get the team activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":229,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membershipList"}}}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","x-example":"<NAME>"}},"required":["roles"]}}}}}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["roles"]}}}}},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/users":{"get":{"summary":"List users","operationId":"usersList","tags":["users"],"description":"Get a list of all the project's users. You can use the query params to filter your results.","responses":{"200":{"description":"Users List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/userList"}}}}},"x-appwrite":{"method":"list","weight":239,"cookies":false,"type":"","deprecated":false,"demo":"users\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create user","operationId":"usersCreate","tags":["users"],"description":"Create a new user.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"create","weight":230,"cookies":false,"type":"","deprecated":false,"demo":"users\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"password":{"type":"string","description":"Plain text user password. Must be at least 8 chars.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId"]}}}}}},"\/users\/argon2":{"post":{"summary":"Create user with Argon2 password","operationId":"usersCreateArgon2User","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createArgon2User","weight":233,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-argon2user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Argon2.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/bcrypt":{"post":{"summary":"Create user with bcrypt password","operationId":"usersCreateBcryptUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createBcryptUser","weight":231,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-bcrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Bcrypt.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/identities":{"get":{"summary":"List Identities","operationId":"usersListIdentities","tags":["users"],"description":"Get identities for all users.","responses":{"200":{"description":"Identities List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/identityList"}}}}},"x-appwrite":{"method":"listIdentities","weight":247,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/users\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"usersDeleteIdentity","tags":["users"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":270,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"schema":{"type":"string","x-example":"<IDENTITY_ID>"},"in":"path"}]}},"\/users\/md5":{"post":{"summary":"Create user with MD5 password","operationId":"usersCreateMD5User","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createMD5User","weight":232,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-m-d5user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using MD5.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/phpass":{"post":{"summary":"Create user with PHPass password","operationId":"usersCreatePHPassUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createPHPassUser","weight":235,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-p-h-pass-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using PHPass.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/scrypt":{"post":{"summary":"Create user with Scrypt password","operationId":"usersCreateScryptUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createScryptUser","weight":236,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt.","x-example":"password"},"passwordSalt":{"type":"string","description":"Optional salt used to hash password.","x-example":"<PASSWORD_SALT>"},"passwordCpu":{"type":"integer","description":"Optional CPU cost used to hash password.","x-example":null},"passwordMemory":{"type":"integer","description":"Optional memory cost used to hash password.","x-example":null},"passwordParallel":{"type":"integer","description":"Optional parallelization cost used to hash password.","x-example":null},"passwordLength":{"type":"integer","description":"Optional hash length used to hash password.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordCpu","passwordMemory","passwordParallel","passwordLength"]}}}}}},"\/users\/scrypt-modified":{"post":{"summary":"Create user with Scrypt modified password","operationId":"usersCreateScryptModifiedUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createScryptModifiedUser","weight":237,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-modified-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt Modified.","x-example":"password"},"passwordSalt":{"type":"string","description":"Salt used to hash password.","x-example":"<PASSWORD_SALT>"},"passwordSaltSeparator":{"type":"string","description":"Salt separator used to hash password.","x-example":"<PASSWORD_SALT_SEPARATOR>"},"passwordSignerKey":{"type":"string","description":"Signer key used to hash password.","x-example":"<PASSWORD_SIGNER_KEY>"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordSaltSeparator","passwordSignerKey"]}}}}}},"\/users\/sha":{"post":{"summary":"Create user with SHA password","operationId":"usersCreateSHAUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createSHAUser","weight":234,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-s-h-a-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using SHA.","x-example":"password"},"passwordVersion":{"type":"string","description":"Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'","x-example":"sha1","enum":["sha1","sha224","sha256","sha384","sha512\/224","sha512\/256","sha512","sha3-224","sha3-256","sha3-384","sha3-512"],"x-enum-name":"PasswordHash","x-enum-keys":[]},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/usage":{"get":{"summary":"Get users usage stats","operationId":"usersGetUsage","tags":["users"],"description":"","responses":{"200":{"description":"UsageUsers","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/usageUsers"}}}}},"x-appwrite":{"method":"getUsage","weight":272,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"schema":{"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"UserUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d"},"in":"query"}]}},"\/users\/{userId}":{"get":{"summary":"Get user","operationId":"usersGet","tags":["users"],"description":"Get a user by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"get","weight":240,"cookies":false,"type":"","deprecated":false,"demo":"users\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"delete":{"summary":"Delete user","operationId":"usersDelete","tags":["users"],"description":"Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":268,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/email":{"patch":{"summary":"Update email","operationId":"usersUpdateEmail","tags":["users"],"description":"Update the user email by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmail","weight":253,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"}},"required":["email"]}}}}}},"\/users\/{userId}\/jwts":{"post":{"summary":"Create user JWT","operationId":"usersCreateJWT","tags":["users"],"description":"Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":271,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.","x-example":"<SESSION_ID>"},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","x-example":0}}}}}}}},"\/users\/{userId}\/labels":{"put":{"summary":"Update user labels","operationId":"usersUpdateLabels","tags":["users"],"description":"Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateLabels","weight":249,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-labels.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"labels":{"type":"array","description":"Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.","x-example":null,"items":{"type":"string"}}},"required":["labels"]}}}}}},"\/users\/{userId}\/logs":{"get":{"summary":"List user logs","operationId":"usersListLogs","tags":["users"],"description":"Get the user activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":245,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/users\/{userId}\/memberships":{"get":{"summary":"List user memberships","operationId":"usersListMemberships","tags":["users"],"description":"Get the user membership list by its unique ID.","responses":{"200":{"description":"Memberships List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membershipList"}}}}},"x-appwrite":{"method":"listMemberships","weight":244,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/mfa":{"patch":{"summary":"Update MFA","operationId":"usersUpdateMfa","tags":["users"],"description":"Enable or disable MFA on a user account.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMfa","weight":258,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","x-example":false}},"required":["mfa"]}}}}}},"\/users\/{userId}\/mfa\/authenticators\/{type}":{"delete":{"summary":"Delete Authenticator","operationId":"usersDeleteMfaAuthenticator","tags":["users"],"description":"Delete an authenticator app.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":263,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]}},"\/users\/{userId}\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"usersListMfaFactors","tags":["users"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaFactors"}}}}},"x-appwrite":{"method":"listMfaFactors","weight":259,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"usersGetMfaRecoveryCodes","tags":["users"],"description":"Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":260,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"put":{"summary":"Regenerate MFA Recovery Codes","operationId":"usersUpdateMfaRecoveryCodes","tags":["users"],"description":"Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":262,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"patch":{"summary":"Create MFA Recovery Codes","operationId":"usersCreateMfaRecoveryCodes","tags":["users"],"description":"Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.","responses":{"201":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":261,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/name":{"patch":{"summary":"Update name","operationId":"usersUpdateName","tags":["users"],"description":"Update the user name by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateName","weight":251,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["name"]}}}}}},"\/users\/{userId}\/password":{"patch":{"summary":"Update password","operationId":"usersUpdatePassword","tags":["users"],"description":"Update the user password by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePassword","weight":252,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","x-example":null}},"required":["password"]}}}}}},"\/users\/{userId}\/phone":{"patch":{"summary":"Update phone","operationId":"usersUpdatePhone","tags":["users"],"description":"Update the user phone by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhone","weight":254,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"User phone number.","x-example":"+12065550100"}},"required":["number"]}}}}}},"\/users\/{userId}\/prefs":{"get":{"summary":"Get user preferences","operationId":"usersGetPrefs","tags":["users"],"description":"Get the user preferences by its unique ID.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":241,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"patch":{"summary":"Update user preferences","operationId":"usersUpdatePrefs","tags":["users"],"description":"Update the user preferences by its unique ID. 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.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"updatePrefs","weight":256,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/users\/{userId}\/sessions":{"get":{"summary":"List user sessions","operationId":"usersListSessions","tags":["users"],"description":"Get the user sessions list by its unique ID.","responses":{"200":{"description":"Sessions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/sessionList"}}}}},"x-appwrite":{"method":"listSessions","weight":243,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"post":{"summary":"Create session","operationId":"usersCreateSession","tags":["users"],"description":"Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createSession","weight":264,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"delete":{"summary":"Delete user sessions","operationId":"usersDeleteSessions","tags":["users"],"description":"Delete all user's sessions by using the user's unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":267,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/sessions\/{sessionId}":{"delete":{"summary":"Delete user session","operationId":"usersDeleteSession","tags":["users"],"description":"Delete a user sessions by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":266,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"sessionId","description":"Session ID.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]}},"\/users\/{userId}\/status":{"patch":{"summary":"Update user status","operationId":"usersUpdateStatus","tags":["users"],"description":"Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateStatus","weight":248,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"User Status. To activate the user pass `true` and to block the user pass `false`.","x-example":false}},"required":["status"]}}}}}},"\/users\/{userId}\/targets":{"get":{"summary":"List User Targets","operationId":"usersListTargets","tags":["users"],"description":"List the messaging targets that are associated with a user.","responses":{"200":{"description":"Target list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/targetList"}}}}},"x-appwrite":{"method":"listTargets","weight":246,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create User Target","operationId":"usersCreateTarget","tags":["users"],"description":"Create a messaging target.","responses":{"201":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"createTarget","weight":238,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<TARGET_ID>"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email","enum":["email","sms","push"],"x-enum-name":"MessagingProviderType","x-enum-keys":[]},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","x-example":"<NAME>"}},"required":["targetId","providerType","identifier"]}}}}}},"\/users\/{userId}\/targets\/{targetId}":{"get":{"summary":"Get User Target","operationId":"usersGetTarget","tags":["users"],"description":"Get a user's push notification target by ID.","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"getTarget","weight":242,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}]},"patch":{"summary":"Update User target","operationId":"usersUpdateTarget","tags":["users"],"description":"Update a messaging target.","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"updateTarget","weight":257,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","x-example":"<NAME>"}}}}}}},"delete":{"summary":"Delete user target","operationId":"usersDeleteTarget","tags":["users"],"description":"Delete a messaging target.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTarget","weight":269,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}]}},"\/users\/{userId}\/tokens":{"post":{"summary":"Create token","operationId":"usersCreateToken","tags":["users"],"description":"Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createToken","weight":265,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"length":{"type":"integer","description":"Token length in characters. The default length is 6 characters","x-example":4},"expire":{"type":"integer","description":"Token expiration period in seconds. The default expiration is 15 minutes.","x-example":60}}}}}}}},"\/users\/{userId}\/verification":{"patch":{"summary":"Update email verification","operationId":"usersUpdateEmailVerification","tags":["users"],"description":"Update the user email verification status by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmailVerification","weight":255,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"emailVerification":{"type":"boolean","description":"User email verification status.","x-example":false}},"required":["emailVerification"]}}}}}},"\/users\/{userId}\/verification\/phone":{"patch":{"summary":"Update phone verification","operationId":"usersUpdatePhoneVerification","tags":["users"],"description":"Update the user phone verification status by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhoneVerification","weight":250,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"phoneVerification":{"type":"boolean","description":"User phone verification status.","x-example":false}},"required":["phoneVerification"]}}}}}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories":{"get":{"summary":"List Repositories","operationId":"vcsListRepositories","tags":["vcs"],"description":"","responses":{"200":{"description":"Provider Repositories List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/providerRepositoryList"}}}}},"x-appwrite":{"method":"listRepositories","weight":277,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-repositories.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create repository","operationId":"vcsCreateRepository","tags":["vcs"],"description":"","responses":{"200":{"description":"ProviderRepository","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/providerRepository"}}}}},"x-appwrite":{"method":"createRepository","weight":278,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/create-repository.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Repository name (slug)","x-example":"<NAME>"},"private":{"type":"boolean","description":"Mark repository public or private","x-example":false}},"required":["name","private"]}}}}}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}":{"get":{"summary":"Get repository","operationId":"vcsGetRepository","tags":["vcs"],"description":"","responses":{"200":{"description":"ProviderRepository","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/providerRepository"}}}}},"x-appwrite":{"method":"getRepository","weight":279,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-repository.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"schema":{"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>"},"in":"path"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/branches":{"get":{"summary":"List Repository Branches","operationId":"vcsListRepositoryBranches","tags":["vcs"],"description":"","responses":{"200":{"description":"Branches List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/branchList"}}}}},"x-appwrite":{"method":"listRepositoryBranches","weight":280,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-repository-branches.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"schema":{"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>"},"in":"path"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/contents":{"get":{"summary":"Get files and directories of a VCS repository","operationId":"vcsGetRepositoryContents","tags":["vcs"],"description":"","responses":{"200":{"description":"VCS Content List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/vcsContentList"}}}}},"x-appwrite":{"method":"getRepositoryContents","weight":275,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-repository-contents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"schema":{"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>"},"in":"path"},{"name":"providerRootDirectory","description":"Path to get contents of nested directory","required":false,"schema":{"type":"string","x-example":"<PROVIDER_ROOT_DIRECTORY>","default":""},"in":"query"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/detection":{"post":{"summary":"Detect runtime settings from source code","operationId":"vcsCreateRepositoryDetection","tags":["vcs"],"description":"","responses":{"200":{"description":"Detection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/detection"}}}}},"x-appwrite":{"method":"createRepositoryDetection","weight":276,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/create-repository-detection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"schema":{"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerRootDirectory":{"type":"string","description":"Path to Root Directory","x-example":"<PROVIDER_ROOT_DIRECTORY>"}}}}}}}},"\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}":{"patch":{"summary":"Authorize external deployment","operationId":"vcsUpdateExternalDeployments","tags":["vcs"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateExternalDeployments","weight":285,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/update-external-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"},{"name":"repositoryId","description":"VCS Repository Id","required":true,"schema":{"type":"string","x-example":"<REPOSITORY_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerPullRequestId":{"type":"string","description":"GitHub Pull Request Id","x-example":"<PROVIDER_PULL_REQUEST_ID>"}},"required":["providerPullRequestId"]}}}}}},"\/vcs\/installations":{"get":{"summary":"List installations","operationId":"vcsListInstallations","tags":["vcs"],"description":"","responses":{"200":{"description":"Installations List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/installationList"}}}}},"x-appwrite":{"method":"listInstallations","weight":282,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-installations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-installations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"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: provider, organization","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/vcs\/installations\/{installationId}":{"get":{"summary":"Get installation","operationId":"vcsGetInstallation","tags":["vcs"],"description":"","responses":{"200":{"description":"Installation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/installation"}}}}},"x-appwrite":{"method":"getInstallation","weight":283,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-installation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-installation.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"}]},"delete":{"summary":"Delete Installation","operationId":"vcsDeleteInstallation","tags":["vcs"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteInstallation","weight":284,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/delete-installation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/delete-installation.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"schema":{"type":"string","x-example":"<INSTALLATION_ID>"},"in":"path"}]}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"components":{"schemas":{"any":{"description":"Any","type":"object","additionalProperties":true},"error":{"description":"Error","type":"object","properties":{"message":{"type":"string","description":"Error message.","x-example":"Not found"},"code":{"type":"string","description":"Error code.","x-example":"404"},"type":{"type":"string","description":"Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes","x-example":"not_found"},"version":{"type":"string","description":"Server version number.","x-example":"1.0"}},"required":["message","code","type","version"]},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"$ref":"#\/components\/schemas\/document"},"x-example":""}},"required":["total","documents"]},"collectionList":{"description":"Collections List","type":"object","properties":{"total":{"type":"integer","description":"Total number of collections documents that matched your query.","x-example":5,"format":"int32"},"collections":{"type":"array","description":"List of collections.","items":{"$ref":"#\/components\/schemas\/collection"},"x-example":""}},"required":["total","collections"]},"databaseList":{"description":"Databases List","type":"object","properties":{"total":{"type":"integer","description":"Total number of databases documents that matched your query.","x-example":5,"format":"int32"},"databases":{"type":"array","description":"List of databases.","items":{"$ref":"#\/components\/schemas\/database"},"x-example":""}},"required":["total","databases"]},"indexList":{"description":"Indexes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of indexes documents that matched your query.","x-example":5,"format":"int32"},"indexes":{"type":"array","description":"List of indexes.","items":{"$ref":"#\/components\/schemas\/index"},"x-example":""}},"required":["total","indexes"]},"userList":{"description":"Users List","type":"object","properties":{"total":{"type":"integer","description":"Total number of users documents that matched your query.","x-example":5,"format":"int32"},"users":{"type":"array","description":"List of users.","items":{"$ref":"#\/components\/schemas\/user"},"x-example":""}},"required":["total","users"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"$ref":"#\/components\/schemas\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"$ref":"#\/components\/schemas\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"$ref":"#\/components\/schemas\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"$ref":"#\/components\/schemas\/file"},"x-example":""}},"required":["total","files"]},"bucketList":{"description":"Buckets List","type":"object","properties":{"total":{"type":"integer","description":"Total number of buckets documents that matched your query.","x-example":5,"format":"int32"},"buckets":{"type":"array","description":"List of buckets.","items":{"$ref":"#\/components\/schemas\/bucket"},"x-example":""}},"required":["total","buckets"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"$ref":"#\/components\/schemas\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"$ref":"#\/components\/schemas\/membership"},"x-example":""}},"required":["total","memberships"]},"functionList":{"description":"Functions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of functions documents that matched your query.","x-example":5,"format":"int32"},"functions":{"type":"array","description":"List of functions.","items":{"$ref":"#\/components\/schemas\/function"},"x-example":""}},"required":["total","functions"]},"installationList":{"description":"Installations List","type":"object","properties":{"total":{"type":"integer","description":"Total number of installations documents that matched your query.","x-example":5,"format":"int32"},"installations":{"type":"array","description":"List of installations.","items":{"$ref":"#\/components\/schemas\/installation"},"x-example":""}},"required":["total","installations"]},"providerRepositoryList":{"description":"Provider Repositories List","type":"object","properties":{"total":{"type":"integer","description":"Total number of providerRepositories documents that matched your query.","x-example":5,"format":"int32"},"providerRepositories":{"type":"array","description":"List of providerRepositories.","items":{"$ref":"#\/components\/schemas\/providerRepository"},"x-example":""}},"required":["total","providerRepositories"]},"branchList":{"description":"Branches List","type":"object","properties":{"total":{"type":"integer","description":"Total number of branches documents that matched your query.","x-example":5,"format":"int32"},"branches":{"type":"array","description":"List of branches.","items":{"$ref":"#\/components\/schemas\/branch"},"x-example":""}},"required":["total","branches"]},"runtimeList":{"description":"Runtimes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of runtimes documents that matched your query.","x-example":5,"format":"int32"},"runtimes":{"type":"array","description":"List of runtimes.","items":{"$ref":"#\/components\/schemas\/runtime"},"x-example":""}},"required":["total","runtimes"]},"deploymentList":{"description":"Deployments List","type":"object","properties":{"total":{"type":"integer","description":"Total number of deployments documents that matched your query.","x-example":5,"format":"int32"},"deployments":{"type":"array","description":"List of deployments.","items":{"$ref":"#\/components\/schemas\/deployment"},"x-example":""}},"required":["total","deployments"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"$ref":"#\/components\/schemas\/execution"},"x-example":""}},"required":["total","executions"]},"projectList":{"description":"Projects List","type":"object","properties":{"total":{"type":"integer","description":"Total number of projects documents that matched your query.","x-example":5,"format":"int32"},"projects":{"type":"array","description":"List of projects.","items":{"$ref":"#\/components\/schemas\/project"},"x-example":""}},"required":["total","projects"]},"webhookList":{"description":"Webhooks List","type":"object","properties":{"total":{"type":"integer","description":"Total number of webhooks documents that matched your query.","x-example":5,"format":"int32"},"webhooks":{"type":"array","description":"List of webhooks.","items":{"$ref":"#\/components\/schemas\/webhook"},"x-example":""}},"required":["total","webhooks"]},"keyList":{"description":"API Keys List","type":"object","properties":{"total":{"type":"integer","description":"Total number of keys documents that matched your query.","x-example":5,"format":"int32"},"keys":{"type":"array","description":"List of keys.","items":{"$ref":"#\/components\/schemas\/key"},"x-example":""}},"required":["total","keys"]},"platformList":{"description":"Platforms List","type":"object","properties":{"total":{"type":"integer","description":"Total number of platforms documents that matched your query.","x-example":5,"format":"int32"},"platforms":{"type":"array","description":"List of platforms.","items":{"$ref":"#\/components\/schemas\/platform"},"x-example":""}},"required":["total","platforms"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"$ref":"#\/components\/schemas\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"$ref":"#\/components\/schemas\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"$ref":"#\/components\/schemas\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"$ref":"#\/components\/schemas\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"$ref":"#\/components\/schemas\/phone"},"x-example":""}},"required":["total","phones"]},"variableList":{"description":"Variables List","type":"object","properties":{"total":{"type":"integer","description":"Total number of variables documents that matched your query.","x-example":5,"format":"int32"},"variables":{"type":"array","description":"List of variables.","items":{"$ref":"#\/components\/schemas\/variable"},"x-example":""}},"required":["total","variables"]},"proxyRuleList":{"description":"Rule List","type":"object","properties":{"total":{"type":"integer","description":"Total number of rules documents that matched your query.","x-example":5,"format":"int32"},"rules":{"type":"array","description":"List of rules.","items":{"$ref":"#\/components\/schemas\/proxyRule"},"x-example":""}},"required":["total","rules"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"$ref":"#\/components\/schemas\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"providerList":{"description":"Provider list","type":"object","properties":{"total":{"type":"integer","description":"Total number of providers documents that matched your query.","x-example":5,"format":"int32"},"providers":{"type":"array","description":"List of providers.","items":{"$ref":"#\/components\/schemas\/provider"},"x-example":""}},"required":["total","providers"]},"messageList":{"description":"Message list","type":"object","properties":{"total":{"type":"integer","description":"Total number of messages documents that matched your query.","x-example":5,"format":"int32"},"messages":{"type":"array","description":"List of messages.","items":{"$ref":"#\/components\/schemas\/message"},"x-example":""}},"required":["total","messages"]},"topicList":{"description":"Topic list","type":"object","properties":{"total":{"type":"integer","description":"Total number of topics documents that matched your query.","x-example":5,"format":"int32"},"topics":{"type":"array","description":"List of topics.","items":{"$ref":"#\/components\/schemas\/topic"},"x-example":""}},"required":["total","topics"]},"subscriberList":{"description":"Subscriber list","type":"object","properties":{"total":{"type":"integer","description":"Total number of subscribers documents that matched your query.","x-example":5,"format":"int32"},"subscribers":{"type":"array","description":"List of subscribers.","items":{"$ref":"#\/components\/schemas\/subscriber"},"x-example":""}},"required":["total","subscribers"]},"targetList":{"description":"Target list","type":"object","properties":{"total":{"type":"integer","description":"Total number of targets documents that matched your query.","x-example":5,"format":"int32"},"targets":{"type":"array","description":"List of targets.","items":{"$ref":"#\/components\/schemas\/target"},"x-example":""}},"required":["total","targets"]},"migrationList":{"description":"Migrations List","type":"object","properties":{"total":{"type":"integer","description":"Total number of migrations documents that matched your query.","x-example":5,"format":"int32"},"migrations":{"type":"array","description":"List of migrations.","items":{"$ref":"#\/components\/schemas\/migration"},"x-example":""}},"required":["total","migrations"]},"firebaseProjectList":{"description":"Migrations Firebase Projects List","type":"object","properties":{"total":{"type":"integer","description":"Total number of projects documents that matched your query.","x-example":5,"format":"int32"},"projects":{"type":"array","description":"List of projects.","items":{"$ref":"#\/components\/schemas\/firebaseProject"},"x-example":""}},"required":["total","projects"]},"vcsContentList":{"description":"VCS Content List","type":"object","properties":{"total":{"type":"integer","description":"Total number of contents documents that matched your query.","x-example":5,"format":"int32"},"contents":{"type":"array","description":"List of contents.","items":{"$ref":"#\/components\/schemas\/vcsContent"},"x-example":""}},"required":["total","contents"]},"database":{"description":"Database","type":"object","properties":{"$id":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Database name.","x-example":"My Database"},"$createdAt":{"type":"string","description":"Database creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Database update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"enabled":{"type":"boolean","description":"If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false}},"required":["$id","name","$createdAt","$updatedAt","enabled"]},"collection":{"description":"Collection","type":"object","properties":{"$id":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Collection creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Collection update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Collection name.","x-example":"My Collection"},"enabled":{"type":"boolean","description":"Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false},"documentSecurity":{"type":"boolean","description":"Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"attributes":{"type":"array","description":"Collection attributes.","items":{"anyOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]},"x-example":{}},"indexes":{"type":"array","description":"Collection indexes.","items":{"$ref":"#\/components\/schemas\/index"},"x-example":{}}},"required":["$id","$createdAt","$updatedAt","$permissions","databaseId","name","enabled","documentSecurity","attributes","indexes"]},"attributeList":{"description":"Attributes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of attributes in the given collection.","x-example":5,"format":"int32"},"attributes":{"type":"array","description":"List of attributes.","items":{"anyOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]},"x-example":""}},"required":["total","attributes"]},"attributeString":{"description":"AttributeString","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"size":{"type":"integer","description":"Attribute size.","x-example":128,"format":"int32"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default","nullable":true}},"required":["key","type","status","error","required","size"]},"attributeInteger":{"description":"AttributeInteger","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"count"},"type":{"type":"string","description":"Attribute type.","x-example":"integer"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"min":{"type":"integer","description":"Minimum value to enforce for new documents.","x-example":1,"format":"int32","nullable":true},"max":{"type":"integer","description":"Maximum value to enforce for new documents.","x-example":10,"format":"int32","nullable":true},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":10,"format":"int32","nullable":true}},"required":["key","type","status","error","required"]},"attributeFloat":{"description":"AttributeFloat","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"percentageCompleted"},"type":{"type":"string","description":"Attribute type.","x-example":"double"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"min":{"type":"number","description":"Minimum value to enforce for new documents.","x-example":1.5,"format":"double","nullable":true},"max":{"type":"number","description":"Maximum value to enforce for new documents.","x-example":10.5,"format":"double","nullable":true},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":2.5,"format":"double","nullable":true}},"required":["key","type","status","error","required"]},"attributeBoolean":{"description":"AttributeBoolean","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"isEnabled"},"type":{"type":"string","description":"Attribute type.","x-example":"boolean"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"nullable":true}},"required":["key","type","status","error","required"]},"attributeEmail":{"description":"AttributeEmail","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"userEmail"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"email"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default@example.com","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeEnum":{"description":"AttributeEnum","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"status"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"elements":{"type":"array","description":"Array of elements in enumerated type.","items":{"type":"string"},"x-example":"element"},"format":{"type":"string","description":"String format.","x-example":"enum"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"element","nullable":true}},"required":["key","type","status","error","required","elements","format"]},"attributeIp":{"description":"AttributeIP","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"ipAddress"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"ip"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"192.0.2.0","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeUrl":{"description":"AttributeURL","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"githubUrl"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"url"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"http:\/\/example.com","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeDatetime":{"description":"AttributeDatetime","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"birthDay"},"type":{"type":"string","description":"Attribute type.","x-example":"datetime"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"ISO 8601 format.","x-example":"datetime"},"default":{"type":"string","description":"Default value for attribute when not provided. Only null is optional","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeRelationship":{"description":"AttributeRelationship","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"relatedCollection":{"type":"string","description":"The ID of the related collection.","x-example":"collection"},"relationType":{"type":"string","description":"The type of the relationship.","x-example":"oneToOne|oneToMany|manyToOne|manyToMany"},"twoWay":{"type":"boolean","description":"Is the relationship two-way?","x-example":false},"twoWayKey":{"type":"string","description":"The key of the two-way relationship.","x-example":"string"},"onDelete":{"type":"string","description":"How deleting the parent document will propagate to child documents.","x-example":"restrict|cascade|setNull"},"side":{"type":"string","description":"Whether this is the parent or child side of the relationship","x-example":"parent|child"}},"required":["key","type","status","error","required","relatedCollection","relationType","twoWay","twoWayKey","onDelete","side"]},"index":{"description":"Index","type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":"index1"},"type":{"type":"string","description":"Index type.","x-example":"primary"},"status":{"type":"string","description":"Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an index.","x-example":"string"},"attributes":{"type":"array","description":"Index attributes.","items":{"type":"string"},"x-example":[]},"orders":{"type":"array","description":"Index orders.","items":{"type":"string"},"x-example":[],"nullable":true}},"required":["key","type","status","error","attributes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"oneOf":[{"$ref":"#\/components\/schemas\/algoArgon2"},{"$ref":"#\/components\/schemas\/algoScrypt"},{"$ref":"#\/components\/schemas\/algoScryptModified"},{"$ref":"#\/components\/schemas\/algoBcrypt"},{"$ref":"#\/components\/schemas\/algoPhpass"},{"$ref":"#\/components\/schemas\/algoSha"},{"$ref":"#\/components\/schemas\/algoMd5"}]},"nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"$ref":"#\/components\/schemas\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"bucket":{"description":"Bucket","type":"object","properties":{"$id":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Bucket creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Bucket update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"fileSecurity":{"type":"boolean","description":"Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"name":{"type":"string","description":"Bucket name.","x-example":"Documents"},"enabled":{"type":"boolean","description":"Bucket enabled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size supported.","x-example":100,"format":"int32"},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions.","items":{"type":"string"},"x-example":["jpg","png"]},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).","x-example":"gzip"},"encryption":{"type":"boolean","description":"Bucket is encrypted.","x-example":false},"antivirus":{"type":"boolean","description":"Virus scanning is enabled.","x-example":false}},"required":["$id","$createdAt","$updatedAt","$permissions","fileSecurity","name","enabled","maximumFileSize","allowedFileExtensions","compression","encryption","antivirus"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"function":{"description":"Function","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"execute":{"type":"array","description":"Execution permissions.","items":{"type":"string"},"x-example":"users"},"name":{"type":"string","description":"Function name.","x-example":"My Function"},"enabled":{"type":"boolean","description":"Function enabled.","x-example":false},"live":{"type":"boolean","description":"Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"runtime":{"type":"string","description":"Function execution runtime.","x-example":"python-3.8"},"deployment":{"type":"string","description":"Function's active deployment ID.","x-example":"5e5ea5c16897e"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"vars":{"type":"array","description":"Function variables.","items":{"$ref":"#\/components\/schemas\/variable"},"x-example":[]},"events":{"type":"array","description":"Function trigger events.","items":{"type":"string"},"x-example":"account.create"},"schedule":{"type":"string","description":"Function execution schedult in CRON format.","x-example":"5 4 * * *"},"timeout":{"type":"integer","description":"Function execution timeout in seconds.","x-example":300,"format":"int32"},"entrypoint":{"type":"string","description":"The entrypoint file used to execute the deployment.","x-example":"index.js"},"commands":{"type":"string","description":"The build command used to build the deployment.","x-example":"npm install"},"version":{"type":"string","description":"Version of Open Runtimes used for the function.","x-example":"v2"},"installationId":{"type":"string","description":"Function VCS (Version Control System) installation id.","x-example":"6m40at4ejk5h2u9s1hboo"},"providerRepositoryId":{"type":"string","description":"VCS (Version Control System) Repository ID","x-example":"appwrite"},"providerBranch":{"type":"string","description":"VCS (Version Control System) branch name","x-example":"main"},"providerRootDirectory":{"type":"string","description":"Path to function in VCS (Version Control System) repository","x-example":"functions\/helloWorld"},"providerSilentMode":{"type":"boolean","description":"Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests","x-example":false}},"required":["$id","$createdAt","$updatedAt","execute","name","enabled","live","logging","runtime","deployment","scopes","vars","events","schedule","timeout","entrypoint","commands","version","installationId","providerRepositoryId","providerBranch","providerRootDirectory","providerSilentMode"]},"installation":{"description":"Installation","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"VCS (Version Control System) provider name.","x-example":"github"},"organization":{"type":"string","description":"VCS (Version Control System) organization name.","x-example":"appwrite"},"providerInstallationId":{"type":"string","description":"VCS (Version Control System) installation ID.","x-example":"5322"}},"required":["$id","$createdAt","$updatedAt","provider","organization","providerInstallationId"]},"providerRepository":{"description":"ProviderRepository","type":"object","properties":{"id":{"type":"string","description":"VCS (Version Control System) repository ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"VCS (Version Control System) repository name.","x-example":"appwrite"},"organization":{"type":"string","description":"VCS (Version Control System) organization name","x-example":"appwrite"},"provider":{"type":"string","description":"VCS (Version Control System) provider name.","x-example":"github"},"private":{"type":"boolean","description":"Is VCS (Version Control System) repository private?","x-example":true},"runtime":{"type":"string","description":"Auto-detected runtime suggestion. Empty if getting response of getRuntime().","x-example":"node"},"pushedAt":{"type":"string","description":"Last commit date in ISO 8601 format.","x-example":"datetime"}},"required":["id","name","organization","provider","private","runtime","pushedAt"]},"detection":{"description":"Detection","type":"object","properties":{"runtime":{"type":"string","description":"Runtime","x-example":"node"}},"required":["runtime"]},"vcsContent":{"description":"VcsContents","type":"object","properties":{"size":{"type":"integer","description":"Content size in bytes. Only files have size, and for directories, 0 is returned.","x-example":1523,"format":"int32","nullable":true},"isDirectory":{"type":"boolean","description":"If a content is a directory. Directories can be used to check nested contents.","x-example":true,"nullable":true},"name":{"type":"string","description":"Name of directory or file.","x-example":"Main.java"}},"required":["name"]},"branch":{"description":"Branch","type":"object","properties":{"name":{"type":"string","description":"Branch Name.","x-example":"main"}},"required":["name"]},"runtime":{"description":"Runtime","type":"object","properties":{"$id":{"type":"string","description":"Runtime ID.","x-example":"python-3.8"},"name":{"type":"string","description":"Runtime Name.","x-example":"Python"},"version":{"type":"string","description":"Runtime version.","x-example":"3.8"},"base":{"type":"string","description":"Base Docker image used to build the runtime.","x-example":"python:3.8-alpine"},"image":{"type":"string","description":"Image name of Docker Hub.","x-example":"appwrite\\\/runtime-for-python:3.8"},"logo":{"type":"string","description":"Name of the logo image.","x-example":"python.png"},"supports":{"type":"array","description":"List of supported architectures.","items":{"type":"string"},"x-example":"amd64"}},"required":["$id","name","version","base","image","logo","supports"]},"deployment":{"description":"Deployment","type":"object","properties":{"$id":{"type":"string","description":"Deployment ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Deployment update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"type":{"type":"string","description":"Type of deployment.","x-example":"vcs"},"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea6g16897e"},"resourceType":{"type":"string","description":"Resource type.","x-example":"functions"},"entrypoint":{"type":"string","description":"The entrypoint file to use to execute the deployment code.","x-example":"index.js"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"},"buildId":{"type":"string","description":"The current build ID.","x-example":"5e5ea5c16897e"},"activate":{"type":"boolean","description":"Whether the deployment should be automatically activated.","x-example":true},"status":{"type":"string","description":"The deployment status. Possible values are \"processing\", \"building\", \"waiting\", \"ready\", and \"failed\".","x-example":"ready"},"buildLogs":{"type":"string","description":"The build logs.","x-example":"Compiling source files..."},"buildTime":{"type":"integer","description":"The current build time in seconds.","x-example":128,"format":"int32"},"providerRepositoryName":{"type":"string","description":"The name of the vcs provider repository","x-example":"database"},"providerRepositoryOwner":{"type":"string","description":"The name of the vcs provider repository owner","x-example":"utopia"},"providerRepositoryUrl":{"type":"string","description":"The url of the vcs provider repository","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function"},"providerBranch":{"type":"string","description":"The branch of the vcs repository","x-example":"0.7.x"},"providerCommitHash":{"type":"string","description":"The commit hash of the vcs commit","x-example":"7c3f25d"},"providerCommitAuthorUrl":{"type":"string","description":"The url of vcs commit author","x-example":"https:\/\/github.com\/vermakhushboo"},"providerCommitAuthor":{"type":"string","description":"The name of vcs commit author","x-example":"Khushboo Verma"},"providerCommitMessage":{"type":"string","description":"The commit message","x-example":"Update index.js"},"providerCommitUrl":{"type":"string","description":"The url of the vcs commit","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"},"providerBranchUrl":{"type":"string","description":"The branch of the vcs repository","x-example":"https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"}},"required":["$id","$createdAt","$updatedAt","type","resourceId","resourceType","entrypoint","size","buildId","activate","status","buildLogs","buildTime","providerRepositoryName","providerRepositoryOwner","providerRepositoryUrl","providerBranch","providerCommitHash","providerCommitAuthorUrl","providerCommitAuthor","providerCommitMessage","providerCommitUrl","providerBranchUrl"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"build":{"description":"Build","type":"object","properties":{"$id":{"type":"string","description":"Build ID.","x-example":"5e5ea5c16897e"},"deploymentId":{"type":"string","description":"The deployment that created this build.","x-example":"5e5ea5c16897e"},"status":{"type":"string","description":"The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built","x-example":"ready"},"stdout":{"type":"string","description":"The stdout of the build.","x-example":""},"stderr":{"type":"string","description":"The stderr of the build.","x-example":""},"startTime":{"type":"string","description":"The deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"endTime":{"type":"string","description":"The time the build was finished in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"duration":{"type":"integer","description":"The build duration in seconds.","x-example":0,"format":"int32"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"}},"required":["$id","deploymentId","status","stdout","stderr","startTime","endTime","duration","size"]},"project":{"description":"Project","type":"object","properties":{"$id":{"type":"string","description":"Project ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Project creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Project update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Project name.","x-example":"New Project"},"description":{"type":"string","description":"Project description.","x-example":"This is a new project."},"teamId":{"type":"string","description":"Project team ID.","x-example":"1592981250"},"logo":{"type":"string","description":"Project logo file ID.","x-example":"5f5c451b403cb"},"url":{"type":"string","description":"Project website URL.","x-example":"5f5c451b403cb"},"legalName":{"type":"string","description":"Company legal name.","x-example":"Company LTD."},"legalCountry":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.","x-example":"US"},"legalState":{"type":"string","description":"State name.","x-example":"New York"},"legalCity":{"type":"string","description":"City name.","x-example":"New York City."},"legalAddress":{"type":"string","description":"Company Address.","x-example":"620 Eighth Avenue, New York, NY 10018"},"legalTaxId":{"type":"string","description":"Company Tax ID.","x-example":"131102020"},"authDuration":{"type":"integer","description":"Session duration in seconds.","x-example":60,"format":"int32"},"authLimit":{"type":"integer","description":"Max users allowed. 0 is unlimited.","x-example":100,"format":"int32"},"authSessionsLimit":{"type":"integer","description":"Max sessions allowed per user. 100 maximum.","x-example":10,"format":"int32"},"authPasswordHistory":{"type":"integer","description":"Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.","x-example":5,"format":"int32"},"authPasswordDictionary":{"type":"boolean","description":"Whether or not to check user's password against most commonly used passwords.","x-example":true},"authPersonalDataCheck":{"type":"boolean","description":"Whether or not to check the user password for similarity with their personal data.","x-example":true},"authMockNumbers":{"type":"array","description":"An array of mock numbers and their corresponding verification codes (OTPs).","items":{"$ref":"#\/components\/schemas\/mockNumber"},"x-example":[{}]},"authSessionAlerts":{"type":"boolean","description":"Whether or not to send session alert emails to users.","x-example":true},"oAuthProviders":{"type":"array","description":"List of Auth Providers.","items":{"$ref":"#\/components\/schemas\/authProvider"},"x-example":[{}]},"platforms":{"type":"array","description":"List of Platforms.","items":{"$ref":"#\/components\/schemas\/platform"},"x-example":{}},"webhooks":{"type":"array","description":"List of Webhooks.","items":{"$ref":"#\/components\/schemas\/webhook"},"x-example":{}},"keys":{"type":"array","description":"List of API Keys.","items":{"$ref":"#\/components\/schemas\/key"},"x-example":{}},"smtpEnabled":{"type":"boolean","description":"Status for custom SMTP","x-example":false},"smtpSenderName":{"type":"string","description":"SMTP sender name","x-example":"John Appwrite"},"smtpSenderEmail":{"type":"string","description":"SMTP sender email","x-example":"john@appwrite.io"},"smtpReplyTo":{"type":"string","description":"SMTP reply to email","x-example":"support@appwrite.io"},"smtpHost":{"type":"string","description":"SMTP server host name","x-example":"mail.appwrite.io"},"smtpPort":{"type":"integer","description":"SMTP server port","x-example":25,"format":"int32"},"smtpUsername":{"type":"string","description":"SMTP server username","x-example":"emailuser"},"smtpPassword":{"type":"string","description":"SMTP server password","x-example":"securepassword"},"smtpSecure":{"type":"string","description":"SMTP server secure protocol","x-example":"tls"},"authEmailPassword":{"type":"boolean","description":"Email\/Password auth method status","x-example":true},"authUsersAuthMagicURL":{"type":"boolean","description":"Magic URL auth method status","x-example":true},"authEmailOtp":{"type":"boolean","description":"Email (OTP) auth method status","x-example":true},"authAnonymous":{"type":"boolean","description":"Anonymous auth method status","x-example":true},"authInvites":{"type":"boolean","description":"Invites auth method status","x-example":true},"authJWT":{"type":"boolean","description":"JWT auth method status","x-example":true},"authPhone":{"type":"boolean","description":"Phone auth method status","x-example":true},"serviceStatusForAccount":{"type":"boolean","description":"Account service status","x-example":true},"serviceStatusForAvatars":{"type":"boolean","description":"Avatars service status","x-example":true},"serviceStatusForDatabases":{"type":"boolean","description":"Databases service status","x-example":true},"serviceStatusForLocale":{"type":"boolean","description":"Locale service status","x-example":true},"serviceStatusForHealth":{"type":"boolean","description":"Health service status","x-example":true},"serviceStatusForStorage":{"type":"boolean","description":"Storage service status","x-example":true},"serviceStatusForTeams":{"type":"boolean","description":"Teams service status","x-example":true},"serviceStatusForUsers":{"type":"boolean","description":"Users service status","x-example":true},"serviceStatusForFunctions":{"type":"boolean","description":"Functions service status","x-example":true},"serviceStatusForGraphql":{"type":"boolean","description":"GraphQL service status","x-example":true},"serviceStatusForMessaging":{"type":"boolean","description":"Messaging service status","x-example":true}},"required":["$id","$createdAt","$updatedAt","name","description","teamId","logo","url","legalName","legalCountry","legalState","legalCity","legalAddress","legalTaxId","authDuration","authLimit","authSessionsLimit","authPasswordHistory","authPasswordDictionary","authPersonalDataCheck","authMockNumbers","authSessionAlerts","oAuthProviders","platforms","webhooks","keys","smtpEnabled","smtpSenderName","smtpSenderEmail","smtpReplyTo","smtpHost","smtpPort","smtpUsername","smtpPassword","smtpSecure","authEmailPassword","authUsersAuthMagicURL","authEmailOtp","authAnonymous","authInvites","authJWT","authPhone","serviceStatusForAccount","serviceStatusForAvatars","serviceStatusForDatabases","serviceStatusForLocale","serviceStatusForHealth","serviceStatusForStorage","serviceStatusForTeams","serviceStatusForUsers","serviceStatusForFunctions","serviceStatusForGraphql","serviceStatusForMessaging"]},"webhook":{"description":"Webhook","type":"object","properties":{"$id":{"type":"string","description":"Webhook ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Webhook creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Webhook update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Webhook name.","x-example":"My Webhook"},"url":{"type":"string","description":"Webhook URL endpoint.","x-example":"https:\/\/example.com\/webhook"},"events":{"type":"array","description":"Webhook trigger events.","items":{"type":"string"},"x-example":"database.collections.update"},"security":{"type":"boolean","description":"Indicated if SSL \/ TLS Certificate verification is enabled.","x-example":true},"httpUser":{"type":"string","description":"HTTP basic authentication username.","x-example":"username"},"httpPass":{"type":"string","description":"HTTP basic authentication password.","x-example":"password"},"signatureKey":{"type":"string","description":"Signature key which can be used to validated incoming","x-example":"ad3d581ca230e2b7059c545e5a"},"enabled":{"type":"boolean","description":"Indicates if this webhook is enabled.","x-example":true},"logs":{"type":"string","description":"Webhook error logs from the most recent failure.","x-example":"Failed to connect to remote server."},"attempts":{"type":"integer","description":"Number of consecutive failed webhook attempts.","x-example":10,"format":"int32"}},"required":["$id","$createdAt","$updatedAt","name","url","events","security","httpUser","httpPass","signatureKey","enabled","logs","attempts"]},"key":{"description":"Key","type":"object","properties":{"$id":{"type":"string","description":"Key ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Key creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Key update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Key name.","x-example":"My API Key"},"expire":{"type":"string","description":"Key expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"secret":{"type":"string","description":"Secret key.","x-example":"919c2d18fb5d4...a2ae413da83346ad2"},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"},"sdks":{"type":"array","description":"List of SDK user agents that used this key.","items":{"type":"string"},"x-example":"appwrite:flutter"}},"required":["$id","$createdAt","$updatedAt","name","expire","scopes","secret","accessedAt","sdks"]},"mockNumber":{"description":"Mock Number","type":"object","properties":{"phone":{"type":"string","description":"Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.","x-example":"+1612842323"},"otp":{"type":"string","description":"Mock OTP for the number. ","x-example":"123456"}},"required":["phone","otp"]},"authProvider":{"description":"AuthProvider","type":"object","properties":{"key":{"type":"string","description":"Auth Provider.","x-example":"github"},"name":{"type":"string","description":"Auth Provider name.","x-example":"GitHub"},"appId":{"type":"string","description":"OAuth 2.0 application ID.","x-example":"259125845563242502"},"secret":{"type":"string","description":"OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.","x-example":"Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ"},"enabled":{"type":"boolean","description":"Auth Provider is active and can be used to create session.","x-example":""}},"required":["key","name","appId","secret","enabled"]},"platform":{"description":"Platform","type":"object","properties":{"$id":{"type":"string","description":"Platform ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Platform creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Platform update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Platform name.","x-example":"My Web App"},"type":{"type":"string","description":"Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, ios, android, and unity.","x-example":"web"},"key":{"type":"string","description":"Platform Key. iOS bundle ID or Android package name. Empty string for other platforms.","x-example":"com.company.appname"},"store":{"type":"string","description":"App store or Google Play store ID.","x-example":""},"hostname":{"type":"string","description":"Web app hostname. Empty string for other platforms.","x-example":true},"httpUser":{"type":"string","description":"HTTP basic authentication username.","x-example":"username"},"httpPass":{"type":"string","description":"HTTP basic authentication password.","x-example":"password"}},"required":["$id","$createdAt","$updatedAt","name","type","key","store","hostname","httpUser","httpPass"]},"variable":{"description":"Variable","type":"object","properties":{"$id":{"type":"string","description":"Variable ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"key":{"type":"string","description":"Variable key.","x-example":"API_KEY"},"value":{"type":"string","description":"Variable value.","x-example":"myPa$$word1"},"resourceType":{"type":"string","description":"Service to which the variable belongs. Possible values are \"project\", \"function\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"}},"required":["$id","$createdAt","$updatedAt","key","value","resourceType","resourceId"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"healthAntivirus":{"description":"Health Antivirus","type":"object","properties":{"version":{"type":"string","description":"Antivirus version.","x-example":"1.0.0"},"status":{"type":"string","description":"Antivirus status. Possible values can are: `disabled`, `offline`, `online`","x-example":"online"}},"required":["version","status"]},"healthQueue":{"description":"Health Queue","type":"object","properties":{"size":{"type":"integer","description":"Amount of actions in the queue.","x-example":8,"format":"int32"}},"required":["size"]},"healthStatus":{"description":"Health Status","type":"object","properties":{"name":{"type":"string","description":"Name of the service.","x-example":"database"},"ping":{"type":"integer","description":"Duration in milliseconds how long the health check took.","x-example":128,"format":"int32"},"status":{"type":"string","description":"Service status. Possible values can are: `pass`, `fail`","x-example":"pass"}},"required":["name","ping","status"]},"healthCertificate":{"description":"Health Certificate","type":"object","properties":{"name":{"type":"string","description":"Certificate name","x-example":"\/CN=www.google.com"},"subjectSN":{"type":"string","description":"Subject SN","x-example":""},"issuerOrganisation":{"type":"string","description":"Issuer organisation","x-example":""},"validFrom":{"type":"string","description":"Valid from","x-example":"1704200998"},"validTo":{"type":"string","description":"Valid to","x-example":"1711458597"},"signatureTypeSN":{"type":"string","description":"Signature type SN","x-example":"RSA-SHA256"}},"required":["name","subjectSN","issuerOrganisation","validFrom","validTo","signatureTypeSN"]},"healthTime":{"description":"Health Time","type":"object","properties":{"remoteTime":{"type":"integer","description":"Current unix timestamp on trustful remote server.","x-example":1639490751,"format":"int32"},"localTime":{"type":"integer","description":"Current unix timestamp of local server where Appwrite runs.","x-example":1639490844,"format":"int32"},"diff":{"type":"integer","description":"Difference of unix remote and local timestamps in milliseconds.","x-example":93,"format":"int32"}},"required":["remoteTime","localTime","diff"]},"metric":{"description":"Metric","type":"object","properties":{"value":{"type":"integer","description":"The value of this metric at the timestamp.","x-example":1,"format":"int32"},"date":{"type":"string","description":"The date at which this metric was aggregated in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["value","date"]},"metricBreakdown":{"description":"Metric Breakdown","type":"object","properties":{"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Resource name.","x-example":"Documents"},"value":{"type":"integer","description":"The value of this metric at the timestamp.","x-example":1,"format":"int32"}},"required":["resourceId","name","value"]},"usageDatabases":{"description":"UsageDatabases","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"databasesTotal":{"type":"integer","description":"Total aggregated number of databases.","x-example":0,"format":"int32"},"collectionsTotal":{"type":"integer","description":"Total aggregated number of collections.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"databases":{"type":"array","description":"Aggregated number of databases per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"collections":{"type":"array","description":"Aggregated number of collections per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","databasesTotal","collectionsTotal","documentsTotal","databases","collections","documents"]},"usageDatabase":{"description":"UsageDatabase","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"collectionsTotal":{"type":"integer","description":"Total aggregated number of collections.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"collections":{"type":"array","description":"Aggregated number of collections per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","collectionsTotal","documentsTotal","collections","documents"]},"usageCollection":{"description":"UsageCollection","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"documentsTotal":{"type":"integer","description":"Total aggregated number of of documents.","x-example":0,"format":"int32"},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","documentsTotal","documents"]},"usageUsers":{"description":"UsageUsers","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"usersTotal":{"type":"integer","description":"Total aggregated number of statistics of users.","x-example":0,"format":"int32"},"sessionsTotal":{"type":"integer","description":"Total aggregated number of active sessions.","x-example":0,"format":"int32"},"users":{"type":"array","description":"Aggregated number of users per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"sessions":{"type":"array","description":"Aggregated number of active sessions per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","usersTotal","sessionsTotal","users","sessions"]},"usageStorage":{"description":"StorageUsage","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"bucketsTotal":{"type":"integer","description":"Total aggregated number of buckets","x-example":0,"format":"int32"},"filesTotal":{"type":"integer","description":"Total aggregated number of files.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated number of files storage (in bytes).","x-example":0,"format":"int32"},"buckets":{"type":"array","description":"Aggregated number of buckets per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"files":{"type":"array","description":"Aggregated number of files per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"storage":{"type":"array","description":"Aggregated number of files storage (in bytes) per period .","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","bucketsTotal","filesTotal","filesStorageTotal","buckets","files","storage"]},"usageBuckets":{"description":"UsageBuckets","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"filesTotal":{"type":"integer","description":"Total aggregated number of bucket files.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated number of bucket files storage (in bytes).","x-example":0,"format":"int32"},"files":{"type":"array","description":"Aggregated number of bucket files per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"storage":{"type":"array","description":"Aggregated number of bucket storage files (in bytes) per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","filesTotal","filesStorageTotal","files","storage"]},"usageFunctions":{"description":"UsageFunctions","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"functionsTotal":{"type":"integer","description":"Total aggregated number of functions.","x-example":0,"format":"int32"},"deploymentsTotal":{"type":"integer","description":"Total aggregated number of functions deployments.","x-example":0,"format":"int32"},"deploymentsStorageTotal":{"type":"integer","description":"Total aggregated sum of functions deployment storage.","x-example":0,"format":"int32"},"buildsTotal":{"type":"integer","description":"Total aggregated number of functions build.","x-example":0,"format":"int32"},"buildsStorageTotal":{"type":"integer","description":"total aggregated sum of functions build storage.","x-example":0,"format":"int32"},"buildsTimeTotal":{"type":"integer","description":"Total aggregated sum of functions build compute time.","x-example":0,"format":"int32"},"executionsTotal":{"type":"integer","description":"Total aggregated number of functions execution.","x-example":0,"format":"int32"},"executionsTimeTotal":{"type":"integer","description":"Total aggregated sum of functions execution compute time.","x-example":0,"format":"int32"},"functions":{"type":"array","description":"Aggregated number of functions per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":0},"deployments":{"type":"array","description":"Aggregated number of functions deployment per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"deploymentsStorage":{"type":"array","description":"Aggregated number of functions deployment storage per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"builds":{"type":"array","description":"Aggregated number of functions build per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"buildsStorage":{"type":"array","description":"Aggregated sum of functions build storage per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"buildsTime":{"type":"array","description":"Aggregated sum of functions build compute time per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of functions execution per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executionsTime":{"type":"array","description":"Aggregated number of functions execution compute time per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","functionsTotal","deploymentsTotal","deploymentsStorageTotal","buildsTotal","buildsStorageTotal","buildsTimeTotal","executionsTotal","executionsTimeTotal","functions","deployments","deploymentsStorage","builds","buildsStorage","buildsTime","executions","executionsTime"]},"usageFunction":{"description":"UsageFunction","type":"object","properties":{"range":{"type":"string","description":"The time range of the usage stats.","x-example":"30d"},"deploymentsTotal":{"type":"integer","description":"Total aggregated number of function deployments.","x-example":0,"format":"int32"},"deploymentsStorageTotal":{"type":"integer","description":"Total aggregated sum of function deployments storage.","x-example":0,"format":"int32"},"buildsTotal":{"type":"integer","description":"Total aggregated number of function builds.","x-example":0,"format":"int32"},"buildsStorageTotal":{"type":"integer","description":"total aggregated sum of function builds storage.","x-example":0,"format":"int32"},"buildsTimeTotal":{"type":"integer","description":"Total aggregated sum of function builds compute time.","x-example":0,"format":"int32"},"executionsTotal":{"type":"integer","description":"Total aggregated number of function executions.","x-example":0,"format":"int32"},"executionsTimeTotal":{"type":"integer","description":"Total aggregated sum of function executions compute time.","x-example":0,"format":"int32"},"deployments":{"type":"array","description":"Aggregated number of function deployments per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"deploymentsStorage":{"type":"array","description":"Aggregated number of function deployments storage per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"builds":{"type":"array","description":"Aggregated number of function builds per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"buildsStorage":{"type":"array","description":"Aggregated sum of function builds storage per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"buildsTime":{"type":"array","description":"Aggregated sum of function builds compute time per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of function executions per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executionsTime":{"type":"array","description":"Aggregated number of function executions compute time per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]}},"required":["range","deploymentsTotal","deploymentsStorageTotal","buildsTotal","buildsStorageTotal","buildsTimeTotal","executionsTotal","executionsTimeTotal","deployments","deploymentsStorage","builds","buildsStorage","buildsTime","executions","executionsTime"]},"usageProject":{"description":"UsageProject","type":"object","properties":{"executionsTotal":{"type":"integer","description":"Total aggregated number of function executions.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"databasesTotal":{"type":"integer","description":"Total aggregated number of databases.","x-example":0,"format":"int32"},"usersTotal":{"type":"integer","description":"Total aggregated number of users.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated sum of files storage size (in bytes).","x-example":0,"format":"int32"},"bucketsTotal":{"type":"integer","description":"Total aggregated number of buckets.","x-example":0,"format":"int32"},"requests":{"type":"array","description":"Aggregated number of requests per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"network":{"type":"array","description":"Aggregated number of consumed bandwidth per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"users":{"type":"array","description":"Aggregated number of users per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of executions per period.","items":{"$ref":"#\/components\/schemas\/metric"},"x-example":[]},"executionsBreakdown":{"type":"array","description":"Aggregated breakdown in totals of executions by functions.","items":{"$ref":"#\/components\/schemas\/metricBreakdown"},"x-example":[]},"bucketsBreakdown":{"type":"array","description":"Aggregated breakdown in totals of usage by buckets.","items":{"$ref":"#\/components\/schemas\/metricBreakdown"},"x-example":[]}},"required":["executionsTotal","documentsTotal","databasesTotal","usersTotal","filesStorageTotal","bucketsTotal","requests","network","users","executions","executionsBreakdown","bucketsBreakdown"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"proxyRule":{"description":"Rule","type":"object","properties":{"$id":{"type":"string","description":"Rule ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Rule creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Rule update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"domain":{"type":"string","description":"Domain name.","x-example":"appwrite.company.com"},"resourceType":{"type":"string","description":"Action definition for the rule. Possible values are \"api\", \"function\", or \"redirect\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource for the action type. If resourceType is \"api\" or \"url\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"},"status":{"type":"string","description":"Domain verification status. Possible values are \"created\", \"verifying\", \"verified\" and \"unverified\"","x-example":"verified"},"logs":{"type":"string","description":"Certificate generation logs. This will return an empty string if generation did not run, or succeeded.","x-example":"HTTP challegne failed."},"renewAt":{"type":"string","description":"Certificate auto-renewal date in ISO 8601 format.","x-example":"datetime"}},"required":["$id","$createdAt","$updatedAt","domain","resourceType","resourceId","status","logs","renewAt"]},"smsTemplate":{"description":"SmsTemplate","type":"object","properties":{"type":{"type":"string","description":"Template type","x-example":"verification"},"locale":{"type":"string","description":"Template locale","x-example":"en_us"},"message":{"type":"string","description":"Template message","x-example":"Click on the link to verify your account."}},"required":["type","locale","message"]},"emailTemplate":{"description":"EmailTemplate","type":"object","properties":{"type":{"type":"string","description":"Template type","x-example":"verification"},"locale":{"type":"string","description":"Template locale","x-example":"en_us"},"message":{"type":"string","description":"Template message","x-example":"Click on the link to verify your account."},"senderName":{"type":"string","description":"Name of the sender","x-example":"My User"},"senderEmail":{"type":"string","description":"Email of the sender","x-example":"mail@appwrite.io"},"replyTo":{"type":"string","description":"Reply to email address","x-example":"emails@appwrite.io"},"subject":{"type":"string","description":"Email subject","x-example":"Please verify your email address"}},"required":["type","locale","message","senderName","senderEmail","replyTo","subject"]},"consoleVariables":{"description":"Console Variables","type":"object","properties":{"_APP_DOMAIN_TARGET":{"type":"string","description":"CNAME target for your Appwrite custom domains.","x-example":"appwrite.io"},"_APP_STORAGE_LIMIT":{"type":"integer","description":"Maximum file size allowed for file upload in bytes.","x-example":"30000000","format":"int32"},"_APP_FUNCTIONS_SIZE_LIMIT":{"type":"integer","description":"Maximum file size allowed for deployment in bytes.","x-example":"30000000","format":"int32"},"_APP_USAGE_STATS":{"type":"string","description":"Defines if usage stats are enabled. This value is set to 'enabled' by default, to disable the usage stats set the value to 'disabled'.","x-example":"enabled"},"_APP_VCS_ENABLED":{"type":"boolean","description":"Defines if VCS (Version Control System) is enabled.","x-example":true},"_APP_DOMAIN_ENABLED":{"type":"boolean","description":"Defines if main domain is configured. If so, custom domains can be created.","x-example":true},"_APP_ASSISTANT_ENABLED":{"type":"boolean","description":"Defines if AI assistant is enabled.","x-example":true}},"required":["_APP_DOMAIN_TARGET","_APP_STORAGE_LIMIT","_APP_FUNCTIONS_SIZE_LIMIT","_APP_USAGE_STATS","_APP_VCS_ENABLED","_APP_DOMAIN_ENABLED","_APP_ASSISTANT_ENABLED"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"provider":{"description":"Provider","type":"object","properties":{"$id":{"type":"string","description":"Provider ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Provider creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Provider update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name for the provider instance.","x-example":"Mailgun"},"provider":{"type":"string","description":"The name of the provider service.","x-example":"mailgun"},"enabled":{"type":"boolean","description":"Is provider enabled?","x-example":true},"type":{"type":"string","description":"Type of provider.","x-example":"sms"},"credentials":{"type":"object","description":"Provider credentials.","x-example":{"key":"123456789"}},"options":{"type":"object","description":"Provider options.","x-example":{"from":"sender-email@mydomain"},"nullable":true}},"required":["$id","$createdAt","$updatedAt","name","provider","enabled","type","credentials"]},"message":{"description":"Message","type":"object","properties":{"$id":{"type":"string","description":"Message ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Message creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Message update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerType":{"type":"string","description":"Message provider type.","x-example":"email"},"topics":{"type":"array","description":"Topic IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"users":{"type":"array","description":"User IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"targets":{"type":"array","description":"Target IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"scheduledAt":{"type":"string","description":"The scheduled time for message.","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true},"deliveredAt":{"type":"string","description":"The time when the message was delivered.","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true},"deliveryErrors":{"type":"array","description":"Delivery errors if any.","items":{"type":"string"},"x-example":["Failed to send message to target 5e5ea5c16897e: Credentials not valid."],"nullable":true},"deliveredTotal":{"type":"integer","description":"Number of recipients the message was delivered to.","x-example":1,"format":"int32"},"data":{"type":"object","description":"Data of the message.","x-example":{"subject":"Welcome to Appwrite","content":"Hi there, welcome to Appwrite family."}},"status":{"type":"string","description":"Status of delivery.","x-example":"Message status can be one of the following: draft, processing, scheduled, sent, or failed."}},"required":["$id","$createdAt","$updatedAt","providerType","topics","users","targets","deliveredTotal","data","status"]},"topic":{"description":"Topic","type":"object","properties":{"$id":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Topic creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Topic update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name of the topic.","x-example":"events"},"emailTotal":{"type":"integer","description":"Total count of email subscribers subscribed to the topic.","x-example":100,"format":"int32"},"smsTotal":{"type":"integer","description":"Total count of SMS subscribers subscribed to the topic.","x-example":100,"format":"int32"},"pushTotal":{"type":"integer","description":"Total count of push subscribers subscribed to the topic.","x-example":100,"format":"int32"},"subscribe":{"type":"array","description":"Subscribe permissions.","items":{"type":"string"},"x-example":"users"}},"required":["$id","$createdAt","$updatedAt","name","emailTotal","smsTotal","pushTotal","subscribe"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"$ref":"#\/components\/schemas\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]},"migration":{"description":"Migration","type":"object","properties":{"$id":{"type":"string","description":"Migration ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"string","description":"Migration status ( pending, processing, failed, completed ) ","x-example":"pending"},"stage":{"type":"string","description":"Migration stage ( init, processing, source-check, destination-check, migrating, finished )","x-example":"init"},"source":{"type":"string","description":"A string containing the type of source of the migration.","x-example":"Appwrite"},"resources":{"type":"array","description":"Resources to migration.","items":{"type":"string"},"x-example":["user"]},"statusCounters":{"type":"object","description":"A group of counters that represent the total progress of the migration.","x-example":"{\"Database\": {\"PENDING\": 0, \"SUCCESS\": 1, \"ERROR\": 0, \"SKIP\": 0, \"PROCESSING\": 0, \"WARNING\": 0}}"},"resourceData":{"type":"object","description":"An array of objects containing the report data of the resources that were migrated.","x-example":"[{\"resource\":\"Database\",\"id\":\"public\",\"status\":\"SUCCESS\",\"message\":\"\"}]"},"errors":{"type":"array","description":"All errors that occurred during the migration process.","items":{"type":"string"},"x-example":[]}},"required":["$id","$createdAt","$updatedAt","status","stage","source","resources","statusCounters","resourceData","errors"]},"migrationReport":{"description":"Migration Report","type":"object","properties":{"user":{"type":"integer","description":"Number of users to be migrated.","x-example":20,"format":"int32"},"team":{"type":"integer","description":"Number of teams to be migrated.","x-example":20,"format":"int32"},"database":{"type":"integer","description":"Number of databases to be migrated.","x-example":20,"format":"int32"},"document":{"type":"integer","description":"Number of documents to be migrated.","x-example":20,"format":"int32"},"file":{"type":"integer","description":"Number of files to be migrated.","x-example":20,"format":"int32"},"bucket":{"type":"integer","description":"Number of buckets to be migrated.","x-example":20,"format":"int32"},"function":{"type":"integer","description":"Number of functions to be migrated.","x-example":20,"format":"int32"},"size":{"type":"integer","description":"Size of files to be migrated in mb.","x-example":30000,"format":"int32"},"version":{"type":"string","description":"Version of the Appwrite instance to be migrated.","x-example":"1.4.0"}},"required":["user","team","database","document","file","bucket","function","size","version"]},"firebaseProject":{"description":"MigrationFirebaseProject","type":"object","properties":{"projectId":{"type":"string","description":"Project ID.","x-example":"my-project"},"displayName":{"type":"string","description":"Project display name.","x-example":"My Project"}},"required":["projectId","displayName"]}},"securitySchemes":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"Key":{"type":"apiKey","name":"X-Appwrite-Key","description":"Your secret API key","in":"header","x-appwrite":{"demo":"<YOUR_API_KEY>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header"},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Mode":{"type":"apiKey","name":"X-Appwrite-Mode","description":"","in":"header","x-appwrite":{"demo":""}}}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file diff --git a/app/config/specs/open-api3-latest-server.json b/app/config/specs/open-api3-latest-server.json index 1014ce7005..e7db1ae16f 100644 --- a/app/config/specs/open-api3-latest-server.json +++ b/app/config/specs/open-api3-latest-server.json @@ -1 +1 @@ -{"openapi":"3.0.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"servers":[{"url":"https:\/\/cloud.appwrite.io\/v1"}],"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/identityList"}}}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"schema":{"type":"string","x-example":"<IDENTITY_ID>"},"in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","x-example":false}},"required":["mfa"]}}}}}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaType"}}}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","x-example":"<OTP>"}},"required":["otp"]}}}}},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","x-example":"<OTP>"}},"required":["otp"]}}}}}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaChallenge"}}}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}}}},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content","content":{"":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","x-example":"<OTP>"}},"required":["challengeId","otp"]}}}}}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaFactors"}}}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["name"]}}}}}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","x-example":"password"}},"required":["password"]}}}}}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["phone","password"]}}}}}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["email","url"]}}}}},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null}},"required":["userId","secret","password"]}}}}}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/sessionList"}}}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"File"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"schema":{"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"}},"required":["userId","phone"]}}}}}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["url"]}}}}},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"schema":{"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"schema":{"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"schema":{"type":"string","x-example":"<NAME>","default":""},"in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"schema":{"type":"string","default":""},"in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"schema":{"type":"string","x-example":"<TEXT>"},"in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":1,"default":400},"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":1},"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"schema":{"type":"boolean","x-example":false,"default":false},"in":"query"}]}},"\/databases":{"get":{"summary":"List databases","operationId":"databasesList","tags":["databases"],"description":"Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.","responses":{"200":{"description":"Databases List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/databaseList"}}}}},"x-appwrite":{"method":"list","weight":69,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create database","operationId":"databasesCreate","tags":["databases"],"description":"Create a new Database.\n","responses":{"201":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"create","weight":68,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"databaseId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<DATABASE_ID>"},"name":{"type":"string","description":"Database name. Max length: 128 chars.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","x-example":false}},"required":["databaseId","name"]}}}}}},"\/databases\/{databaseId}":{"get":{"summary":"Get database","operationId":"databasesGet","tags":["databases"],"description":"Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.","responses":{"200":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"get","weight":70,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}]},"put":{"summary":"Update database","operationId":"databasesUpdate","tags":["databases"],"description":"Update a database by its unique ID.","responses":{"200":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"update","weight":72,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Database name. Max length: 128 chars.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete database","operationId":"databasesDelete","tags":["databases"],"description":"Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":73,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}]}},"\/databases\/{databaseId}\/collections":{"get":{"summary":"List collections","operationId":"databasesListCollections","tags":["databases"],"description":"Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.","responses":{"200":{"description":"Collections List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collectionList"}}}}},"x-appwrite":{"method":"listCollections","weight":75,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collections.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"queries","description":"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: name, enabled, documentSecurity","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create collection","operationId":"databasesCreateCollection","tags":["databases"],"description":"Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"createCollection","weight":74,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"collectionId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<COLLECTION_ID>"},"name":{"type":"string","description":"Collection name. Max length: 128 chars.","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","x-example":false}},"required":["collectionId","name"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}":{"get":{"summary":"Get collection","operationId":"databasesGetCollection","tags":["databases"],"description":"Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.","responses":{"200":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"getCollection","weight":76,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}]},"put":{"summary":"Update collection","operationId":"databasesUpdateCollection","tags":["databases"],"description":"Update a collection by its unique ID.","responses":{"200":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"updateCollection","weight":78,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name. Max length: 128 chars.","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete collection","operationId":"databasesDeleteCollection","tags":["databases"],"description":"Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteCollection","weight":79,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes":{"get":{"summary":"List attributes","operationId":"databasesListAttributes","tags":["databases"],"description":"List attributes in the collection.","responses":{"200":{"description":"Attributes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeList"}}}}},"x-appwrite":{"method":"listAttributes","weight":90,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-attributes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"queries","description":"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: key, type, size, required, array, status, error","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean":{"post":{"summary":"Create boolean attribute","operationId":"databasesCreateBooleanAttribute","tags":["databases"],"description":"Create a boolean attribute.\n","responses":{"202":{"description":"AttributeBoolean","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeBoolean"}}}}},"x-appwrite":{"method":"createBooleanAttribute","weight":87,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}":{"patch":{"summary":"Update boolean attribute","operationId":"databasesUpdateBooleanAttribute","tags":["databases"],"description":"Update a boolean attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeBoolean","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeBoolean"}}}}},"x-appwrite":{"method":"updateBooleanAttribute","weight":99,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime":{"post":{"summary":"Create datetime attribute","operationId":"databasesCreateDatetimeAttribute","tags":["databases"],"description":"Create a date time attribute according to the ISO 8601 standard.","responses":{"202":{"description":"AttributeDatetime","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeDatetime"}}}}},"x-appwrite":{"method":"createDatetimeAttribute","weight":88,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}":{"patch":{"summary":"Update dateTime attribute","operationId":"databasesUpdateDatetimeAttribute","tags":["databases"],"description":"Update a date time attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeDatetime","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeDatetime"}}}}},"x-appwrite":{"method":"updateDatetimeAttribute","weight":100,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email":{"post":{"summary":"Create email attribute","operationId":"databasesCreateEmailAttribute","tags":["databases"],"description":"Create an email attribute.\n","responses":{"202":{"description":"AttributeEmail","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeEmail"}}}}},"x-appwrite":{"method":"createEmailAttribute","weight":81,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"email@example.com"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}":{"patch":{"summary":"Update email attribute","operationId":"databasesUpdateEmailAttribute","tags":["databases"],"description":"Update an email attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEmail","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeEmail"}}}}},"x-appwrite":{"method":"updateEmailAttribute","weight":93,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"email@example.com","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum":{"post":{"summary":"Create enum attribute","operationId":"databasesCreateEnumAttribute","tags":["databases"],"description":"Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n","responses":{"202":{"description":"AttributeEnum","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeEnum"}}}}},"x-appwrite":{"method":"createEnumAttribute","weight":82,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","elements","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}":{"patch":{"summary":"Update enum attribute","operationId":"databasesUpdateEnumAttribute","tags":["databases"],"description":"Update an enum attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEnum","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeEnum"}}}}},"x-appwrite":{"method":"updateEnumAttribute","weight":94,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>","x-nullable":true}},"required":["elements","required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float":{"post":{"summary":"Create float attribute","operationId":"databasesCreateFloatAttribute","tags":["databases"],"description":"Create a float attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeFloat","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeFloat"}}}}},"x-appwrite":{"method":"createFloatAttribute","weight":86,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float\/{key}":{"patch":{"summary":"Update float attribute","operationId":"databasesUpdateFloatAttribute","tags":["databases"],"description":"Update a float attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeFloat","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeFloat"}}}}},"x-appwrite":{"method":"updateFloatAttribute","weight":98,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer":{"post":{"summary":"Create integer attribute","operationId":"databasesCreateIntegerAttribute","tags":["databases"],"description":"Create an integer attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeInteger","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeInteger"}}}}},"x-appwrite":{"method":"createIntegerAttribute","weight":85,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer\/{key}":{"patch":{"summary":"Update integer attribute","operationId":"databasesUpdateIntegerAttribute","tags":["databases"],"description":"Update an integer attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeInteger","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeInteger"}}}}},"x-appwrite":{"method":"updateIntegerAttribute","weight":97,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip":{"post":{"summary":"Create IP address attribute","operationId":"databasesCreateIpAttribute","tags":["databases"],"description":"Create IP address attribute.\n","responses":{"202":{"description":"AttributeIP","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeIp"}}}}},"x-appwrite":{"method":"createIpAttribute","weight":83,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}":{"patch":{"summary":"Update IP address attribute","operationId":"databasesUpdateIpAttribute","tags":["databases"],"description":"Update an ip attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeIP","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeIp"}}}}},"x-appwrite":{"method":"updateIpAttribute","weight":95,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship":{"post":{"summary":"Create relationship attribute","operationId":"databasesCreateRelationshipAttribute","tags":["databases"],"description":"Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"202":{"description":"AttributeRelationship","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeRelationship"}}}}},"x-appwrite":{"method":"createRelationshipAttribute","weight":89,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"relatedCollectionId":{"type":"string","description":"Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","x-example":"<RELATED_COLLECTION_ID>"},"type":{"type":"string","description":"Relation type","x-example":"oneToOne","enum":["oneToOne","manyToOne","manyToMany","oneToMany"],"x-enum-name":"RelationshipType","x-enum-keys":[]},"twoWay":{"type":"boolean","description":"Is Two Way?","x-example":false},"key":{"type":"string","description":"Attribute Key.","x-example":null},"twoWayKey":{"type":"string","description":"Two Way Attribute Key.","x-example":null},"onDelete":{"type":"string","description":"Constraints option","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}},"required":["relatedCollectionId","type"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string":{"post":{"summary":"Create string attribute","operationId":"databasesCreateStringAttribute","tags":["databases"],"description":"Create a string attribute.\n","responses":{"202":{"description":"AttributeString","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeString"}}}}},"x-appwrite":{"method":"createStringAttribute","weight":80,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"size":{"type":"integer","description":"Attribute size for text attributes, in number of characters.","x-example":1},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false},"encrypt":{"type":"boolean","description":"Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.","x-example":false}},"required":["key","size","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}":{"patch":{"summary":"Update string attribute","operationId":"databasesUpdateStringAttribute","tags":["databases"],"description":"Update a string attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeString","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeString"}}}}},"x-appwrite":{"method":"updateStringAttribute","weight":92,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url":{"post":{"summary":"Create URL attribute","operationId":"databasesCreateUrlAttribute","tags":["databases"],"description":"Create a URL attribute.\n","responses":{"202":{"description":"AttributeURL","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeUrl"}}}}},"x-appwrite":{"method":"createUrlAttribute","weight":84,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"https:\/\/example.com"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}":{"patch":{"summary":"Update URL attribute","operationId":"databasesUpdateUrlAttribute","tags":["databases"],"description":"Update an url attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeURL","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeUrl"}}}}},"x-appwrite":{"method":"updateUrlAttribute","weight":96,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"https:\/\/example.com","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}":{"get":{"summary":"Get attribute","operationId":"databasesGetAttribute","tags":["databases"],"description":"Get attribute by ID.","responses":{"200":{"description":"AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]}}}}},"x-appwrite":{"method":"getAttribute","weight":91,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}]},"delete":{"summary":"Delete attribute","operationId":"databasesDeleteAttribute","tags":["databases"],"description":"Deletes an attribute.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteAttribute","weight":102,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship":{"patch":{"summary":"Update relationship attribute","operationId":"databasesUpdateRelationshipAttribute","tags":["databases"],"description":"Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"200":{"description":"AttributeRelationship","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeRelationship"}}}}},"x-appwrite":{"method":"updateRelationshipAttribute","weight":101,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"onDelete":{"type":"string","description":"Constraints option","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}}}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/documentList"}}}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":"<DOCUMENT_ID>"},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":"<DOCUMENT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":"<DOCUMENT_ID>"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes":{"get":{"summary":"List indexes","operationId":"databasesListIndexes","tags":["databases"],"description":"List indexes in the collection.","responses":{"200":{"description":"Indexes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/indexList"}}}}},"x-appwrite":{"method":"listIndexes","weight":104,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-indexes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"queries","description":"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: key, type, status, attributes, error","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create index","operationId":"databasesCreateIndex","tags":["databases"],"description":"Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.","responses":{"202":{"description":"Index","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/index"}}}}},"x-appwrite":{"method":"createIndex","weight":103,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":null},"type":{"type":"string","description":"Index type.","x-example":"key","enum":["key","fulltext","unique"],"x-enum-name":"IndexType","x-enum-keys":[]},"attributes":{"type":"array","description":"Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}},"orders":{"type":"array","description":"Array of index orders. Maximum of 100 orders are allowed.","x-example":null,"items":{"type":"string"}}},"required":["key","type","attributes"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}":{"get":{"summary":"Get index","operationId":"databasesGetIndex","tags":["databases"],"description":"Get index by ID.","responses":{"200":{"description":"Index","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/index"}}}}},"x-appwrite":{"method":"getIndex","weight":105,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Index Key.","required":true,"schema":{"type":"string"},"in":"path"}]},"delete":{"summary":"Delete index","operationId":"databasesDeleteIndex","tags":["databases"],"description":"Delete an index.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIndex","weight":106,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Index Key.","required":true,"schema":{"type":"string"},"in":"path"}]}},"\/functions":{"get":{"summary":"List functions","operationId":"functionsList","tags":["functions"],"description":"Get a list of all the project's functions. You can use the query params to filter your results.","responses":{"200":{"description":"Functions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/functionList"}}}}},"x-appwrite":{"method":"list","weight":287,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create function","operationId":"functionsCreate","tags":["functions"],"description":"Create a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.","responses":{"201":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"create","weight":286,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"functionId":{"type":"string","description":"Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<FUNCTION_ID>"},"name":{"type":"string","description":"Function name. Max length: 128 chars.","x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.21","deno-1.24","deno-1.35","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","x-example":null},"timeout":{"type":"integer","description":"Function maximum execution time in seconds.","x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Control System) deployment.","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function.","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function.","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","x-example":"<PROVIDER_ROOT_DIRECTORY>"},"templateRepository":{"type":"string","description":"Repository name of the template.","x-example":"<TEMPLATE_REPOSITORY>"},"templateOwner":{"type":"string","description":"The name of the owner of the template.","x-example":"<TEMPLATE_OWNER>"},"templateRootDirectory":{"type":"string","description":"Path to function code in the template repo.","x-example":"<TEMPLATE_ROOT_DIRECTORY>"},"templateBranch":{"type":"string","description":"Production branch for the repo linked to the function template.","x-example":"<TEMPLATE_BRANCH>"}},"required":["functionId","name","runtime"]}}}}}},"\/functions\/runtimes":{"get":{"summary":"List runtimes","operationId":"functionsListRuntimes","tags":["functions"],"description":"Get a list of all runtimes that are currently active on your instance.","responses":{"200":{"description":"Runtimes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/runtimeList"}}}}},"x-appwrite":{"method":"listRuntimes","weight":288,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-runtimes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-runtimes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/functions\/{functionId}":{"get":{"summary":"Get function","operationId":"functionsGet","tags":["functions"],"description":"Get a function by its unique ID.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"get","weight":289,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}]},"put":{"summary":"Update function","operationId":"functionsUpdate","tags":["functions"],"description":"Update function by its unique ID.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"update","weight":292,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Function name. Max length: 128 chars.","x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.21","deno-1.24","deno-1.35","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","x-example":null},"timeout":{"type":"integer","description":"Maximum execution time in seconds.","x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Controle System) deployment.","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","x-example":"<PROVIDER_ROOT_DIRECTORY>"}},"required":["name"]}}}}},"delete":{"summary":"Delete function","operationId":"functionsDelete","tags":["functions"],"description":"Delete a function by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":295,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/deployments":{"get":{"summary":"List deployments","operationId":"functionsListDeployments","tags":["functions"],"description":"Get a list of all the project's code deployments. You can use the query params to filter your results.","responses":{"200":{"description":"Deployments List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deploymentList"}}}}},"x-appwrite":{"method":"listDeployments","weight":297,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"queries","description":"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: size, buildId, activate, entrypoint, commands","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create deployment","operationId":"functionsCreateDeployment","tags":["functions"],"description":"Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.","responses":{"202":{"description":"Deployment","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deployment"}}}}},"x-appwrite":{"method":"createDeployment","weight":296,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":true,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"entrypoint":{"type":"string","description":"Entrypoint File.","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","x-example":"<COMMANDS>"},"code":{"type":"string","description":"Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.","x-example":null},"activate":{"type":"boolean","description":"Automatically activate the deployment when it is finished building.","x-example":false}},"required":["code","activate"]}}}}}},"\/functions\/{functionId}\/deployments\/{deploymentId}":{"get":{"summary":"Get deployment","operationId":"functionsGetDeployment","tags":["functions"],"description":"Get a code deployment by its unique ID.","responses":{"200":{"description":"Deployment","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deployment"}}}}},"x-appwrite":{"method":"getDeployment","weight":298,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]},"patch":{"summary":"Update function deployment","operationId":"functionsUpdateDeployment","tags":["functions"],"description":"Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"updateDeployment","weight":294,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]},"delete":{"summary":"Delete deployment","operationId":"functionsDeleteDeployment","tags":["functions"],"description":"Delete a code deployment by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDeployment","weight":299,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/build":{"post":{"summary":"Rebuild deployment","operationId":"functionsCreateBuild","tags":["functions"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createBuild","weight":300,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"buildId":{"type":"string","description":"Build unique ID.","x-example":"<BUILD_ID>"}}}}}}},"patch":{"summary":"Cancel deployment","operationId":"functionsUpdateDeploymentBuild","tags":["functions"],"description":"","responses":{"200":{"description":"Build","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/build"}}}}},"x-appwrite":{"method":"updateDeploymentBuild","weight":301,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/download":{"get":{"summary":"Download Deployment","operationId":"functionsDownloadDeployment","tags":["functions"],"description":"Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"downloadDeployment","weight":293,"cookies":false,"type":"location","deprecated":false,"demo":"functions\/download-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/download-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/executionList"}}}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"schema":{"type":"string","x-example":"<EXECUTION_ID>"},"in":"path"}]},"delete":{"summary":"Delete execution","operationId":"functionsDeleteExecution","tags":["functions"],"description":"Delete a function execution by its unique ID.\n","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteExecution","weight":305,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"schema":{"type":"string","x-example":"<EXECUTION_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/variables":{"get":{"summary":"List variables","operationId":"functionsListVariables","tags":["functions"],"description":"Get a list of all variables of a specific function.","responses":{"200":{"description":"Variables List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variableList"}}}}},"x-appwrite":{"method":"listVariables","weight":307,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}]},"post":{"summary":"Create variable","operationId":"functionsCreateVariable","tags":["functions"],"description":"Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.","responses":{"201":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"createVariable","weight":306,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":"<VALUE>"}},"required":["key","value"]}}}}}},"\/functions\/{functionId}\/variables\/{variableId}":{"get":{"summary":"Get variable","operationId":"functionsGetVariable","tags":["functions"],"description":"Get a variable by its unique ID.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"getVariable","weight":308,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}]},"put":{"summary":"Update variable","operationId":"functionsUpdateVariable","tags":["functions"],"description":"Update variable by its unique ID.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"updateVariable","weight":309,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":"<VALUE>"}},"required":["key"]}}}}},"delete":{"summary":"Delete variable","operationId":"functionsDeleteVariable","tags":["functions"],"description":"Delete a variable by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":310,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[],"Session":[],"JWT":[]}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[],"Session":[],"JWT":[]}]}},"\/health":{"get":{"summary":"Get HTTP","operationId":"healthGet","tags":["health"],"description":"Check the Appwrite HTTP server is up and responsive.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"get","weight":124,"cookies":false,"type":"","deprecated":false,"demo":"health\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/anti-virus":{"get":{"summary":"Get antivirus","operationId":"healthGetAntivirus","tags":["health"],"description":"Check the Appwrite Antivirus server is up and connection is successful.","responses":{"200":{"description":"Health Antivirus","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthAntivirus"}}}}},"x-appwrite":{"method":"getAntivirus","weight":146,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-antivirus.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/cache":{"get":{"summary":"Get cache","operationId":"healthGetCache","tags":["health"],"description":"Check the Appwrite in-memory cache servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getCache","weight":127,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-cache.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/certificate":{"get":{"summary":"Get the SSL certificate for a domain","operationId":"healthGetCertificate","tags":["health"],"description":"Get the SSL certificate for a domain","responses":{"200":{"description":"Health Certificate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthCertificate"}}}}},"x-appwrite":{"method":"getCertificate","weight":133,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-certificate.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"domain","description":"string","required":false,"schema":{"type":"string"},"in":"query"}]}},"\/health\/db":{"get":{"summary":"Get DB","operationId":"healthGetDB","tags":["health"],"description":"Check the Appwrite database servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getDB","weight":126,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-d-b.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/pubsub":{"get":{"summary":"Get pubsub","operationId":"healthGetPubSub","tags":["health"],"description":"Check the Appwrite pub-sub servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getPubSub","weight":129,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-pub-sub.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue":{"get":{"summary":"Get queue","operationId":"healthGetQueue","tags":["health"],"description":"Check the Appwrite queue messaging servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getQueue","weight":128,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue\/builds":{"get":{"summary":"Get builds queue","operationId":"healthGetQueueBuilds","tags":["health"],"description":"Get the number of builds that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueBuilds","weight":135,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-builds.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/certificates":{"get":{"summary":"Get certificates queue","operationId":"healthGetQueueCertificates","tags":["health"],"description":"Get the number of certificates that are waiting to be issued against [Letsencrypt](https:\/\/letsencrypt.org\/) in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueCertificates","weight":134,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-certificates.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/databases":{"get":{"summary":"Get databases queue","operationId":"healthGetQueueDatabases","tags":["health"],"description":"Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueDatabases","weight":136,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-databases.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"Queue name for which to check the queue size","required":false,"schema":{"type":"string","x-example":"<NAME>","default":"database_db_main"},"in":"query"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/deletes":{"get":{"summary":"Get deletes queue","operationId":"healthGetQueueDeletes","tags":["health"],"description":"Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueDeletes","weight":137,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-deletes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/failed\/{name}":{"get":{"summary":"Get number of failed queue jobs","operationId":"healthGetFailedJobs","tags":["health"],"description":"Returns the amount of failed jobs in a given queue.\n","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getFailedJobs","weight":147,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-failed-jobs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"The name of the queue","required":true,"schema":{"type":"string","x-example":"v1-database","enum":["v1-database","v1-deletes","v1-audits","v1-mails","v1-functions","v1-usage","v1-usage-dump","v1-webhooks","v1-certificates","v1-builds","v1-messaging","v1-migrations"],"x-enum-name":null,"x-enum-keys":[]},"in":"path"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/functions":{"get":{"summary":"Get functions queue","operationId":"healthGetQueueFunctions","tags":["health"],"description":"Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueFunctions","weight":141,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-functions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/logs":{"get":{"summary":"Get logs queue","operationId":"healthGetQueueLogs","tags":["health"],"description":"Get the number of logs that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueLogs","weight":132,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/mails":{"get":{"summary":"Get mails queue","operationId":"healthGetQueueMails","tags":["health"],"description":"Get the number of mails that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMails","weight":138,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-mails.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/messaging":{"get":{"summary":"Get messaging queue","operationId":"healthGetQueueMessaging","tags":["health"],"description":"Get the number of messages that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMessaging","weight":139,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-messaging.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/migrations":{"get":{"summary":"Get migrations queue","operationId":"healthGetQueueMigrations","tags":["health"],"description":"Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMigrations","weight":140,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-migrations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/usage":{"get":{"summary":"Get usage queue","operationId":"healthGetQueueUsage","tags":["health"],"description":"Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueUsage","weight":142,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/usage-dump":{"get":{"summary":"Get usage dump queue","operationId":"healthGetQueueUsageDump","tags":["health"],"description":"Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueUsageDump","weight":143,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage-dump.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage-dump.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/webhooks":{"get":{"summary":"Get webhooks queue","operationId":"healthGetQueueWebhooks","tags":["health"],"description":"Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueWebhooks","weight":131,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/storage":{"get":{"summary":"Get storage","operationId":"healthGetStorage","tags":["health"],"description":"Check the Appwrite storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getStorage","weight":145,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/storage\/local":{"get":{"summary":"Get local storage","operationId":"healthGetStorageLocal","tags":["health"],"description":"Check the Appwrite local storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getStorageLocal","weight":144,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage-local.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/time":{"get":{"summary":"Get time","operationId":"healthGetTime","tags":["health"],"description":"Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https:\/\/en.wikipedia.org\/wiki\/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.","responses":{"200":{"description":"Health Time","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthTime"}}}}},"x-appwrite":{"method":"getTime","weight":130,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-time.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/locale"}}}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/localeCodeList"}}}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/continentList"}}}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/phoneList"}}}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/currencyList"}}}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/languageList"}}}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/messaging\/messages":{"get":{"summary":"List messages","operationId":"messagingListMessages","tags":["messaging"],"description":"Get a list of all messages from the current Appwrite project.","responses":{"200":{"description":"Message list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/messageList"}}}}},"x-appwrite":{"method":"listMessages","weight":385,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-messages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/messaging\/messages\/email":{"post":{"summary":"Create email","operationId":"messagingCreateEmail","tags":["messaging"],"description":"Create a new email message.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createEmail","weight":382,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<MESSAGE_ID>"},"subject":{"type":"string","description":"Email Subject.","x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","x-example":null,"items":{"type":"string"}},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","subject","content"]}}}}}},"\/messaging\/messages\/email\/{messageId}":{"patch":{"summary":"Update email","operationId":"messagingUpdateEmail","tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updateEmail","weight":389,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"subject":{"type":"string","description":"Email Subject.","x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","x-example":false},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","x-example":null,"items":{"type":"string"}},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":null,"items":{"type":"string"}}}}}}}}},"\/messaging\/messages\/push":{"post":{"summary":"Create push notification","operationId":"messagingCreatePush","tags":["messaging"],"description":"Create a new push notification.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createPush","weight":384,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<MESSAGE_ID>"},"title":{"type":"string","description":"Title for push notification.","x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","x-example":"<BODY>"},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"data":{"type":"object","description":"Additional Data for push notification.","x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web Platform.","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and IOS Platform.","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android Platform.","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android Platform.","x-example":"<TAG>"},"badge":{"type":"string","description":"Badge for push notification. Available only for IOS Platform.","x-example":"<BADGE>"},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","title","body"]}}}}}},"\/messaging\/messages\/push\/{messageId}":{"patch":{"summary":"Update push notification","operationId":"messagingUpdatePush","tags":["messaging"],"description":"Update a push notification by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updatePush","weight":391,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"title":{"type":"string","description":"Title for push notification.","x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","x-example":"<BODY>"},"data":{"type":"object","description":"Additional Data for push notification.","x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web platforms.","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and iOS platforms.","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android platforms.","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android platforms.","x-example":"<TAG>"},"badge":{"type":"integer","description":"Badge for push notification. Available only for iOS platforms.","x-example":null},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/messaging\/messages\/sms":{"post":{"summary":"Create SMS","operationId":"messagingCreateSms","tags":["messaging"],"description":"Create a new SMS message.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createSms","weight":383,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<MESSAGE_ID>"},"content":{"type":"string","description":"SMS Content.","x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","content"]}}}}}},"\/messaging\/messages\/sms\/{messageId}":{"patch":{"summary":"Update SMS","operationId":"messagingUpdateSms","tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updateSms","weight":390,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"content":{"type":"string","description":"Email Content.","x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/messaging\/messages\/{messageId}":{"get":{"summary":"Get message","operationId":"messagingGetMessage","tags":["messaging"],"description":"Get a message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"getMessage","weight":388,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-message.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}]},"delete":{"summary":"Delete message","operationId":"messagingDelete","tags":["messaging"],"description":"Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":392,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}]}},"\/messaging\/messages\/{messageId}\/logs":{"get":{"summary":"List message logs","operationId":"messagingListMessageLogs","tags":["messaging"],"description":"Get the message activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listMessageLogs","weight":386,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-message-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/messages\/{messageId}\/targets":{"get":{"summary":"List message targets","operationId":"messagingListTargets","tags":["messaging"],"description":"Get a list of the targets associated with a message.","responses":{"200":{"description":"Target list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/targetList"}}}}},"x-appwrite":{"method":"listTargets","weight":387,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"},{"name":"queries","description":"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, providerId, identifier, providerType","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/providers":{"get":{"summary":"List providers","operationId":"messagingListProviders","tags":["messaging"],"description":"Get a list of all providers from the current Appwrite project.","responses":{"200":{"description":"Provider list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/providerList"}}}}},"x-appwrite":{"method":"listProviders","weight":357,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-providers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, provider, type, enabled","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/messaging\/providers\/apns":{"post":{"summary":"Create APNS provider","operationId":"messagingCreateApnsProvider","tags":["messaging"],"description":"Create a new Apple Push Notification service provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createApnsProvider","weight":356,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"authKey":{"type":"string","description":"APNS authentication key.","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/apns\/{providerId}":{"patch":{"summary":"Update APNS provider","operationId":"messagingUpdateApnsProvider","tags":["messaging"],"description":"Update a Apple Push Notification service provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateApnsProvider","weight":369,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"authKey":{"type":"string","description":"APNS authentication key.","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","x-example":false}}}}}}}},"\/messaging\/providers\/fcm":{"post":{"summary":"Create FCM provider","operationId":"messagingCreateFcmProvider","tags":["messaging"],"description":"Create a new Firebase Cloud Messaging provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createFcmProvider","weight":355,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","x-example":"{}"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/fcm\/{providerId}":{"patch":{"summary":"Update FCM provider","operationId":"messagingUpdateFcmProvider","tags":["messaging"],"description":"Update a Firebase Cloud Messaging provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateFcmProvider","weight":368,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","x-example":"{}"}}}}}}}},"\/messaging\/providers\/mailgun":{"post":{"summary":"Create Mailgun provider","operationId":"messagingCreateMailgunProvider","tags":["messaging"],"description":"Create a new Mailgun provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createMailgunProvider","weight":347,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","x-example":false},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/mailgun\/{providerId}":{"patch":{"summary":"Update Mailgun provider","operationId":"messagingUpdateMailgunProvider","tags":["messaging"],"description":"Update a Mailgun provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateMailgunProvider","weight":360,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"<REPLY_TO_EMAIL>"}}}}}}}},"\/messaging\/providers\/msg91":{"post":{"summary":"Create Msg91 provider","operationId":"messagingCreateMsg91Provider","tags":["messaging"],"description":"Create a new MSG91 provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createMsg91Provider","weight":350,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"templateId":{"type":"string","description":"Msg91 template ID","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","x-example":"<AUTH_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/msg91\/{providerId}":{"patch":{"summary":"Update Msg91 provider","operationId":"messagingUpdateMsg91Provider","tags":["messaging"],"description":"Update a MSG91 provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateMsg91Provider","weight":363,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"templateId":{"type":"string","description":"Msg91 template ID.","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","x-example":"<AUTH_KEY>"}}}}}}}},"\/messaging\/providers\/sendgrid":{"post":{"summary":"Create Sendgrid provider","operationId":"messagingCreateSendgridProvider","tags":["messaging"],"description":"Create a new Sendgrid provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createSendgridProvider","weight":348,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Sendgrid API key.","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/sendgrid\/{providerId}":{"patch":{"summary":"Update Sendgrid provider","operationId":"messagingUpdateSendgridProvider","tags":["messaging"],"description":"Update a Sendgrid provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateSendgridProvider","weight":361,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"apiKey":{"type":"string","description":"Sendgrid API key.","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","x-example":"<REPLY_TO_EMAIL>"}}}}}}}},"\/messaging\/providers\/smtp":{"post":{"summary":"Create SMTP provider","operationId":"messagingCreateSmtpProvider","tags":["messaging"],"description":"Create a new SMTP provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createSmtpProvider","weight":349,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","x-example":"<HOST>"},"port":{"type":"integer","description":"The default SMTP server port.","x-example":1},"username":{"type":"string","description":"Authentication username.","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be omitted, 'ssl', or 'tls'","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name","host"]}}}}}},"\/messaging\/providers\/smtp\/{providerId}":{"patch":{"summary":"Update SMTP provider","operationId":"messagingUpdateSmtpProvider","tags":["messaging"],"description":"Update a SMTP provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateSmtpProvider","weight":362,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","x-example":"<HOST>"},"port":{"type":"integer","description":"SMTP port.","x-example":1},"username":{"type":"string","description":"Authentication username.","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be 'ssl' or 'tls'","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","x-example":"<REPLY_TO_EMAIL>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}}}}}}}},"\/messaging\/providers\/telesign":{"post":{"summary":"Create Telesign provider","operationId":"messagingCreateTelesignProvider","tags":["messaging"],"description":"Create a new Telesign provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTelesignProvider","weight":351,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"customerId":{"type":"string","description":"Telesign customer ID.","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/telesign\/{providerId}":{"patch":{"summary":"Update Telesign provider","operationId":"messagingUpdateTelesignProvider","tags":["messaging"],"description":"Update a Telesign provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTelesignProvider","weight":364,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"customerId":{"type":"string","description":"Telesign customer ID.","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/textmagic":{"post":{"summary":"Create Textmagic provider","operationId":"messagingCreateTextmagicProvider","tags":["messaging"],"description":"Create a new Textmagic provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTextmagicProvider","weight":352,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"username":{"type":"string","description":"Textmagic username.","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/textmagic\/{providerId}":{"patch":{"summary":"Update Textmagic provider","operationId":"messagingUpdateTextmagicProvider","tags":["messaging"],"description":"Update a Textmagic provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTextmagicProvider","weight":365,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"username":{"type":"string","description":"Textmagic username.","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/twilio":{"post":{"summary":"Create Twilio provider","operationId":"messagingCreateTwilioProvider","tags":["messaging"],"description":"Create a new Twilio provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTwilioProvider","weight":353,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"accountSid":{"type":"string","description":"Twilio account secret ID.","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","x-example":"<AUTH_TOKEN>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/twilio\/{providerId}":{"patch":{"summary":"Update Twilio provider","operationId":"messagingUpdateTwilioProvider","tags":["messaging"],"description":"Update a Twilio provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTwilioProvider","weight":366,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"accountSid":{"type":"string","description":"Twilio account secret ID.","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","x-example":"<AUTH_TOKEN>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/vonage":{"post":{"summary":"Create Vonage provider","operationId":"messagingCreateVonageProvider","tags":["messaging"],"description":"Create a new Vonage provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createVonageProvider","weight":354,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"apiKey":{"type":"string","description":"Vonage API key.","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","x-example":"<API_SECRET>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/vonage\/{providerId}":{"patch":{"summary":"Update Vonage provider","operationId":"messagingUpdateVonageProvider","tags":["messaging"],"description":"Update a Vonage provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateVonageProvider","weight":367,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"apiKey":{"type":"string","description":"Vonage API key.","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","x-example":"<API_SECRET>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/{providerId}":{"get":{"summary":"Get provider","operationId":"messagingGetProvider","tags":["messaging"],"description":"Get a provider by its unique ID.\n","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"getProvider","weight":359,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}]},"delete":{"summary":"Delete provider","operationId":"messagingDeleteProvider","tags":["messaging"],"description":"Delete a provider by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteProvider","weight":370,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}]}},"\/messaging\/providers\/{providerId}\/logs":{"get":{"summary":"List provider logs","operationId":"messagingListProviderLogs","tags":["messaging"],"description":"Get the provider activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listProviderLogs","weight":358,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-provider-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/subscribers\/{subscriberId}\/logs":{"get":{"summary":"List subscriber logs","operationId":"messagingListSubscriberLogs","tags":["messaging"],"description":"Get the subscriber activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listSubscriberLogs","weight":379,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscriber-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/topics":{"get":{"summary":"List topics","operationId":"messagingListTopics","tags":["messaging"],"description":"Get a list of all topics from the current Appwrite project.","responses":{"200":{"description":"Topic list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topicList"}}}}},"x-appwrite":{"method":"listTopics","weight":372,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topics.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, description, emailTotal, smsTotal, pushTotal","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create topic","operationId":"messagingCreateTopic","tags":["messaging"],"description":"Create a new topic.","responses":{"201":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"createTopic","weight":371,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topicId":{"type":"string","description":"Topic ID. Choose a custom Topic ID or a new Topic ID.","x-example":"<TOPIC_ID>"},"name":{"type":"string","description":"Topic Name.","x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}}},"required":["topicId","name"]}}}}}},"\/messaging\/topics\/{topicId}":{"get":{"summary":"Get topic","operationId":"messagingGetTopic","tags":["messaging"],"description":"Get a topic by its unique ID.\n","responses":{"200":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"getTopic","weight":374,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}]},"patch":{"summary":"Update topic","operationId":"messagingUpdateTopic","tags":["messaging"],"description":"Update a topic by its unique ID.\n","responses":{"200":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"updateTopic","weight":375,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Topic Name.","x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete topic","operationId":"messagingDeleteTopic","tags":["messaging"],"description":"Delete a topic by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTopic","weight":376,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}]}},"\/messaging\/topics\/{topicId}\/logs":{"get":{"summary":"List topic logs","operationId":"messagingListTopicLogs","tags":["messaging"],"description":"Get the topic activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listTopicLogs","weight":373,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topic-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"get":{"summary":"List subscribers","operationId":"messagingListSubscribers","tags":["messaging"],"description":"Get a list of all subscribers from the current Appwrite project.","responses":{"200":{"description":"Subscriber list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriberList"}}}}},"x-appwrite":{"method":"listSubscribers","weight":378,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscribers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"queries","description":"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: name, provider, type, enabled","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriber"}}}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"JWT":[]}},"security":[{"Project":[],"JWT":[],"Session":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}}}}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"get":{"summary":"Get subscriber","operationId":"messagingGetSubscriber","tags":["messaging"],"description":"Get a subscriber by its unique ID.\n","responses":{"200":{"description":"Subscriber","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriber"}}}}},"x-appwrite":{"method":"getSubscriber","weight":380,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"}]},"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"JWT":[]}},"security":[{"Project":[],"JWT":[],"Session":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"}]}},"\/storage\/buckets":{"get":{"summary":"List buckets","operationId":"storageListBuckets","tags":["storage"],"description":"Get a list of all the storage buckets. You can use the query params to filter your results.","responses":{"200":{"description":"Buckets List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucketList"}}}}},"x-appwrite":{"method":"listBuckets","weight":201,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-buckets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create bucket","operationId":"storageCreateBucket","tags":["storage"],"description":"Create a new storage bucket.","responses":{"201":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"createBucket","weight":200,"cookies":false,"type":"","deprecated":false,"demo":"storage\/create-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"bucketId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<BUCKET_ID>"},"name":{"type":"string","description":"Bucket name","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","x-example":false}},"required":["bucketId","name"]}}}}}},"\/storage\/buckets\/{bucketId}":{"get":{"summary":"Get bucket","operationId":"storageGetBucket","tags":["storage"],"description":"Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.","responses":{"200":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"getBucket","weight":202,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}]},"put":{"summary":"Update bucket","operationId":"storageUpdateBucket","tags":["storage"],"description":"Update a storage bucket by its unique ID.","responses":{"200":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"updateBucket","weight":203,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Bucket name","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete bucket","operationId":"storageDeleteBucket","tags":["storage"],"description":"Delete a storage bucket by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteBucket","weight":204,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/fileList"}}}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"fileId":{"type":"string","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<FILE_ID>","x-upload-id":true},"file":{"type":"string","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","x-example":null},"permissions":{"type":"array","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["fileId","file"]}}}}}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"schema":{"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center"},"in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"schema":{"type":"number","format":"float","x-example":0,"default":1},"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"schema":{"type":"integer","format":"int32","x-example":-360,"default":0},"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"schema":{"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":""},"in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/teamList"}}}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}}}}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["name"]}}}}},"delete":{"summary":"Delete team","operationId":"teamsDelete","tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membershipList"}}}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","x-example":"<NAME>"}},"required":["roles"]}}}}}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["roles"]}}}}},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/users":{"get":{"summary":"List users","operationId":"usersList","tags":["users"],"description":"Get a list of all the project's users. You can use the query params to filter your results.","responses":{"200":{"description":"Users List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/userList"}}}}},"x-appwrite":{"method":"list","weight":239,"cookies":false,"type":"","deprecated":false,"demo":"users\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create user","operationId":"usersCreate","tags":["users"],"description":"Create a new user.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"create","weight":230,"cookies":false,"type":"","deprecated":false,"demo":"users\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"password":{"type":"string","description":"Plain text user password. Must be at least 8 chars.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId"]}}}}}},"\/users\/argon2":{"post":{"summary":"Create user with Argon2 password","operationId":"usersCreateArgon2User","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createArgon2User","weight":233,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-argon2user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Argon2.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/bcrypt":{"post":{"summary":"Create user with bcrypt password","operationId":"usersCreateBcryptUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createBcryptUser","weight":231,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-bcrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Bcrypt.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/identities":{"get":{"summary":"List Identities","operationId":"usersListIdentities","tags":["users"],"description":"Get identities for all users.","responses":{"200":{"description":"Identities List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/identityList"}}}}},"x-appwrite":{"method":"listIdentities","weight":247,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/users\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"usersDeleteIdentity","tags":["users"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":270,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"schema":{"type":"string","x-example":"<IDENTITY_ID>"},"in":"path"}]}},"\/users\/md5":{"post":{"summary":"Create user with MD5 password","operationId":"usersCreateMD5User","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createMD5User","weight":232,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-m-d5user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using MD5.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/phpass":{"post":{"summary":"Create user with PHPass password","operationId":"usersCreatePHPassUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createPHPassUser","weight":235,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-p-h-pass-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using PHPass.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/scrypt":{"post":{"summary":"Create user with Scrypt password","operationId":"usersCreateScryptUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createScryptUser","weight":236,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt.","x-example":"password"},"passwordSalt":{"type":"string","description":"Optional salt used to hash password.","x-example":"<PASSWORD_SALT>"},"passwordCpu":{"type":"integer","description":"Optional CPU cost used to hash password.","x-example":null},"passwordMemory":{"type":"integer","description":"Optional memory cost used to hash password.","x-example":null},"passwordParallel":{"type":"integer","description":"Optional parallelization cost used to hash password.","x-example":null},"passwordLength":{"type":"integer","description":"Optional hash length used to hash password.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordCpu","passwordMemory","passwordParallel","passwordLength"]}}}}}},"\/users\/scrypt-modified":{"post":{"summary":"Create user with Scrypt modified password","operationId":"usersCreateScryptModifiedUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createScryptModifiedUser","weight":237,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-modified-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt Modified.","x-example":"password"},"passwordSalt":{"type":"string","description":"Salt used to hash password.","x-example":"<PASSWORD_SALT>"},"passwordSaltSeparator":{"type":"string","description":"Salt separator used to hash password.","x-example":"<PASSWORD_SALT_SEPARATOR>"},"passwordSignerKey":{"type":"string","description":"Signer key used to hash password.","x-example":"<PASSWORD_SIGNER_KEY>"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordSaltSeparator","passwordSignerKey"]}}}}}},"\/users\/sha":{"post":{"summary":"Create user with SHA password","operationId":"usersCreateSHAUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createSHAUser","weight":234,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-s-h-a-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using SHA.","x-example":"password"},"passwordVersion":{"type":"string","description":"Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'","x-example":"sha1","enum":["sha1","sha224","sha256","sha384","sha512\/224","sha512\/256","sha512","sha3-224","sha3-256","sha3-384","sha3-512"],"x-enum-name":"PasswordHash","x-enum-keys":[]},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/{userId}":{"get":{"summary":"Get user","operationId":"usersGet","tags":["users"],"description":"Get a user by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"get","weight":240,"cookies":false,"type":"","deprecated":false,"demo":"users\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"delete":{"summary":"Delete user","operationId":"usersDelete","tags":["users"],"description":"Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":268,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/email":{"patch":{"summary":"Update email","operationId":"usersUpdateEmail","tags":["users"],"description":"Update the user email by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmail","weight":253,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"}},"required":["email"]}}}}}},"\/users\/{userId}\/jwts":{"post":{"summary":"Create user JWT","operationId":"usersCreateJWT","tags":["users"],"description":"Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":271,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.","x-example":"<SESSION_ID>"},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","x-example":0}}}}}}}},"\/users\/{userId}\/labels":{"put":{"summary":"Update user labels","operationId":"usersUpdateLabels","tags":["users"],"description":"Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateLabels","weight":249,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-labels.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"labels":{"type":"array","description":"Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.","x-example":null,"items":{"type":"string"}}},"required":["labels"]}}}}}},"\/users\/{userId}\/logs":{"get":{"summary":"List user logs","operationId":"usersListLogs","tags":["users"],"description":"Get the user activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":245,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/users\/{userId}\/memberships":{"get":{"summary":"List user memberships","operationId":"usersListMemberships","tags":["users"],"description":"Get the user membership list by its unique ID.","responses":{"200":{"description":"Memberships List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membershipList"}}}}},"x-appwrite":{"method":"listMemberships","weight":244,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/mfa":{"patch":{"summary":"Update MFA","operationId":"usersUpdateMfa","tags":["users"],"description":"Enable or disable MFA on a user account.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMfa","weight":258,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","x-example":false}},"required":["mfa"]}}}}}},"\/users\/{userId}\/mfa\/authenticators\/{type}":{"delete":{"summary":"Delete Authenticator","operationId":"usersDeleteMfaAuthenticator","tags":["users"],"description":"Delete an authenticator app.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":263,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]}},"\/users\/{userId}\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"usersListMfaFactors","tags":["users"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaFactors"}}}}},"x-appwrite":{"method":"listMfaFactors","weight":259,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"usersGetMfaRecoveryCodes","tags":["users"],"description":"Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":260,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"put":{"summary":"Regenerate MFA Recovery Codes","operationId":"usersUpdateMfaRecoveryCodes","tags":["users"],"description":"Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":262,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"patch":{"summary":"Create MFA Recovery Codes","operationId":"usersCreateMfaRecoveryCodes","tags":["users"],"description":"Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.","responses":{"201":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":261,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/name":{"patch":{"summary":"Update name","operationId":"usersUpdateName","tags":["users"],"description":"Update the user name by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateName","weight":251,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["name"]}}}}}},"\/users\/{userId}\/password":{"patch":{"summary":"Update password","operationId":"usersUpdatePassword","tags":["users"],"description":"Update the user password by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePassword","weight":252,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","x-example":null}},"required":["password"]}}}}}},"\/users\/{userId}\/phone":{"patch":{"summary":"Update phone","operationId":"usersUpdatePhone","tags":["users"],"description":"Update the user phone by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhone","weight":254,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"User phone number.","x-example":"+12065550100"}},"required":["number"]}}}}}},"\/users\/{userId}\/prefs":{"get":{"summary":"Get user preferences","operationId":"usersGetPrefs","tags":["users"],"description":"Get the user preferences by its unique ID.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":241,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"patch":{"summary":"Update user preferences","operationId":"usersUpdatePrefs","tags":["users"],"description":"Update the user preferences by its unique ID. 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.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"updatePrefs","weight":256,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/users\/{userId}\/sessions":{"get":{"summary":"List user sessions","operationId":"usersListSessions","tags":["users"],"description":"Get the user sessions list by its unique ID.","responses":{"200":{"description":"Sessions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/sessionList"}}}}},"x-appwrite":{"method":"listSessions","weight":243,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"post":{"summary":"Create session","operationId":"usersCreateSession","tags":["users"],"description":"Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createSession","weight":264,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"delete":{"summary":"Delete user sessions","operationId":"usersDeleteSessions","tags":["users"],"description":"Delete all user's sessions by using the user's unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":267,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/sessions\/{sessionId}":{"delete":{"summary":"Delete user session","operationId":"usersDeleteSession","tags":["users"],"description":"Delete a user sessions by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":266,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"sessionId","description":"Session ID.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]}},"\/users\/{userId}\/status":{"patch":{"summary":"Update user status","operationId":"usersUpdateStatus","tags":["users"],"description":"Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateStatus","weight":248,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"User Status. To activate the user pass `true` and to block the user pass `false`.","x-example":false}},"required":["status"]}}}}}},"\/users\/{userId}\/targets":{"get":{"summary":"List User Targets","operationId":"usersListTargets","tags":["users"],"description":"List the messaging targets that are associated with a user.","responses":{"200":{"description":"Target list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/targetList"}}}}},"x-appwrite":{"method":"listTargets","weight":246,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create User Target","operationId":"usersCreateTarget","tags":["users"],"description":"Create a messaging target.","responses":{"201":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"createTarget","weight":238,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<TARGET_ID>"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email","enum":["email","sms","push"],"x-enum-name":"MessagingProviderType","x-enum-keys":[]},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","x-example":"<NAME>"}},"required":["targetId","providerType","identifier"]}}}}}},"\/users\/{userId}\/targets\/{targetId}":{"get":{"summary":"Get User Target","operationId":"usersGetTarget","tags":["users"],"description":"Get a user's push notification target by ID.","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"getTarget","weight":242,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}]},"patch":{"summary":"Update User target","operationId":"usersUpdateTarget","tags":["users"],"description":"Update a messaging target.","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"updateTarget","weight":257,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","x-example":"<NAME>"}}}}}}},"delete":{"summary":"Delete user target","operationId":"usersDeleteTarget","tags":["users"],"description":"Delete a messaging target.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTarget","weight":269,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}]}},"\/users\/{userId}\/tokens":{"post":{"summary":"Create token","operationId":"usersCreateToken","tags":["users"],"description":"Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createToken","weight":265,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"length":{"type":"integer","description":"Token length in characters. The default length is 6 characters","x-example":4},"expire":{"type":"integer","description":"Token expiration period in seconds. The default expiration is 15 minutes.","x-example":60}}}}}}}},"\/users\/{userId}\/verification":{"patch":{"summary":"Update email verification","operationId":"usersUpdateEmailVerification","tags":["users"],"description":"Update the user email verification status by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmailVerification","weight":255,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"emailVerification":{"type":"boolean","description":"User email verification status.","x-example":false}},"required":["emailVerification"]}}}}}},"\/users\/{userId}\/verification\/phone":{"patch":{"summary":"Update phone verification","operationId":"usersUpdatePhoneVerification","tags":["users"],"description":"Update the user phone verification status by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhoneVerification","weight":250,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"phoneVerification":{"type":"boolean","description":"User phone verification status.","x-example":false}},"required":["phoneVerification"]}}}}}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"components":{"schemas":{"any":{"description":"Any","type":"object","additionalProperties":true},"error":{"description":"Error","type":"object","properties":{"message":{"type":"string","description":"Error message.","x-example":"Not found"},"code":{"type":"string","description":"Error code.","x-example":"404"},"type":{"type":"string","description":"Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes","x-example":"not_found"},"version":{"type":"string","description":"Server version number.","x-example":"1.0"}},"required":["message","code","type","version"]},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"$ref":"#\/components\/schemas\/document"},"x-example":""}},"required":["total","documents"]},"collectionList":{"description":"Collections List","type":"object","properties":{"total":{"type":"integer","description":"Total number of collections documents that matched your query.","x-example":5,"format":"int32"},"collections":{"type":"array","description":"List of collections.","items":{"$ref":"#\/components\/schemas\/collection"},"x-example":""}},"required":["total","collections"]},"databaseList":{"description":"Databases List","type":"object","properties":{"total":{"type":"integer","description":"Total number of databases documents that matched your query.","x-example":5,"format":"int32"},"databases":{"type":"array","description":"List of databases.","items":{"$ref":"#\/components\/schemas\/database"},"x-example":""}},"required":["total","databases"]},"indexList":{"description":"Indexes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of indexes documents that matched your query.","x-example":5,"format":"int32"},"indexes":{"type":"array","description":"List of indexes.","items":{"$ref":"#\/components\/schemas\/index"},"x-example":""}},"required":["total","indexes"]},"userList":{"description":"Users List","type":"object","properties":{"total":{"type":"integer","description":"Total number of users documents that matched your query.","x-example":5,"format":"int32"},"users":{"type":"array","description":"List of users.","items":{"$ref":"#\/components\/schemas\/user"},"x-example":""}},"required":["total","users"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"$ref":"#\/components\/schemas\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"$ref":"#\/components\/schemas\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"$ref":"#\/components\/schemas\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"$ref":"#\/components\/schemas\/file"},"x-example":""}},"required":["total","files"]},"bucketList":{"description":"Buckets List","type":"object","properties":{"total":{"type":"integer","description":"Total number of buckets documents that matched your query.","x-example":5,"format":"int32"},"buckets":{"type":"array","description":"List of buckets.","items":{"$ref":"#\/components\/schemas\/bucket"},"x-example":""}},"required":["total","buckets"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"$ref":"#\/components\/schemas\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"$ref":"#\/components\/schemas\/membership"},"x-example":""}},"required":["total","memberships"]},"functionList":{"description":"Functions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of functions documents that matched your query.","x-example":5,"format":"int32"},"functions":{"type":"array","description":"List of functions.","items":{"$ref":"#\/components\/schemas\/function"},"x-example":""}},"required":["total","functions"]},"runtimeList":{"description":"Runtimes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of runtimes documents that matched your query.","x-example":5,"format":"int32"},"runtimes":{"type":"array","description":"List of runtimes.","items":{"$ref":"#\/components\/schemas\/runtime"},"x-example":""}},"required":["total","runtimes"]},"deploymentList":{"description":"Deployments List","type":"object","properties":{"total":{"type":"integer","description":"Total number of deployments documents that matched your query.","x-example":5,"format":"int32"},"deployments":{"type":"array","description":"List of deployments.","items":{"$ref":"#\/components\/schemas\/deployment"},"x-example":""}},"required":["total","deployments"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"$ref":"#\/components\/schemas\/execution"},"x-example":""}},"required":["total","executions"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"$ref":"#\/components\/schemas\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"$ref":"#\/components\/schemas\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"$ref":"#\/components\/schemas\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"$ref":"#\/components\/schemas\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"$ref":"#\/components\/schemas\/phone"},"x-example":""}},"required":["total","phones"]},"variableList":{"description":"Variables List","type":"object","properties":{"total":{"type":"integer","description":"Total number of variables documents that matched your query.","x-example":5,"format":"int32"},"variables":{"type":"array","description":"List of variables.","items":{"$ref":"#\/components\/schemas\/variable"},"x-example":""}},"required":["total","variables"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"$ref":"#\/components\/schemas\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"providerList":{"description":"Provider list","type":"object","properties":{"total":{"type":"integer","description":"Total number of providers documents that matched your query.","x-example":5,"format":"int32"},"providers":{"type":"array","description":"List of providers.","items":{"$ref":"#\/components\/schemas\/provider"},"x-example":""}},"required":["total","providers"]},"messageList":{"description":"Message list","type":"object","properties":{"total":{"type":"integer","description":"Total number of messages documents that matched your query.","x-example":5,"format":"int32"},"messages":{"type":"array","description":"List of messages.","items":{"$ref":"#\/components\/schemas\/message"},"x-example":""}},"required":["total","messages"]},"topicList":{"description":"Topic list","type":"object","properties":{"total":{"type":"integer","description":"Total number of topics documents that matched your query.","x-example":5,"format":"int32"},"topics":{"type":"array","description":"List of topics.","items":{"$ref":"#\/components\/schemas\/topic"},"x-example":""}},"required":["total","topics"]},"subscriberList":{"description":"Subscriber list","type":"object","properties":{"total":{"type":"integer","description":"Total number of subscribers documents that matched your query.","x-example":5,"format":"int32"},"subscribers":{"type":"array","description":"List of subscribers.","items":{"$ref":"#\/components\/schemas\/subscriber"},"x-example":""}},"required":["total","subscribers"]},"targetList":{"description":"Target list","type":"object","properties":{"total":{"type":"integer","description":"Total number of targets documents that matched your query.","x-example":5,"format":"int32"},"targets":{"type":"array","description":"List of targets.","items":{"$ref":"#\/components\/schemas\/target"},"x-example":""}},"required":["total","targets"]},"database":{"description":"Database","type":"object","properties":{"$id":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Database name.","x-example":"My Database"},"$createdAt":{"type":"string","description":"Database creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Database update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"enabled":{"type":"boolean","description":"If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false}},"required":["$id","name","$createdAt","$updatedAt","enabled"]},"collection":{"description":"Collection","type":"object","properties":{"$id":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Collection creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Collection update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Collection name.","x-example":"My Collection"},"enabled":{"type":"boolean","description":"Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false},"documentSecurity":{"type":"boolean","description":"Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"attributes":{"type":"array","description":"Collection attributes.","items":{"anyOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]},"x-example":{}},"indexes":{"type":"array","description":"Collection indexes.","items":{"$ref":"#\/components\/schemas\/index"},"x-example":{}}},"required":["$id","$createdAt","$updatedAt","$permissions","databaseId","name","enabled","documentSecurity","attributes","indexes"]},"attributeList":{"description":"Attributes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of attributes in the given collection.","x-example":5,"format":"int32"},"attributes":{"type":"array","description":"List of attributes.","items":{"anyOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]},"x-example":""}},"required":["total","attributes"]},"attributeString":{"description":"AttributeString","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"size":{"type":"integer","description":"Attribute size.","x-example":128,"format":"int32"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default","nullable":true}},"required":["key","type","status","error","required","size"]},"attributeInteger":{"description":"AttributeInteger","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"count"},"type":{"type":"string","description":"Attribute type.","x-example":"integer"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"min":{"type":"integer","description":"Minimum value to enforce for new documents.","x-example":1,"format":"int32","nullable":true},"max":{"type":"integer","description":"Maximum value to enforce for new documents.","x-example":10,"format":"int32","nullable":true},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":10,"format":"int32","nullable":true}},"required":["key","type","status","error","required"]},"attributeFloat":{"description":"AttributeFloat","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"percentageCompleted"},"type":{"type":"string","description":"Attribute type.","x-example":"double"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"min":{"type":"number","description":"Minimum value to enforce for new documents.","x-example":1.5,"format":"double","nullable":true},"max":{"type":"number","description":"Maximum value to enforce for new documents.","x-example":10.5,"format":"double","nullable":true},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":2.5,"format":"double","nullable":true}},"required":["key","type","status","error","required"]},"attributeBoolean":{"description":"AttributeBoolean","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"isEnabled"},"type":{"type":"string","description":"Attribute type.","x-example":"boolean"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"nullable":true}},"required":["key","type","status","error","required"]},"attributeEmail":{"description":"AttributeEmail","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"userEmail"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"email"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default@example.com","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeEnum":{"description":"AttributeEnum","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"status"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"elements":{"type":"array","description":"Array of elements in enumerated type.","items":{"type":"string"},"x-example":"element"},"format":{"type":"string","description":"String format.","x-example":"enum"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"element","nullable":true}},"required":["key","type","status","error","required","elements","format"]},"attributeIp":{"description":"AttributeIP","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"ipAddress"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"ip"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"192.0.2.0","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeUrl":{"description":"AttributeURL","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"githubUrl"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"url"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"http:\/\/example.com","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeDatetime":{"description":"AttributeDatetime","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"birthDay"},"type":{"type":"string","description":"Attribute type.","x-example":"datetime"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"ISO 8601 format.","x-example":"datetime"},"default":{"type":"string","description":"Default value for attribute when not provided. Only null is optional","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeRelationship":{"description":"AttributeRelationship","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"relatedCollection":{"type":"string","description":"The ID of the related collection.","x-example":"collection"},"relationType":{"type":"string","description":"The type of the relationship.","x-example":"oneToOne|oneToMany|manyToOne|manyToMany"},"twoWay":{"type":"boolean","description":"Is the relationship two-way?","x-example":false},"twoWayKey":{"type":"string","description":"The key of the two-way relationship.","x-example":"string"},"onDelete":{"type":"string","description":"How deleting the parent document will propagate to child documents.","x-example":"restrict|cascade|setNull"},"side":{"type":"string","description":"Whether this is the parent or child side of the relationship","x-example":"parent|child"}},"required":["key","type","status","error","required","relatedCollection","relationType","twoWay","twoWayKey","onDelete","side"]},"index":{"description":"Index","type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":"index1"},"type":{"type":"string","description":"Index type.","x-example":"primary"},"status":{"type":"string","description":"Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an index.","x-example":"string"},"attributes":{"type":"array","description":"Index attributes.","items":{"type":"string"},"x-example":[]},"orders":{"type":"array","description":"Index orders.","items":{"type":"string"},"x-example":[],"nullable":true}},"required":["key","type","status","error","attributes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"oneOf":[{"$ref":"#\/components\/schemas\/algoArgon2"},{"$ref":"#\/components\/schemas\/algoScrypt"},{"$ref":"#\/components\/schemas\/algoScryptModified"},{"$ref":"#\/components\/schemas\/algoBcrypt"},{"$ref":"#\/components\/schemas\/algoPhpass"},{"$ref":"#\/components\/schemas\/algoSha"},{"$ref":"#\/components\/schemas\/algoMd5"}]},"nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"$ref":"#\/components\/schemas\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"bucket":{"description":"Bucket","type":"object","properties":{"$id":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Bucket creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Bucket update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"fileSecurity":{"type":"boolean","description":"Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"name":{"type":"string","description":"Bucket name.","x-example":"Documents"},"enabled":{"type":"boolean","description":"Bucket enabled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size supported.","x-example":100,"format":"int32"},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions.","items":{"type":"string"},"x-example":["jpg","png"]},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).","x-example":"gzip"},"encryption":{"type":"boolean","description":"Bucket is encrypted.","x-example":false},"antivirus":{"type":"boolean","description":"Virus scanning is enabled.","x-example":false}},"required":["$id","$createdAt","$updatedAt","$permissions","fileSecurity","name","enabled","maximumFileSize","allowedFileExtensions","compression","encryption","antivirus"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"function":{"description":"Function","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"execute":{"type":"array","description":"Execution permissions.","items":{"type":"string"},"x-example":"users"},"name":{"type":"string","description":"Function name.","x-example":"My Function"},"enabled":{"type":"boolean","description":"Function enabled.","x-example":false},"live":{"type":"boolean","description":"Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"runtime":{"type":"string","description":"Function execution runtime.","x-example":"python-3.8"},"deployment":{"type":"string","description":"Function's active deployment ID.","x-example":"5e5ea5c16897e"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"vars":{"type":"array","description":"Function variables.","items":{"$ref":"#\/components\/schemas\/variable"},"x-example":[]},"events":{"type":"array","description":"Function trigger events.","items":{"type":"string"},"x-example":"account.create"},"schedule":{"type":"string","description":"Function execution schedult in CRON format.","x-example":"5 4 * * *"},"timeout":{"type":"integer","description":"Function execution timeout in seconds.","x-example":300,"format":"int32"},"entrypoint":{"type":"string","description":"The entrypoint file used to execute the deployment.","x-example":"index.js"},"commands":{"type":"string","description":"The build command used to build the deployment.","x-example":"npm install"},"version":{"type":"string","description":"Version of Open Runtimes used for the function.","x-example":"v2"},"installationId":{"type":"string","description":"Function VCS (Version Control System) installation id.","x-example":"6m40at4ejk5h2u9s1hboo"},"providerRepositoryId":{"type":"string","description":"VCS (Version Control System) Repository ID","x-example":"appwrite"},"providerBranch":{"type":"string","description":"VCS (Version Control System) branch name","x-example":"main"},"providerRootDirectory":{"type":"string","description":"Path to function in VCS (Version Control System) repository","x-example":"functions\/helloWorld"},"providerSilentMode":{"type":"boolean","description":"Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests","x-example":false}},"required":["$id","$createdAt","$updatedAt","execute","name","enabled","live","logging","runtime","deployment","scopes","vars","events","schedule","timeout","entrypoint","commands","version","installationId","providerRepositoryId","providerBranch","providerRootDirectory","providerSilentMode"]},"runtime":{"description":"Runtime","type":"object","properties":{"$id":{"type":"string","description":"Runtime ID.","x-example":"python-3.8"},"name":{"type":"string","description":"Runtime Name.","x-example":"Python"},"version":{"type":"string","description":"Runtime version.","x-example":"3.8"},"base":{"type":"string","description":"Base Docker image used to build the runtime.","x-example":"python:3.8-alpine"},"image":{"type":"string","description":"Image name of Docker Hub.","x-example":"appwrite\\\/runtime-for-python:3.8"},"logo":{"type":"string","description":"Name of the logo image.","x-example":"python.png"},"supports":{"type":"array","description":"List of supported architectures.","items":{"type":"string"},"x-example":"amd64"}},"required":["$id","name","version","base","image","logo","supports"]},"deployment":{"description":"Deployment","type":"object","properties":{"$id":{"type":"string","description":"Deployment ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Deployment update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"type":{"type":"string","description":"Type of deployment.","x-example":"vcs"},"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea6g16897e"},"resourceType":{"type":"string","description":"Resource type.","x-example":"functions"},"entrypoint":{"type":"string","description":"The entrypoint file to use to execute the deployment code.","x-example":"index.js"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"},"buildId":{"type":"string","description":"The current build ID.","x-example":"5e5ea5c16897e"},"activate":{"type":"boolean","description":"Whether the deployment should be automatically activated.","x-example":true},"status":{"type":"string","description":"The deployment status. Possible values are \"processing\", \"building\", \"waiting\", \"ready\", and \"failed\".","x-example":"ready"},"buildLogs":{"type":"string","description":"The build logs.","x-example":"Compiling source files..."},"buildTime":{"type":"integer","description":"The current build time in seconds.","x-example":128,"format":"int32"},"providerRepositoryName":{"type":"string","description":"The name of the vcs provider repository","x-example":"database"},"providerRepositoryOwner":{"type":"string","description":"The name of the vcs provider repository owner","x-example":"utopia"},"providerRepositoryUrl":{"type":"string","description":"The url of the vcs provider repository","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function"},"providerBranch":{"type":"string","description":"The branch of the vcs repository","x-example":"0.7.x"},"providerCommitHash":{"type":"string","description":"The commit hash of the vcs commit","x-example":"7c3f25d"},"providerCommitAuthorUrl":{"type":"string","description":"The url of vcs commit author","x-example":"https:\/\/github.com\/vermakhushboo"},"providerCommitAuthor":{"type":"string","description":"The name of vcs commit author","x-example":"Khushboo Verma"},"providerCommitMessage":{"type":"string","description":"The commit message","x-example":"Update index.js"},"providerCommitUrl":{"type":"string","description":"The url of the vcs commit","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"},"providerBranchUrl":{"type":"string","description":"The branch of the vcs repository","x-example":"https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"}},"required":["$id","$createdAt","$updatedAt","type","resourceId","resourceType","entrypoint","size","buildId","activate","status","buildLogs","buildTime","providerRepositoryName","providerRepositoryOwner","providerRepositoryUrl","providerBranch","providerCommitHash","providerCommitAuthorUrl","providerCommitAuthor","providerCommitMessage","providerCommitUrl","providerBranchUrl"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"build":{"description":"Build","type":"object","properties":{"$id":{"type":"string","description":"Build ID.","x-example":"5e5ea5c16897e"},"deploymentId":{"type":"string","description":"The deployment that created this build.","x-example":"5e5ea5c16897e"},"status":{"type":"string","description":"The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built","x-example":"ready"},"stdout":{"type":"string","description":"The stdout of the build.","x-example":""},"stderr":{"type":"string","description":"The stderr of the build.","x-example":""},"startTime":{"type":"string","description":"The deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"endTime":{"type":"string","description":"The time the build was finished in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"duration":{"type":"integer","description":"The build duration in seconds.","x-example":0,"format":"int32"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"}},"required":["$id","deploymentId","status","stdout","stderr","startTime","endTime","duration","size"]},"variable":{"description":"Variable","type":"object","properties":{"$id":{"type":"string","description":"Variable ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"key":{"type":"string","description":"Variable key.","x-example":"API_KEY"},"value":{"type":"string","description":"Variable value.","x-example":"myPa$$word1"},"resourceType":{"type":"string","description":"Service to which the variable belongs. Possible values are \"project\", \"function\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"}},"required":["$id","$createdAt","$updatedAt","key","value","resourceType","resourceId"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"healthAntivirus":{"description":"Health Antivirus","type":"object","properties":{"version":{"type":"string","description":"Antivirus version.","x-example":"1.0.0"},"status":{"type":"string","description":"Antivirus status. Possible values can are: `disabled`, `offline`, `online`","x-example":"online"}},"required":["version","status"]},"healthQueue":{"description":"Health Queue","type":"object","properties":{"size":{"type":"integer","description":"Amount of actions in the queue.","x-example":8,"format":"int32"}},"required":["size"]},"healthStatus":{"description":"Health Status","type":"object","properties":{"name":{"type":"string","description":"Name of the service.","x-example":"database"},"ping":{"type":"integer","description":"Duration in milliseconds how long the health check took.","x-example":128,"format":"int32"},"status":{"type":"string","description":"Service status. Possible values can are: `pass`, `fail`","x-example":"pass"}},"required":["name","ping","status"]},"healthCertificate":{"description":"Health Certificate","type":"object","properties":{"name":{"type":"string","description":"Certificate name","x-example":"\/CN=www.google.com"},"subjectSN":{"type":"string","description":"Subject SN","x-example":""},"issuerOrganisation":{"type":"string","description":"Issuer organisation","x-example":""},"validFrom":{"type":"string","description":"Valid from","x-example":"1704200998"},"validTo":{"type":"string","description":"Valid to","x-example":"1711458597"},"signatureTypeSN":{"type":"string","description":"Signature type SN","x-example":"RSA-SHA256"}},"required":["name","subjectSN","issuerOrganisation","validFrom","validTo","signatureTypeSN"]},"healthTime":{"description":"Health Time","type":"object","properties":{"remoteTime":{"type":"integer","description":"Current unix timestamp on trustful remote server.","x-example":1639490751,"format":"int32"},"localTime":{"type":"integer","description":"Current unix timestamp of local server where Appwrite runs.","x-example":1639490844,"format":"int32"},"diff":{"type":"integer","description":"Difference of unix remote and local timestamps in milliseconds.","x-example":93,"format":"int32"}},"required":["remoteTime","localTime","diff"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"provider":{"description":"Provider","type":"object","properties":{"$id":{"type":"string","description":"Provider ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Provider creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Provider update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name for the provider instance.","x-example":"Mailgun"},"provider":{"type":"string","description":"The name of the provider service.","x-example":"mailgun"},"enabled":{"type":"boolean","description":"Is provider enabled?","x-example":true},"type":{"type":"string","description":"Type of provider.","x-example":"sms"},"credentials":{"type":"object","description":"Provider credentials.","x-example":{"key":"123456789"}},"options":{"type":"object","description":"Provider options.","x-example":{"from":"sender-email@mydomain"},"nullable":true}},"required":["$id","$createdAt","$updatedAt","name","provider","enabled","type","credentials"]},"message":{"description":"Message","type":"object","properties":{"$id":{"type":"string","description":"Message ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Message creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Message update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerType":{"type":"string","description":"Message provider type.","x-example":"email"},"topics":{"type":"array","description":"Topic IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"users":{"type":"array","description":"User IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"targets":{"type":"array","description":"Target IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"scheduledAt":{"type":"string","description":"The scheduled time for message.","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true},"deliveredAt":{"type":"string","description":"The time when the message was delivered.","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true},"deliveryErrors":{"type":"array","description":"Delivery errors if any.","items":{"type":"string"},"x-example":["Failed to send message to target 5e5ea5c16897e: Credentials not valid."],"nullable":true},"deliveredTotal":{"type":"integer","description":"Number of recipients the message was delivered to.","x-example":1,"format":"int32"},"data":{"type":"object","description":"Data of the message.","x-example":{"subject":"Welcome to Appwrite","content":"Hi there, welcome to Appwrite family."}},"status":{"type":"string","description":"Status of delivery.","x-example":"Message status can be one of the following: draft, processing, scheduled, sent, or failed."}},"required":["$id","$createdAt","$updatedAt","providerType","topics","users","targets","deliveredTotal","data","status"]},"topic":{"description":"Topic","type":"object","properties":{"$id":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Topic creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Topic update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name of the topic.","x-example":"events"},"emailTotal":{"type":"integer","description":"Total count of email subscribers subscribed to the topic.","x-example":100,"format":"int32"},"smsTotal":{"type":"integer","description":"Total count of SMS subscribers subscribed to the topic.","x-example":100,"format":"int32"},"pushTotal":{"type":"integer","description":"Total count of push subscribers subscribed to the topic.","x-example":100,"format":"int32"},"subscribe":{"type":"array","description":"Subscribe permissions.","items":{"type":"string"},"x-example":"users"}},"required":["$id","$createdAt","$updatedAt","name","emailTotal","smsTotal","pushTotal","subscribe"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"$ref":"#\/components\/schemas\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]}},"securitySchemes":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"Key":{"type":"apiKey","name":"X-Appwrite-Key","description":"Your secret API key","in":"header","x-appwrite":{"demo":"<YOUR_API_KEY>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header"},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Session":{"type":"apiKey","name":"X-Appwrite-Session","description":"The user session to authenticate with","in":"header"},"ForwardedUserAgent":{"type":"apiKey","name":"X-Forwarded-User-Agent","description":"The user agent string of the client that made the request","in":"header"}}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file +{"openapi":"3.0.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"servers":[{"url":"https:\/\/cloud.appwrite.io\/v1"}],"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/identityList"}}}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"schema":{"type":"string","x-example":"<IDENTITY_ID>"},"in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","x-example":false}},"required":["mfa"]}}}}}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaType"}}}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","x-example":"<OTP>"}},"required":["otp"]}}}}},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaChallenge"}}}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}}}},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content","content":{"":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","x-example":"<OTP>"}},"required":["challengeId","otp"]}}}}}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaFactors"}}}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["name"]}}}}}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","x-example":"password"}},"required":["password"]}}}}}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["phone","password"]}}}}}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["email","url"]}}}}},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","x-example":null}},"required":["userId","secret","password"]}}}}}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/sessionList"}}}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","x-example":"password"}},"required":["email","password"]}}}}}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","tags":["account"],"description":"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.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","x-example":false}},"required":["userId","email"]}}}}}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"File"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"schema":{"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com","default":""},"in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"}},"required":["userId","phone"]}}}}}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","x-example":"https:\/\/example.com"}},"required":["url"]}}}}},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","tags":["account"],"description":"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.","responses":{"200":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"schema":{"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"schema":{"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"schema":{"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"]},"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"schema":{"type":"string","format":"url","x-example":"https:\/\/example.com"},"in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":400},"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"schema":{"type":"string","x-example":"<NAME>","default":""},"in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":500},"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"schema":{"type":"string","default":""},"in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"schema":{"type":"string","x-example":"<TEXT>"},"in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"schema":{"type":"integer","format":"int32","x-example":1,"default":400},"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":1},"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"schema":{"type":"boolean","x-example":false,"default":false},"in":"query"}]}},"\/databases":{"get":{"summary":"List databases","operationId":"databasesList","tags":["databases"],"description":"Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.","responses":{"200":{"description":"Databases List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/databaseList"}}}}},"x-appwrite":{"method":"list","weight":69,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create database","operationId":"databasesCreate","tags":["databases"],"description":"Create a new Database.\n","responses":{"201":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"create","weight":68,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"databaseId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<DATABASE_ID>"},"name":{"type":"string","description":"Database name. Max length: 128 chars.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","x-example":false}},"required":["databaseId","name"]}}}}}},"\/databases\/{databaseId}":{"get":{"summary":"Get database","operationId":"databasesGet","tags":["databases"],"description":"Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.","responses":{"200":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"get","weight":70,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}]},"put":{"summary":"Update database","operationId":"databasesUpdate","tags":["databases"],"description":"Update a database by its unique ID.","responses":{"200":{"description":"Database","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/database"}}}}},"x-appwrite":{"method":"update","weight":72,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Database name. Max length: 128 chars.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete database","operationId":"databasesDelete","tags":["databases"],"description":"Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":73,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}]}},"\/databases\/{databaseId}\/collections":{"get":{"summary":"List collections","operationId":"databasesListCollections","tags":["databases"],"description":"Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.","responses":{"200":{"description":"Collections List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collectionList"}}}}},"x-appwrite":{"method":"listCollections","weight":75,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collections.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"queries","description":"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: name, enabled, documentSecurity","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create collection","operationId":"databasesCreateCollection","tags":["databases"],"description":"Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"createCollection","weight":74,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"collectionId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<COLLECTION_ID>"},"name":{"type":"string","description":"Collection name. Max length: 128 chars.","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","x-example":false}},"required":["collectionId","name"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}":{"get":{"summary":"Get collection","operationId":"databasesGetCollection","tags":["databases"],"description":"Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.","responses":{"200":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"getCollection","weight":76,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}]},"put":{"summary":"Update collection","operationId":"databasesUpdateCollection","tags":["databases"],"description":"Update a collection by its unique ID.","responses":{"200":{"description":"Collection","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/collection"}}}}},"x-appwrite":{"method":"updateCollection","weight":78,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name. Max length: 128 chars.","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete collection","operationId":"databasesDeleteCollection","tags":["databases"],"description":"Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteCollection","weight":79,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes":{"get":{"summary":"List attributes","operationId":"databasesListAttributes","tags":["databases"],"description":"List attributes in the collection.","responses":{"200":{"description":"Attributes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeList"}}}}},"x-appwrite":{"method":"listAttributes","weight":90,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-attributes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"queries","description":"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: key, type, size, required, array, status, error","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean":{"post":{"summary":"Create boolean attribute","operationId":"databasesCreateBooleanAttribute","tags":["databases"],"description":"Create a boolean attribute.\n","responses":{"202":{"description":"AttributeBoolean","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeBoolean"}}}}},"x-appwrite":{"method":"createBooleanAttribute","weight":87,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}":{"patch":{"summary":"Update boolean attribute","operationId":"databasesUpdateBooleanAttribute","tags":["databases"],"description":"Update a boolean attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeBoolean","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeBoolean"}}}}},"x-appwrite":{"method":"updateBooleanAttribute","weight":99,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime":{"post":{"summary":"Create datetime attribute","operationId":"databasesCreateDatetimeAttribute","tags":["databases"],"description":"Create a date time attribute according to the ISO 8601 standard.","responses":{"202":{"description":"AttributeDatetime","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeDatetime"}}}}},"x-appwrite":{"method":"createDatetimeAttribute","weight":88,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}":{"patch":{"summary":"Update dateTime attribute","operationId":"databasesUpdateDatetimeAttribute","tags":["databases"],"description":"Update a date time attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeDatetime","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeDatetime"}}}}},"x-appwrite":{"method":"updateDatetimeAttribute","weight":100,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email":{"post":{"summary":"Create email attribute","operationId":"databasesCreateEmailAttribute","tags":["databases"],"description":"Create an email attribute.\n","responses":{"202":{"description":"AttributeEmail","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeEmail"}}}}},"x-appwrite":{"method":"createEmailAttribute","weight":81,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"email@example.com"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}":{"patch":{"summary":"Update email attribute","operationId":"databasesUpdateEmailAttribute","tags":["databases"],"description":"Update an email attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEmail","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeEmail"}}}}},"x-appwrite":{"method":"updateEmailAttribute","weight":93,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"email@example.com","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum":{"post":{"summary":"Create enum attribute","operationId":"databasesCreateEnumAttribute","tags":["databases"],"description":"Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n","responses":{"202":{"description":"AttributeEnum","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeEnum"}}}}},"x-appwrite":{"method":"createEnumAttribute","weight":82,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","elements","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}":{"patch":{"summary":"Update enum attribute","operationId":"databasesUpdateEnumAttribute","tags":["databases"],"description":"Update an enum attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEnum","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeEnum"}}}}},"x-appwrite":{"method":"updateEnumAttribute","weight":94,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>","x-nullable":true}},"required":["elements","required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float":{"post":{"summary":"Create float attribute","operationId":"databasesCreateFloatAttribute","tags":["databases"],"description":"Create a float attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeFloat","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeFloat"}}}}},"x-appwrite":{"method":"createFloatAttribute","weight":86,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float\/{key}":{"patch":{"summary":"Update float attribute","operationId":"databasesUpdateFloatAttribute","tags":["databases"],"description":"Update a float attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeFloat","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeFloat"}}}}},"x-appwrite":{"method":"updateFloatAttribute","weight":98,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer":{"post":{"summary":"Create integer attribute","operationId":"databasesCreateIntegerAttribute","tags":["databases"],"description":"Create an integer attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeInteger","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeInteger"}}}}},"x-appwrite":{"method":"createIntegerAttribute","weight":85,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer\/{key}":{"patch":{"summary":"Update integer attribute","operationId":"databasesUpdateIntegerAttribute","tags":["databases"],"description":"Update an integer attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeInteger","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeInteger"}}}}},"x-appwrite":{"method":"updateIntegerAttribute","weight":97,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip":{"post":{"summary":"Create IP address attribute","operationId":"databasesCreateIpAttribute","tags":["databases"],"description":"Create IP address attribute.\n","responses":{"202":{"description":"AttributeIP","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeIp"}}}}},"x-appwrite":{"method":"createIpAttribute","weight":83,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}":{"patch":{"summary":"Update IP address attribute","operationId":"databasesUpdateIpAttribute","tags":["databases"],"description":"Update an ip attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeIP","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeIp"}}}}},"x-appwrite":{"method":"updateIpAttribute","weight":95,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":null,"x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship":{"post":{"summary":"Create relationship attribute","operationId":"databasesCreateRelationshipAttribute","tags":["databases"],"description":"Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"202":{"description":"AttributeRelationship","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeRelationship"}}}}},"x-appwrite":{"method":"createRelationshipAttribute","weight":89,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"relatedCollectionId":{"type":"string","description":"Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","x-example":"<RELATED_COLLECTION_ID>"},"type":{"type":"string","description":"Relation type","x-example":"oneToOne","enum":["oneToOne","manyToOne","manyToMany","oneToMany"],"x-enum-name":"RelationshipType","x-enum-keys":[]},"twoWay":{"type":"boolean","description":"Is Two Way?","x-example":false},"key":{"type":"string","description":"Attribute Key.","x-example":null},"twoWayKey":{"type":"string","description":"Two Way Attribute Key.","x-example":null},"onDelete":{"type":"string","description":"Constraints option","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}},"required":["relatedCollectionId","type"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string":{"post":{"summary":"Create string attribute","operationId":"databasesCreateStringAttribute","tags":["databases"],"description":"Create a string attribute.\n","responses":{"202":{"description":"AttributeString","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeString"}}}}},"x-appwrite":{"method":"createStringAttribute","weight":80,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"size":{"type":"integer","description":"Attribute size for text attributes, in number of characters.","x-example":1},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false},"encrypt":{"type":"boolean","description":"Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.","x-example":false}},"required":["key","size","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}":{"patch":{"summary":"Update string attribute","operationId":"databasesUpdateStringAttribute","tags":["databases"],"description":"Update a string attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeString","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeString"}}}}},"x-appwrite":{"method":"updateStringAttribute","weight":92,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"<DEFAULT>","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url":{"post":{"summary":"Create URL attribute","operationId":"databasesCreateUrlAttribute","tags":["databases"],"description":"Create a URL attribute.\n","responses":{"202":{"description":"AttributeURL","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/attributeUrl"}}}}},"x-appwrite":{"method":"createUrlAttribute","weight":84,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":null},"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"https:\/\/example.com"},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false}},"required":["key","required"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}":{"patch":{"summary":"Update URL attribute","operationId":"databasesUpdateUrlAttribute","tags":["databases"],"description":"Update an url attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeURL","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeUrl"}}}}},"x-appwrite":{"method":"updateUrlAttribute","weight":96,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"https:\/\/example.com","x-nullable":true}},"required":["required","default"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}":{"get":{"summary":"Get attribute","operationId":"databasesGetAttribute","tags":["databases"],"description":"Get attribute by ID.","responses":{"200":{"description":"AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]}}}}},"x-appwrite":{"method":"getAttribute","weight":91,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}]},"delete":{"summary":"Delete attribute","operationId":"databasesDeleteAttribute","tags":["databases"],"description":"Deletes an attribute.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteAttribute","weight":102,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship":{"patch":{"summary":"Update relationship attribute","operationId":"databasesUpdateRelationshipAttribute","tags":["databases"],"description":"Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"200":{"description":"AttributeRelationship","content":{"":{"schema":{"$ref":"#\/components\/schemas\/attributeRelationship"}}}}},"x-appwrite":{"method":"updateRelationshipAttribute","weight":101,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Attribute Key.","required":true,"schema":{"type":"string"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"onDelete":{"type":"string","description":"Constraints option","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}}}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/documentList"}}}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":"<DOCUMENT_ID>"},"in":"path"},{"name":"queries","description":"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.","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/document"}}}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":"<DOCUMENT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"documentId","description":"Document ID.","required":true,"schema":{"type":"string","x-example":"<DOCUMENT_ID>"},"in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes":{"get":{"summary":"List indexes","operationId":"databasesListIndexes","tags":["databases"],"description":"List indexes in the collection.","responses":{"200":{"description":"Indexes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/indexList"}}}}},"x-appwrite":{"method":"listIndexes","weight":104,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-indexes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"queries","description":"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: key, type, status, attributes, error","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create index","operationId":"databasesCreateIndex","tags":["databases"],"description":"Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.","responses":{"202":{"description":"Index","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/index"}}}}},"x-appwrite":{"method":"createIndex","weight":103,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":null},"type":{"type":"string","description":"Index type.","x-example":"key","enum":["key","fulltext","unique"],"x-enum-name":"IndexType","x-enum-keys":[]},"attributes":{"type":"array","description":"Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}},"orders":{"type":"array","description":"Array of index orders. Maximum of 100 orders are allowed.","x-example":null,"items":{"type":"string"}}},"required":["key","type","attributes"]}}}}}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}":{"get":{"summary":"Get index","operationId":"databasesGetIndex","tags":["databases"],"description":"Get index by ID.","responses":{"200":{"description":"Index","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/index"}}}}},"x-appwrite":{"method":"getIndex","weight":105,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Index Key.","required":true,"schema":{"type":"string"},"in":"path"}]},"delete":{"summary":"Delete index","operationId":"databasesDeleteIndex","tags":["databases"],"description":"Delete an index.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIndex","weight":106,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"schema":{"type":"string","x-example":"<DATABASE_ID>"},"in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"schema":{"type":"string","x-example":"<COLLECTION_ID>"},"in":"path"},{"name":"key","description":"Index Key.","required":true,"schema":{"type":"string"},"in":"path"}]}},"\/functions":{"get":{"summary":"List functions","operationId":"functionsList","tags":["functions"],"description":"Get a list of all the project's functions. You can use the query params to filter your results.","responses":{"200":{"description":"Functions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/functionList"}}}}},"x-appwrite":{"method":"list","weight":287,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create function","operationId":"functionsCreate","tags":["functions"],"description":"Create a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.","responses":{"201":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"create","weight":286,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"functionId":{"type":"string","description":"Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<FUNCTION_ID>"},"name":{"type":"string","description":"Function name. Max length: 128 chars.","x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","x-example":null},"timeout":{"type":"integer","description":"Function maximum execution time in seconds.","x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Control System) deployment.","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function.","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function.","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","x-example":"<PROVIDER_ROOT_DIRECTORY>"},"templateRepository":{"type":"string","description":"Repository name of the template.","x-example":"<TEMPLATE_REPOSITORY>"},"templateOwner":{"type":"string","description":"The name of the owner of the template.","x-example":"<TEMPLATE_OWNER>"},"templateRootDirectory":{"type":"string","description":"Path to function code in the template repo.","x-example":"<TEMPLATE_ROOT_DIRECTORY>"},"templateBranch":{"type":"string","description":"Production branch for the repo linked to the function template.","x-example":"<TEMPLATE_BRANCH>"}},"required":["functionId","name","runtime"]}}}}}},"\/functions\/runtimes":{"get":{"summary":"List runtimes","operationId":"functionsListRuntimes","tags":["functions"],"description":"Get a list of all runtimes that are currently active on your instance.","responses":{"200":{"description":"Runtimes List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/runtimeList"}}}}},"x-appwrite":{"method":"listRuntimes","weight":288,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-runtimes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-runtimes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/functions\/{functionId}":{"get":{"summary":"Get function","operationId":"functionsGet","tags":["functions"],"description":"Get a function by its unique ID.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"get","weight":289,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}]},"put":{"summary":"Update function","operationId":"functionsUpdate","tags":["functions"],"description":"Update function by its unique ID.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"update","weight":292,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Function name. Max length: 128 chars.","x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","x-example":null},"timeout":{"type":"integer","description":"Maximum execution time in seconds.","x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.","x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Controle System) deployment.","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","x-example":"<PROVIDER_ROOT_DIRECTORY>"}},"required":["name"]}}}}},"delete":{"summary":"Delete function","operationId":"functionsDelete","tags":["functions"],"description":"Delete a function by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":295,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/deployments":{"get":{"summary":"List deployments","operationId":"functionsListDeployments","tags":["functions"],"description":"Get a list of all the project's code deployments. You can use the query params to filter your results.","responses":{"200":{"description":"Deployments List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deploymentList"}}}}},"x-appwrite":{"method":"listDeployments","weight":297,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"queries","description":"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: size, buildId, activate, entrypoint, commands","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create deployment","operationId":"functionsCreateDeployment","tags":["functions"],"description":"Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.","responses":{"202":{"description":"Deployment","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deployment"}}}}},"x-appwrite":{"method":"createDeployment","weight":296,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":true,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"entrypoint":{"type":"string","description":"Entrypoint File.","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","x-example":"<COMMANDS>"},"code":{"type":"string","description":"Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.","x-example":null},"activate":{"type":"boolean","description":"Automatically activate the deployment when it is finished building.","x-example":false}},"required":["code","activate"]}}}}}},"\/functions\/{functionId}\/deployments\/{deploymentId}":{"get":{"summary":"Get deployment","operationId":"functionsGetDeployment","tags":["functions"],"description":"Get a code deployment by its unique ID.","responses":{"200":{"description":"Deployment","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/deployment"}}}}},"x-appwrite":{"method":"getDeployment","weight":298,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]},"patch":{"summary":"Update function deployment","operationId":"functionsUpdateDeployment","tags":["functions"],"description":"Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.","responses":{"200":{"description":"Function","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/function"}}}}},"x-appwrite":{"method":"updateDeployment","weight":294,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]},"delete":{"summary":"Delete deployment","operationId":"functionsDeleteDeployment","tags":["functions"],"description":"Delete a code deployment by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDeployment","weight":299,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/build":{"post":{"summary":"Rebuild deployment","operationId":"functionsCreateBuild","tags":["functions"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createBuild","weight":300,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"buildId":{"type":"string","description":"Build unique ID.","x-example":"<BUILD_ID>"}}}}}}},"patch":{"summary":"Cancel deployment","operationId":"functionsUpdateDeploymentBuild","tags":["functions"],"description":"","responses":{"200":{"description":"Build","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/build"}}}}},"x-appwrite":{"method":"updateDeploymentBuild","weight":301,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/download":{"get":{"summary":"Download Deployment","operationId":"functionsDownloadDeployment","tags":["functions"],"description":"Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"downloadDeployment","weight":293,"cookies":false,"type":"location","deprecated":false,"demo":"functions\/download-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/download-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"schema":{"type":"string","x-example":"<DEPLOYMENT_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/executionList"}}}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/execution"}}}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"schema":{"type":"string","x-example":"<EXECUTION_ID>"},"in":"path"}]},"delete":{"summary":"Delete execution","operationId":"functionsDeleteExecution","tags":["functions"],"description":"Delete a function execution by its unique ID.\n","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteExecution","weight":305,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"schema":{"type":"string","x-example":"<EXECUTION_ID>"},"in":"path"}]}},"\/functions\/{functionId}\/variables":{"get":{"summary":"List variables","operationId":"functionsListVariables","tags":["functions"],"description":"Get a list of all variables of a specific function.","responses":{"200":{"description":"Variables List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variableList"}}}}},"x-appwrite":{"method":"listVariables","weight":307,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}]},"post":{"summary":"Create variable","operationId":"functionsCreateVariable","tags":["functions"],"description":"Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.","responses":{"201":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"createVariable","weight":306,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":"<VALUE>"}},"required":["key","value"]}}}}}},"\/functions\/{functionId}\/variables\/{variableId}":{"get":{"summary":"Get variable","operationId":"functionsGetVariable","tags":["functions"],"description":"Get a variable by its unique ID.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"getVariable","weight":308,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}]},"put":{"summary":"Update variable","operationId":"functionsUpdateVariable","tags":["functions"],"description":"Update variable by its unique ID.","responses":{"200":{"description":"Variable","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/variable"}}}}},"x-appwrite":{"method":"updateVariable","weight":309,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","x-example":"<VALUE>"}},"required":["key"]}}}}},"delete":{"summary":"Delete variable","operationId":"functionsDeleteVariable","tags":["functions"],"description":"Delete a variable by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":310,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"schema":{"type":"string","x-example":"<FUNCTION_ID>"},"in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"schema":{"type":"string","x-example":"<VARIABLE_ID>"},"in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[],"Session":[],"JWT":[]}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/any"}}}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[],"Session":[],"JWT":[]}]}},"\/health":{"get":{"summary":"Get HTTP","operationId":"healthGet","tags":["health"],"description":"Check the Appwrite HTTP server is up and responsive.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"get","weight":124,"cookies":false,"type":"","deprecated":false,"demo":"health\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/anti-virus":{"get":{"summary":"Get antivirus","operationId":"healthGetAntivirus","tags":["health"],"description":"Check the Appwrite Antivirus server is up and connection is successful.","responses":{"200":{"description":"Health Antivirus","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthAntivirus"}}}}},"x-appwrite":{"method":"getAntivirus","weight":146,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-antivirus.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/cache":{"get":{"summary":"Get cache","operationId":"healthGetCache","tags":["health"],"description":"Check the Appwrite in-memory cache servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getCache","weight":127,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-cache.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/certificate":{"get":{"summary":"Get the SSL certificate for a domain","operationId":"healthGetCertificate","tags":["health"],"description":"Get the SSL certificate for a domain","responses":{"200":{"description":"Health Certificate","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthCertificate"}}}}},"x-appwrite":{"method":"getCertificate","weight":133,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-certificate.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"domain","description":"string","required":false,"schema":{"type":"string"},"in":"query"}]}},"\/health\/db":{"get":{"summary":"Get DB","operationId":"healthGetDB","tags":["health"],"description":"Check the Appwrite database servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getDB","weight":126,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-d-b.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/pubsub":{"get":{"summary":"Get pubsub","operationId":"healthGetPubSub","tags":["health"],"description":"Check the Appwrite pub-sub servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getPubSub","weight":129,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-pub-sub.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue":{"get":{"summary":"Get queue","operationId":"healthGetQueue","tags":["health"],"description":"Check the Appwrite queue messaging servers are up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getQueue","weight":128,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue\/builds":{"get":{"summary":"Get builds queue","operationId":"healthGetQueueBuilds","tags":["health"],"description":"Get the number of builds that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueBuilds","weight":135,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-builds.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/certificates":{"get":{"summary":"Get certificates queue","operationId":"healthGetQueueCertificates","tags":["health"],"description":"Get the number of certificates that are waiting to be issued against [Letsencrypt](https:\/\/letsencrypt.org\/) in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueCertificates","weight":134,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-certificates.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/databases":{"get":{"summary":"Get databases queue","operationId":"healthGetQueueDatabases","tags":["health"],"description":"Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueDatabases","weight":136,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-databases.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"Queue name for which to check the queue size","required":false,"schema":{"type":"string","x-example":"<NAME>","default":"database_db_main"},"in":"query"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/deletes":{"get":{"summary":"Get deletes queue","operationId":"healthGetQueueDeletes","tags":["health"],"description":"Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueDeletes","weight":137,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-deletes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/failed\/{name}":{"get":{"summary":"Get number of failed queue jobs","operationId":"healthGetFailedJobs","tags":["health"],"description":"Returns the amount of failed jobs in a given queue.\n","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getFailedJobs","weight":147,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-failed-jobs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"The name of the queue","required":true,"schema":{"type":"string","x-example":"v1-database","enum":["v1-database","v1-deletes","v1-audits","v1-mails","v1-functions","v1-usage","v1-usage-dump","v1-webhooks","v1-certificates","v1-builds","v1-messaging","v1-migrations"],"x-enum-name":null,"x-enum-keys":[]},"in":"path"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/functions":{"get":{"summary":"Get functions queue","operationId":"healthGetQueueFunctions","tags":["health"],"description":"Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueFunctions","weight":141,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-functions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/logs":{"get":{"summary":"Get logs queue","operationId":"healthGetQueueLogs","tags":["health"],"description":"Get the number of logs that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueLogs","weight":132,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/mails":{"get":{"summary":"Get mails queue","operationId":"healthGetQueueMails","tags":["health"],"description":"Get the number of mails that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMails","weight":138,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-mails.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/messaging":{"get":{"summary":"Get messaging queue","operationId":"healthGetQueueMessaging","tags":["health"],"description":"Get the number of messages that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMessaging","weight":139,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-messaging.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/migrations":{"get":{"summary":"Get migrations queue","operationId":"healthGetQueueMigrations","tags":["health"],"description":"Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueMigrations","weight":140,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-migrations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/usage":{"get":{"summary":"Get usage queue","operationId":"healthGetQueueUsage","tags":["health"],"description":"Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueUsage","weight":142,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/usage-dump":{"get":{"summary":"Get usage dump queue","operationId":"healthGetQueueUsageDump","tags":["health"],"description":"Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueUsageDump","weight":143,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage-dump.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage-dump.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/queue\/webhooks":{"get":{"summary":"Get webhooks queue","operationId":"healthGetQueueWebhooks","tags":["health"],"description":"Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthQueue"}}}}},"x-appwrite":{"method":"getQueueWebhooks","weight":131,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"schema":{"type":"integer","format":"int32","default":5000},"in":"query"}]}},"\/health\/storage":{"get":{"summary":"Get storage","operationId":"healthGetStorage","tags":["health"],"description":"Check the Appwrite storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getStorage","weight":145,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/storage\/local":{"get":{"summary":"Get local storage","operationId":"healthGetStorageLocal","tags":["health"],"description":"Check the Appwrite local storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthStatus"}}}}},"x-appwrite":{"method":"getStorageLocal","weight":144,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage-local.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/time":{"get":{"summary":"Get time","operationId":"healthGetTime","tags":["health"],"description":"Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https:\/\/en.wikipedia.org\/wiki\/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.","responses":{"200":{"description":"Health Time","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/healthTime"}}}}},"x-appwrite":{"method":"getTime","weight":130,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-time.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/locale"}}}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/localeCodeList"}}}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/continentList"}}}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/countryList"}}}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/phoneList"}}}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/currencyList"}}}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/languageList"}}}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/messaging\/messages":{"get":{"summary":"List messages","operationId":"messagingListMessages","tags":["messaging"],"description":"Get a list of all messages from the current Appwrite project.","responses":{"200":{"description":"Message list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/messageList"}}}}},"x-appwrite":{"method":"listMessages","weight":385,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-messages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/messaging\/messages\/email":{"post":{"summary":"Create email","operationId":"messagingCreateEmail","tags":["messaging"],"description":"Create a new email message.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createEmail","weight":382,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<MESSAGE_ID>"},"subject":{"type":"string","description":"Email Subject.","x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","x-example":null,"items":{"type":"string"}},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","subject","content"]}}}}}},"\/messaging\/messages\/email\/{messageId}":{"patch":{"summary":"Update email","operationId":"messagingUpdateEmail","tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updateEmail","weight":389,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"subject":{"type":"string","description":"Email Subject.","x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","x-example":false},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","x-example":null,"items":{"type":"string"}},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":null,"items":{"type":"string"}}}}}}}}},"\/messaging\/messages\/push":{"post":{"summary":"Create push notification","operationId":"messagingCreatePush","tags":["messaging"],"description":"Create a new push notification.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createPush","weight":384,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<MESSAGE_ID>"},"title":{"type":"string","description":"Title for push notification.","x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","x-example":"<BODY>"},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"data":{"type":"object","description":"Additional Data for push notification.","x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web Platform.","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and IOS Platform.","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android Platform.","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android Platform.","x-example":"<TAG>"},"badge":{"type":"string","description":"Badge for push notification. Available only for IOS Platform.","x-example":"<BADGE>"},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","title","body"]}}}}}},"\/messaging\/messages\/push\/{messageId}":{"patch":{"summary":"Update push notification","operationId":"messagingUpdatePush","tags":["messaging"],"description":"Update a push notification by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updatePush","weight":391,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"title":{"type":"string","description":"Title for push notification.","x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","x-example":"<BODY>"},"data":{"type":"object","description":"Additional Data for push notification.","x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web platforms.","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and iOS platforms.","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android platforms.","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android platforms.","x-example":"<TAG>"},"badge":{"type":"integer","description":"Badge for push notification. Available only for iOS platforms.","x-example":null},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/messaging\/messages\/sms":{"post":{"summary":"Create SMS","operationId":"messagingCreateSms","tags":["messaging"],"description":"Create a new SMS message.","responses":{"201":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"createSms","weight":383,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<MESSAGE_ID>"},"content":{"type":"string","description":"SMS Content.","x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}},"required":["messageId","content"]}}}}}},"\/messaging\/messages\/sms\/{messageId}":{"patch":{"summary":"Update SMS","operationId":"messagingUpdateSms","tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"updateSms","weight":390,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","x-example":null,"items":{"type":"string"}},"content":{"type":"string","description":"Email Content.","x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","x-example":null}}}}}}}},"\/messaging\/messages\/{messageId}":{"get":{"summary":"Get message","operationId":"messagingGetMessage","tags":["messaging"],"description":"Get a message by its unique ID.\n","responses":{"200":{"description":"Message","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/message"}}}}},"x-appwrite":{"method":"getMessage","weight":388,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-message.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}]},"delete":{"summary":"Delete message","operationId":"messagingDelete","tags":["messaging"],"description":"Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":392,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"}]}},"\/messaging\/messages\/{messageId}\/logs":{"get":{"summary":"List message logs","operationId":"messagingListMessageLogs","tags":["messaging"],"description":"Get the message activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listMessageLogs","weight":386,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-message-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/messages\/{messageId}\/targets":{"get":{"summary":"List message targets","operationId":"messagingListTargets","tags":["messaging"],"description":"Get a list of the targets associated with a message.","responses":{"200":{"description":"Target list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/targetList"}}}}},"x-appwrite":{"method":"listTargets","weight":387,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"schema":{"type":"string","x-example":"<MESSAGE_ID>"},"in":"path"},{"name":"queries","description":"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, providerId, identifier, providerType","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/providers":{"get":{"summary":"List providers","operationId":"messagingListProviders","tags":["messaging"],"description":"Get a list of all providers from the current Appwrite project.","responses":{"200":{"description":"Provider list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/providerList"}}}}},"x-appwrite":{"method":"listProviders","weight":357,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-providers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, provider, type, enabled","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/messaging\/providers\/apns":{"post":{"summary":"Create APNS provider","operationId":"messagingCreateApnsProvider","tags":["messaging"],"description":"Create a new Apple Push Notification service provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createApnsProvider","weight":356,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"authKey":{"type":"string","description":"APNS authentication key.","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/apns\/{providerId}":{"patch":{"summary":"Update APNS provider","operationId":"messagingUpdateApnsProvider","tags":["messaging"],"description":"Update a Apple Push Notification service provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateApnsProvider","weight":369,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"authKey":{"type":"string","description":"APNS authentication key.","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","x-example":false}}}}}}}},"\/messaging\/providers\/fcm":{"post":{"summary":"Create FCM provider","operationId":"messagingCreateFcmProvider","tags":["messaging"],"description":"Create a new Firebase Cloud Messaging provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createFcmProvider","weight":355,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","x-example":"{}"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/fcm\/{providerId}":{"patch":{"summary":"Update FCM provider","operationId":"messagingUpdateFcmProvider","tags":["messaging"],"description":"Update a Firebase Cloud Messaging provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateFcmProvider","weight":368,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","x-example":"{}"}}}}}}}},"\/messaging\/providers\/mailgun":{"post":{"summary":"Create Mailgun provider","operationId":"messagingCreateMailgunProvider","tags":["messaging"],"description":"Create a new Mailgun provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createMailgunProvider","weight":347,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","x-example":false},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/mailgun\/{providerId}":{"patch":{"summary":"Update Mailgun provider","operationId":"messagingUpdateMailgunProvider","tags":["messaging"],"description":"Update a Mailgun provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateMailgunProvider","weight":360,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"<REPLY_TO_EMAIL>"}}}}}}}},"\/messaging\/providers\/msg91":{"post":{"summary":"Create Msg91 provider","operationId":"messagingCreateMsg91Provider","tags":["messaging"],"description":"Create a new MSG91 provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createMsg91Provider","weight":350,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"templateId":{"type":"string","description":"Msg91 template ID","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","x-example":"<AUTH_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/msg91\/{providerId}":{"patch":{"summary":"Update Msg91 provider","operationId":"messagingUpdateMsg91Provider","tags":["messaging"],"description":"Update a MSG91 provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateMsg91Provider","weight":363,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"templateId":{"type":"string","description":"Msg91 template ID.","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","x-example":"<AUTH_KEY>"}}}}}}}},"\/messaging\/providers\/sendgrid":{"post":{"summary":"Create Sendgrid provider","operationId":"messagingCreateSendgridProvider","tags":["messaging"],"description":"Create a new Sendgrid provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createSendgridProvider","weight":348,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Sendgrid API key.","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/sendgrid\/{providerId}":{"patch":{"summary":"Update Sendgrid provider","operationId":"messagingUpdateSendgridProvider","tags":["messaging"],"description":"Update a Sendgrid provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateSendgridProvider","weight":361,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"apiKey":{"type":"string","description":"Sendgrid API key.","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","x-example":"<REPLY_TO_EMAIL>"}}}}}}}},"\/messaging\/providers\/smtp":{"post":{"summary":"Create SMTP provider","operationId":"messagingCreateSmtpProvider","tags":["messaging"],"description":"Create a new SMTP provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createSmtpProvider","weight":349,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","x-example":"<HOST>"},"port":{"type":"integer","description":"The default SMTP server port.","x-example":1},"username":{"type":"string","description":"Authentication username.","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be omitted, 'ssl', or 'tls'","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name","host"]}}}}}},"\/messaging\/providers\/smtp\/{providerId}":{"patch":{"summary":"Update SMTP provider","operationId":"messagingUpdateSmtpProvider","tags":["messaging"],"description":"Update a SMTP provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateSmtpProvider","weight":362,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","x-example":"<HOST>"},"port":{"type":"integer","description":"SMTP port.","x-example":1},"username":{"type":"string","description":"Authentication username.","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be 'ssl' or 'tls'","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","x-example":"<REPLY_TO_EMAIL>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}}}}}}}},"\/messaging\/providers\/telesign":{"post":{"summary":"Create Telesign provider","operationId":"messagingCreateTelesignProvider","tags":["messaging"],"description":"Create a new Telesign provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTelesignProvider","weight":351,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"customerId":{"type":"string","description":"Telesign customer ID.","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/telesign\/{providerId}":{"patch":{"summary":"Update Telesign provider","operationId":"messagingUpdateTelesignProvider","tags":["messaging"],"description":"Update a Telesign provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTelesignProvider","weight":364,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"customerId":{"type":"string","description":"Telesign customer ID.","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/textmagic":{"post":{"summary":"Create Textmagic provider","operationId":"messagingCreateTextmagicProvider","tags":["messaging"],"description":"Create a new Textmagic provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTextmagicProvider","weight":352,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"username":{"type":"string","description":"Textmagic username.","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/textmagic\/{providerId}":{"patch":{"summary":"Update Textmagic provider","operationId":"messagingUpdateTextmagicProvider","tags":["messaging"],"description":"Update a Textmagic provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTextmagicProvider","weight":365,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"username":{"type":"string","description":"Textmagic username.","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/twilio":{"post":{"summary":"Create Twilio provider","operationId":"messagingCreateTwilioProvider","tags":["messaging"],"description":"Create a new Twilio provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createTwilioProvider","weight":353,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"accountSid":{"type":"string","description":"Twilio account secret ID.","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","x-example":"<AUTH_TOKEN>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/twilio\/{providerId}":{"patch":{"summary":"Update Twilio provider","operationId":"messagingUpdateTwilioProvider","tags":["messaging"],"description":"Update a Twilio provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateTwilioProvider","weight":366,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"accountSid":{"type":"string","description":"Twilio account secret ID.","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","x-example":"<AUTH_TOKEN>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/vonage":{"post":{"summary":"Create Vonage provider","operationId":"messagingCreateVonageProvider","tags":["messaging"],"description":"Create a new Vonage provider.","responses":{"201":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"createVonageProvider","weight":354,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"apiKey":{"type":"string","description":"Vonage API key.","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","x-example":"<API_SECRET>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false}},"required":["providerId","name"]}}}}}},"\/messaging\/providers\/vonage\/{providerId}":{"patch":{"summary":"Update Vonage provider","operationId":"messagingUpdateVonageProvider","tags":["messaging"],"description":"Update a Vonage provider by its unique ID.","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"updateVonageProvider","weight":367,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","x-example":false},"apiKey":{"type":"string","description":"Vonage API key.","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","x-example":"<API_SECRET>"},"from":{"type":"string","description":"Sender number.","x-example":"<FROM>"}}}}}}}},"\/messaging\/providers\/{providerId}":{"get":{"summary":"Get provider","operationId":"messagingGetProvider","tags":["messaging"],"description":"Get a provider by its unique ID.\n","responses":{"200":{"description":"Provider","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/provider"}}}}},"x-appwrite":{"method":"getProvider","weight":359,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}]},"delete":{"summary":"Delete provider","operationId":"messagingDeleteProvider","tags":["messaging"],"description":"Delete a provider by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteProvider","weight":370,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"}]}},"\/messaging\/providers\/{providerId}\/logs":{"get":{"summary":"List provider logs","operationId":"messagingListProviderLogs","tags":["messaging"],"description":"Get the provider activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listProviderLogs","weight":358,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-provider-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"schema":{"type":"string","x-example":"<PROVIDER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/subscribers\/{subscriberId}\/logs":{"get":{"summary":"List subscriber logs","operationId":"messagingListSubscriberLogs","tags":["messaging"],"description":"Get the subscriber activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listSubscriberLogs","weight":379,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscriber-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/topics":{"get":{"summary":"List topics","operationId":"messagingListTopics","tags":["messaging"],"description":"Get a list of all topics from the current Appwrite project.","responses":{"200":{"description":"Topic list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topicList"}}}}},"x-appwrite":{"method":"listTopics","weight":372,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topics.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, description, emailTotal, smsTotal, pushTotal","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create topic","operationId":"messagingCreateTopic","tags":["messaging"],"description":"Create a new topic.","responses":{"201":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"createTopic","weight":371,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"topicId":{"type":"string","description":"Topic ID. Choose a custom Topic ID or a new Topic ID.","x-example":"<TOPIC_ID>"},"name":{"type":"string","description":"Topic Name.","x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}}},"required":["topicId","name"]}}}}}},"\/messaging\/topics\/{topicId}":{"get":{"summary":"Get topic","operationId":"messagingGetTopic","tags":["messaging"],"description":"Get a topic by its unique ID.\n","responses":{"200":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"getTopic","weight":374,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}]},"patch":{"summary":"Update topic","operationId":"messagingUpdateTopic","tags":["messaging"],"description":"Update a topic by its unique ID.\n","responses":{"200":{"description":"Topic","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/topic"}}}}},"x-appwrite":{"method":"updateTopic","weight":375,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Topic Name.","x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","x-example":"[\"any\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete topic","operationId":"messagingDeleteTopic","tags":["messaging"],"description":"Delete a topic by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTopic","weight":376,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}]}},"\/messaging\/topics\/{topicId}\/logs":{"get":{"summary":"List topic logs","operationId":"messagingListTopicLogs","tags":["messaging"],"description":"Get the topic activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listTopicLogs","weight":373,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topic-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"get":{"summary":"List subscribers","operationId":"messagingListSubscribers","tags":["messaging"],"description":"Get a list of all subscribers from the current Appwrite project.","responses":{"200":{"description":"Subscriber list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriberList"}}}}},"x-appwrite":{"method":"listSubscribers","weight":378,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscribers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"queries","description":"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: name, provider, type, enabled","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriber"}}}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"JWT":[]}},"security":[{"Project":[],"JWT":[],"Session":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}}}}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"get":{"summary":"Get subscriber","operationId":"messagingGetSubscriber","tags":["messaging"],"description":"Get a subscriber by its unique ID.\n","responses":{"200":{"description":"Subscriber","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/subscriber"}}}}},"x-appwrite":{"method":"getSubscriber","weight":380,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"}]},"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"JWT":[]}},"security":[{"Project":[],"JWT":[],"Session":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"schema":{"type":"string","x-example":"<TOPIC_ID>"},"in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"schema":{"type":"string","x-example":"<SUBSCRIBER_ID>"},"in":"path"}]}},"\/storage\/buckets":{"get":{"summary":"List buckets","operationId":"storageListBuckets","tags":["storage"],"description":"Get a list of all the storage buckets. You can use the query params to filter your results.","responses":{"200":{"description":"Buckets List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucketList"}}}}},"x-appwrite":{"method":"listBuckets","weight":201,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-buckets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create bucket","operationId":"storageCreateBucket","tags":["storage"],"description":"Create a new storage bucket.","responses":{"201":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"createBucket","weight":200,"cookies":false,"type":"","deprecated":false,"demo":"storage\/create-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"bucketId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<BUCKET_ID>"},"name":{"type":"string","description":"Bucket name","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","x-example":false}},"required":["bucketId","name"]}}}}}},"\/storage\/buckets\/{bucketId}":{"get":{"summary":"Get bucket","operationId":"storageGetBucket","tags":["storage"],"description":"Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.","responses":{"200":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"getBucket","weight":202,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}]},"put":{"summary":"Update bucket","operationId":"storageUpdateBucket","tags":["storage"],"description":"Update a storage bucket by its unique ID.","responses":{"200":{"description":"Bucket","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/bucket"}}}}},"x-appwrite":{"method":"updateBucket","weight":203,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Bucket name","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","x-example":false}},"required":["name"]}}}}},"delete":{"summary":"Delete bucket","operationId":"storageDeleteBucket","tags":["storage"],"description":"Delete a storage bucket by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteBucket","weight":204,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/fileList"}}}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"}],"requestBody":{"content":{"multipart\/form-data":{"schema":{"type":"object","properties":{"fileId":{"type":"string","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<FILE_ID>","x-upload-id":true},"file":{"type":"string","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","x-example":null},"permissions":{"type":"array","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["fileId","file"]}}}}}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/file"}}}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}}}},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image"}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"schema":{"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center"},"in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":100},"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"schema":{"type":"integer","format":"int32","x-example":0,"default":0},"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"schema":{"type":"number","format":"float","x-example":0,"default":1},"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"schema":{"type":"integer","format":"int32","x-example":-360,"default":0},"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"schema":{"type":"string","default":""},"in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"schema":{"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":""},"in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File"}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"schema":{"type":"string","x-example":"<BUCKET_ID>"},"in":"path"},{"name":"fileId","description":"File ID.","required":true,"schema":{"type":"string","x-example":"<FILE_ID>"},"in":"path"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/teamList"}}}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}}}}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/team"}}}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["name"]}}}}},"delete":{"summary":"Delete team","operationId":"teamsDelete","tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membershipList"}}}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","x-example":"<NAME>"}},"required":["roles"]}}}}}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","x-example":null,"items":{"type":"string"}}},"required":["roles"]}}}}},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membership"}}}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"schema":{"type":"string","x-example":"<MEMBERSHIP_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","x-example":"<SECRET>"}},"required":["userId","secret"]}}}}}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"schema":{"type":"string","x-example":"<TEAM_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/users":{"get":{"summary":"List users","operationId":"usersList","tags":["users"],"description":"Get a list of all the project's users. You can use the query params to filter your results.","responses":{"200":{"description":"Users List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/userList"}}}}},"x-appwrite":{"method":"list","weight":239,"cookies":false,"type":"","deprecated":false,"demo":"users\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]},"post":{"summary":"Create user","operationId":"usersCreate","tags":["users"],"description":"Create a new user.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"create","weight":230,"cookies":false,"type":"","deprecated":false,"demo":"users\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","x-example":"+12065550100"},"password":{"type":"string","description":"Plain text user password. Must be at least 8 chars.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId"]}}}}}},"\/users\/argon2":{"post":{"summary":"Create user with Argon2 password","operationId":"usersCreateArgon2User","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createArgon2User","weight":233,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-argon2user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Argon2.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/bcrypt":{"post":{"summary":"Create user with bcrypt password","operationId":"usersCreateBcryptUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createBcryptUser","weight":231,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-bcrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Bcrypt.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/identities":{"get":{"summary":"List Identities","operationId":"usersListIdentities","tags":["users"],"description":"Get identities for all users.","responses":{"200":{"description":"Identities List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/identityList"}}}}},"x-appwrite":{"method":"listIdentities","weight":247,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"schema":{"type":"string","x-example":"<SEARCH>","default":""},"in":"query"}]}},"\/users\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"usersDeleteIdentity","tags":["users"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":270,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"schema":{"type":"string","x-example":"<IDENTITY_ID>"},"in":"path"}]}},"\/users\/md5":{"post":{"summary":"Create user with MD5 password","operationId":"usersCreateMD5User","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createMD5User","weight":232,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-m-d5user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using MD5.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/phpass":{"post":{"summary":"Create user with PHPass password","operationId":"usersCreatePHPassUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createPHPassUser","weight":235,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-p-h-pass-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using PHPass.","x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/scrypt":{"post":{"summary":"Create user with Scrypt password","operationId":"usersCreateScryptUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createScryptUser","weight":236,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt.","x-example":"password"},"passwordSalt":{"type":"string","description":"Optional salt used to hash password.","x-example":"<PASSWORD_SALT>"},"passwordCpu":{"type":"integer","description":"Optional CPU cost used to hash password.","x-example":null},"passwordMemory":{"type":"integer","description":"Optional memory cost used to hash password.","x-example":null},"passwordParallel":{"type":"integer","description":"Optional parallelization cost used to hash password.","x-example":null},"passwordLength":{"type":"integer","description":"Optional hash length used to hash password.","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordCpu","passwordMemory","passwordParallel","passwordLength"]}}}}}},"\/users\/scrypt-modified":{"post":{"summary":"Create user with Scrypt modified password","operationId":"usersCreateScryptModifiedUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createScryptModifiedUser","weight":237,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-modified-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt Modified.","x-example":"password"},"passwordSalt":{"type":"string","description":"Salt used to hash password.","x-example":"<PASSWORD_SALT>"},"passwordSaltSeparator":{"type":"string","description":"Salt separator used to hash password.","x-example":"<PASSWORD_SALT_SEPARATOR>"},"passwordSignerKey":{"type":"string","description":"Signer key used to hash password.","x-example":"<PASSWORD_SIGNER_KEY>"},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordSaltSeparator","passwordSignerKey"]}}}}}},"\/users\/sha":{"post":{"summary":"Create user with SHA password","operationId":"usersCreateSHAUser","tags":["users"],"description":"Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"createSHAUser","weight":234,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-s-h-a-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using SHA.","x-example":"password"},"passwordVersion":{"type":"string","description":"Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'","x-example":"sha1","enum":["sha1","sha224","sha256","sha384","sha512\/224","sha512\/256","sha512","sha3-224","sha3-256","sha3-384","sha3-512"],"x-enum-name":"PasswordHash","x-enum-keys":[]},"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["userId","email","password"]}}}}}},"\/users\/{userId}":{"get":{"summary":"Get user","operationId":"usersGet","tags":["users"],"description":"Get a user by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"get","weight":240,"cookies":false,"type":"","deprecated":false,"demo":"users\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"delete":{"summary":"Delete user","operationId":"usersDelete","tags":["users"],"description":"Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":268,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/email":{"patch":{"summary":"Update email","operationId":"usersUpdateEmail","tags":["users"],"description":"Update the user email by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmail","weight":253,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","x-example":"email@example.com"}},"required":["email"]}}}}}},"\/users\/{userId}\/jwts":{"post":{"summary":"Create user JWT","operationId":"usersCreateJWT","tags":["users"],"description":"Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.","responses":{"201":{"description":"JWT","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/jwt"}}}}},"x-appwrite":{"method":"createJWT","weight":271,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.","x-example":"<SESSION_ID>"},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","x-example":0}}}}}}}},"\/users\/{userId}\/labels":{"put":{"summary":"Update user labels","operationId":"usersUpdateLabels","tags":["users"],"description":"Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateLabels","weight":249,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-labels.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"labels":{"type":"array","description":"Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.","x-example":null,"items":{"type":"string"}}},"required":["labels"]}}}}}},"\/users\/{userId}\/logs":{"get":{"summary":"List user logs","operationId":"usersListLogs","tags":["users"],"description":"Get the user activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/logList"}}}}},"x-appwrite":{"method":"listLogs","weight":245,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"queries","description":"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","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]}},"\/users\/{userId}\/memberships":{"get":{"summary":"List user memberships","operationId":"usersListMemberships","tags":["users"],"description":"Get the user membership list by its unique ID.","responses":{"200":{"description":"Memberships List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/membershipList"}}}}},"x-appwrite":{"method":"listMemberships","weight":244,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/mfa":{"patch":{"summary":"Update MFA","operationId":"usersUpdateMfa","tags":["users"],"description":"Enable or disable MFA on a user account.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateMfa","weight":258,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","x-example":false}},"required":["mfa"]}}}}}},"\/users\/{userId}\/mfa\/authenticators\/{type}":{"delete":{"summary":"Delete Authenticator","operationId":"usersDeleteMfaAuthenticator","tags":["users"],"description":"Delete an authenticator app.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":263,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"type","description":"Type of authenticator.","required":true,"schema":{"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[]},"in":"path"}]}},"\/users\/{userId}\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"usersListMfaFactors","tags":["users"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaFactors"}}}}},"x-appwrite":{"method":"listMfaFactors","weight":259,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"usersGetMfaRecoveryCodes","tags":["users"],"description":"Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":260,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"put":{"summary":"Regenerate MFA Recovery Codes","operationId":"usersUpdateMfaRecoveryCodes","tags":["users"],"description":"Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":262,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"patch":{"summary":"Create MFA Recovery Codes","operationId":"usersCreateMfaRecoveryCodes","tags":["users"],"description":"Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.","responses":{"201":{"description":"MFA Recovery Codes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/mfaRecoveryCodes"}}}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":261,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/name":{"patch":{"summary":"Update name","operationId":"usersUpdateName","tags":["users"],"description":"Update the user name by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateName","weight":251,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","x-example":"<NAME>"}},"required":["name"]}}}}}},"\/users\/{userId}\/password":{"patch":{"summary":"Update password","operationId":"usersUpdatePassword","tags":["users"],"description":"Update the user password by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePassword","weight":252,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","x-example":null}},"required":["password"]}}}}}},"\/users\/{userId}\/phone":{"patch":{"summary":"Update phone","operationId":"usersUpdatePhone","tags":["users"],"description":"Update the user phone by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhone","weight":254,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"number":{"type":"string","description":"User phone number.","x-example":"+12065550100"}},"required":["number"]}}}}}},"\/users\/{userId}\/prefs":{"get":{"summary":"Get user preferences","operationId":"usersGetPrefs","tags":["users"],"description":"Get the user preferences by its unique ID.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"getPrefs","weight":241,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"patch":{"summary":"Update user preferences","operationId":"usersUpdatePrefs","tags":["users"],"description":"Update the user preferences by its unique ID. 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.","responses":{"200":{"description":"Preferences","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/preferences"}}}}},"x-appwrite":{"method":"updatePrefs","weight":256,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","x-example":"{}"}},"required":["prefs"]}}}}}},"\/users\/{userId}\/sessions":{"get":{"summary":"List user sessions","operationId":"usersListSessions","tags":["users"],"description":"Get the user sessions list by its unique ID.","responses":{"200":{"description":"Sessions List","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/sessionList"}}}}},"x-appwrite":{"method":"listSessions","weight":243,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"post":{"summary":"Create session","operationId":"usersCreateSession","tags":["users"],"description":"Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.","responses":{"201":{"description":"Session","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/session"}}}}},"x-appwrite":{"method":"createSession","weight":264,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]},"delete":{"summary":"Delete user sessions","operationId":"usersDeleteSessions","tags":["users"],"description":"Delete all user's sessions by using the user's unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":267,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}]}},"\/users\/{userId}\/sessions\/{sessionId}":{"delete":{"summary":"Delete user session","operationId":"usersDeleteSession","tags":["users"],"description":"Delete a user sessions by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":266,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"sessionId","description":"Session ID.","required":true,"schema":{"type":"string","x-example":"<SESSION_ID>"},"in":"path"}]}},"\/users\/{userId}\/status":{"patch":{"summary":"Update user status","operationId":"usersUpdateStatus","tags":["users"],"description":"Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateStatus","weight":248,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"status":{"type":"boolean","description":"User Status. To activate the user pass `true` and to block the user pass `false`.","x-example":false}},"required":["status"]}}}}}},"\/users\/{userId}\/targets":{"get":{"summary":"List User Targets","operationId":"usersListTargets","tags":["users"],"description":"List the messaging targets that are associated with a user.","responses":{"200":{"description":"Target list","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/targetList"}}}}},"x-appwrite":{"method":"listTargets","weight":246,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[]},"in":"query"}]},"post":{"summary":"Create User Target","operationId":"usersCreateTarget","tags":["users"],"description":"Create a messaging target.","responses":{"201":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"createTarget","weight":238,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","x-example":"<TARGET_ID>"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email","enum":["email","sms","push"],"x-enum-name":"MessagingProviderType","x-enum-keys":[]},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","x-example":"<NAME>"}},"required":["targetId","providerType","identifier"]}}}}}},"\/users\/{userId}\/targets\/{targetId}":{"get":{"summary":"Get User Target","operationId":"usersGetTarget","tags":["users"],"description":"Get a user's push notification target by ID.","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"getTarget","weight":242,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}]},"patch":{"summary":"Update User target","operationId":"usersUpdateTarget","tags":["users"],"description":"Update a messaging target.","responses":{"200":{"description":"Target","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/target"}}}}},"x-appwrite":{"method":"updateTarget","weight":257,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","x-example":"<NAME>"}}}}}}},"delete":{"summary":"Delete user target","operationId":"usersDeleteTarget","tags":["users"],"description":"Delete a messaging target.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTarget","weight":269,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"},{"name":"targetId","description":"Target ID.","required":true,"schema":{"type":"string","x-example":"<TARGET_ID>"},"in":"path"}]}},"\/users\/{userId}\/tokens":{"post":{"summary":"Create token","operationId":"usersCreateToken","tags":["users"],"description":"Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n","responses":{"201":{"description":"Token","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/token"}}}}},"x-appwrite":{"method":"createToken","weight":265,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"length":{"type":"integer","description":"Token length in characters. The default length is 6 characters","x-example":4},"expire":{"type":"integer","description":"Token expiration period in seconds. The default expiration is 15 minutes.","x-example":60}}}}}}}},"\/users\/{userId}\/verification":{"patch":{"summary":"Update email verification","operationId":"usersUpdateEmailVerification","tags":["users"],"description":"Update the user email verification status by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updateEmailVerification","weight":255,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"emailVerification":{"type":"boolean","description":"User email verification status.","x-example":false}},"required":["emailVerification"]}}}}}},"\/users\/{userId}\/verification\/phone":{"patch":{"summary":"Update phone verification","operationId":"usersUpdatePhoneVerification","tags":["users"],"description":"Update the user phone verification status by its unique ID.","responses":{"200":{"description":"User","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/user"}}}}},"x-appwrite":{"method":"updatePhoneVerification","weight":250,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"schema":{"type":"string","x-example":"<USER_ID>"},"in":"path"}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"phoneVerification":{"type":"boolean","description":"User phone verification status.","x-example":false}},"required":["phoneVerification"]}}}}}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"components":{"schemas":{"any":{"description":"Any","type":"object","additionalProperties":true},"error":{"description":"Error","type":"object","properties":{"message":{"type":"string","description":"Error message.","x-example":"Not found"},"code":{"type":"string","description":"Error code.","x-example":"404"},"type":{"type":"string","description":"Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes","x-example":"not_found"},"version":{"type":"string","description":"Server version number.","x-example":"1.0"}},"required":["message","code","type","version"]},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"$ref":"#\/components\/schemas\/document"},"x-example":""}},"required":["total","documents"]},"collectionList":{"description":"Collections List","type":"object","properties":{"total":{"type":"integer","description":"Total number of collections documents that matched your query.","x-example":5,"format":"int32"},"collections":{"type":"array","description":"List of collections.","items":{"$ref":"#\/components\/schemas\/collection"},"x-example":""}},"required":["total","collections"]},"databaseList":{"description":"Databases List","type":"object","properties":{"total":{"type":"integer","description":"Total number of databases documents that matched your query.","x-example":5,"format":"int32"},"databases":{"type":"array","description":"List of databases.","items":{"$ref":"#\/components\/schemas\/database"},"x-example":""}},"required":["total","databases"]},"indexList":{"description":"Indexes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of indexes documents that matched your query.","x-example":5,"format":"int32"},"indexes":{"type":"array","description":"List of indexes.","items":{"$ref":"#\/components\/schemas\/index"},"x-example":""}},"required":["total","indexes"]},"userList":{"description":"Users List","type":"object","properties":{"total":{"type":"integer","description":"Total number of users documents that matched your query.","x-example":5,"format":"int32"},"users":{"type":"array","description":"List of users.","items":{"$ref":"#\/components\/schemas\/user"},"x-example":""}},"required":["total","users"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"$ref":"#\/components\/schemas\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"$ref":"#\/components\/schemas\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"$ref":"#\/components\/schemas\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"$ref":"#\/components\/schemas\/file"},"x-example":""}},"required":["total","files"]},"bucketList":{"description":"Buckets List","type":"object","properties":{"total":{"type":"integer","description":"Total number of buckets documents that matched your query.","x-example":5,"format":"int32"},"buckets":{"type":"array","description":"List of buckets.","items":{"$ref":"#\/components\/schemas\/bucket"},"x-example":""}},"required":["total","buckets"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"$ref":"#\/components\/schemas\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"$ref":"#\/components\/schemas\/membership"},"x-example":""}},"required":["total","memberships"]},"functionList":{"description":"Functions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of functions documents that matched your query.","x-example":5,"format":"int32"},"functions":{"type":"array","description":"List of functions.","items":{"$ref":"#\/components\/schemas\/function"},"x-example":""}},"required":["total","functions"]},"runtimeList":{"description":"Runtimes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of runtimes documents that matched your query.","x-example":5,"format":"int32"},"runtimes":{"type":"array","description":"List of runtimes.","items":{"$ref":"#\/components\/schemas\/runtime"},"x-example":""}},"required":["total","runtimes"]},"deploymentList":{"description":"Deployments List","type":"object","properties":{"total":{"type":"integer","description":"Total number of deployments documents that matched your query.","x-example":5,"format":"int32"},"deployments":{"type":"array","description":"List of deployments.","items":{"$ref":"#\/components\/schemas\/deployment"},"x-example":""}},"required":["total","deployments"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"$ref":"#\/components\/schemas\/execution"},"x-example":""}},"required":["total","executions"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"$ref":"#\/components\/schemas\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"$ref":"#\/components\/schemas\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"$ref":"#\/components\/schemas\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"$ref":"#\/components\/schemas\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"$ref":"#\/components\/schemas\/phone"},"x-example":""}},"required":["total","phones"]},"variableList":{"description":"Variables List","type":"object","properties":{"total":{"type":"integer","description":"Total number of variables documents that matched your query.","x-example":5,"format":"int32"},"variables":{"type":"array","description":"List of variables.","items":{"$ref":"#\/components\/schemas\/variable"},"x-example":""}},"required":["total","variables"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"$ref":"#\/components\/schemas\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"providerList":{"description":"Provider list","type":"object","properties":{"total":{"type":"integer","description":"Total number of providers documents that matched your query.","x-example":5,"format":"int32"},"providers":{"type":"array","description":"List of providers.","items":{"$ref":"#\/components\/schemas\/provider"},"x-example":""}},"required":["total","providers"]},"messageList":{"description":"Message list","type":"object","properties":{"total":{"type":"integer","description":"Total number of messages documents that matched your query.","x-example":5,"format":"int32"},"messages":{"type":"array","description":"List of messages.","items":{"$ref":"#\/components\/schemas\/message"},"x-example":""}},"required":["total","messages"]},"topicList":{"description":"Topic list","type":"object","properties":{"total":{"type":"integer","description":"Total number of topics documents that matched your query.","x-example":5,"format":"int32"},"topics":{"type":"array","description":"List of topics.","items":{"$ref":"#\/components\/schemas\/topic"},"x-example":""}},"required":["total","topics"]},"subscriberList":{"description":"Subscriber list","type":"object","properties":{"total":{"type":"integer","description":"Total number of subscribers documents that matched your query.","x-example":5,"format":"int32"},"subscribers":{"type":"array","description":"List of subscribers.","items":{"$ref":"#\/components\/schemas\/subscriber"},"x-example":""}},"required":["total","subscribers"]},"targetList":{"description":"Target list","type":"object","properties":{"total":{"type":"integer","description":"Total number of targets documents that matched your query.","x-example":5,"format":"int32"},"targets":{"type":"array","description":"List of targets.","items":{"$ref":"#\/components\/schemas\/target"},"x-example":""}},"required":["total","targets"]},"database":{"description":"Database","type":"object","properties":{"$id":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Database name.","x-example":"My Database"},"$createdAt":{"type":"string","description":"Database creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Database update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"enabled":{"type":"boolean","description":"If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false}},"required":["$id","name","$createdAt","$updatedAt","enabled"]},"collection":{"description":"Collection","type":"object","properties":{"$id":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Collection creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Collection update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Collection name.","x-example":"My Collection"},"enabled":{"type":"boolean","description":"Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false},"documentSecurity":{"type":"boolean","description":"Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"attributes":{"type":"array","description":"Collection attributes.","items":{"anyOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]},"x-example":{}},"indexes":{"type":"array","description":"Collection indexes.","items":{"$ref":"#\/components\/schemas\/index"},"x-example":{}}},"required":["$id","$createdAt","$updatedAt","$permissions","databaseId","name","enabled","documentSecurity","attributes","indexes"]},"attributeList":{"description":"Attributes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of attributes in the given collection.","x-example":5,"format":"int32"},"attributes":{"type":"array","description":"List of attributes.","items":{"anyOf":[{"$ref":"#\/components\/schemas\/attributeBoolean"},{"$ref":"#\/components\/schemas\/attributeInteger"},{"$ref":"#\/components\/schemas\/attributeFloat"},{"$ref":"#\/components\/schemas\/attributeEmail"},{"$ref":"#\/components\/schemas\/attributeEnum"},{"$ref":"#\/components\/schemas\/attributeUrl"},{"$ref":"#\/components\/schemas\/attributeIp"},{"$ref":"#\/components\/schemas\/attributeDatetime"},{"$ref":"#\/components\/schemas\/attributeRelationship"},{"$ref":"#\/components\/schemas\/attributeString"}]},"x-example":""}},"required":["total","attributes"]},"attributeString":{"description":"AttributeString","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"size":{"type":"integer","description":"Attribute size.","x-example":128,"format":"int32"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default","nullable":true}},"required":["key","type","status","error","required","size"]},"attributeInteger":{"description":"AttributeInteger","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"count"},"type":{"type":"string","description":"Attribute type.","x-example":"integer"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"min":{"type":"integer","description":"Minimum value to enforce for new documents.","x-example":1,"format":"int32","nullable":true},"max":{"type":"integer","description":"Maximum value to enforce for new documents.","x-example":10,"format":"int32","nullable":true},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":10,"format":"int32","nullable":true}},"required":["key","type","status","error","required"]},"attributeFloat":{"description":"AttributeFloat","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"percentageCompleted"},"type":{"type":"string","description":"Attribute type.","x-example":"double"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"min":{"type":"number","description":"Minimum value to enforce for new documents.","x-example":1.5,"format":"double","nullable":true},"max":{"type":"number","description":"Maximum value to enforce for new documents.","x-example":10.5,"format":"double","nullable":true},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":2.5,"format":"double","nullable":true}},"required":["key","type","status","error","required"]},"attributeBoolean":{"description":"AttributeBoolean","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"isEnabled"},"type":{"type":"string","description":"Attribute type.","x-example":"boolean"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"nullable":true}},"required":["key","type","status","error","required"]},"attributeEmail":{"description":"AttributeEmail","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"userEmail"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"email"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default@example.com","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeEnum":{"description":"AttributeEnum","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"status"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"elements":{"type":"array","description":"Array of elements in enumerated type.","items":{"type":"string"},"x-example":"element"},"format":{"type":"string","description":"String format.","x-example":"enum"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"element","nullable":true}},"required":["key","type","status","error","required","elements","format"]},"attributeIp":{"description":"AttributeIP","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"ipAddress"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"ip"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"192.0.2.0","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeUrl":{"description":"AttributeURL","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"githubUrl"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"String format.","x-example":"url"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"http:\/\/example.com","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeDatetime":{"description":"AttributeDatetime","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"birthDay"},"type":{"type":"string","description":"Attribute type.","x-example":"datetime"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"format":{"type":"string","description":"ISO 8601 format.","x-example":"datetime"},"default":{"type":"string","description":"Default value for attribute when not provided. Only null is optional","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true}},"required":["key","type","status","error","required","format"]},"attributeRelationship":{"description":"AttributeRelationship","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"nullable":true},"relatedCollection":{"type":"string","description":"The ID of the related collection.","x-example":"collection"},"relationType":{"type":"string","description":"The type of the relationship.","x-example":"oneToOne|oneToMany|manyToOne|manyToMany"},"twoWay":{"type":"boolean","description":"Is the relationship two-way?","x-example":false},"twoWayKey":{"type":"string","description":"The key of the two-way relationship.","x-example":"string"},"onDelete":{"type":"string","description":"How deleting the parent document will propagate to child documents.","x-example":"restrict|cascade|setNull"},"side":{"type":"string","description":"Whether this is the parent or child side of the relationship","x-example":"parent|child"}},"required":["key","type","status","error","required","relatedCollection","relationType","twoWay","twoWayKey","onDelete","side"]},"index":{"description":"Index","type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":"index1"},"type":{"type":"string","description":"Index type.","x-example":"primary"},"status":{"type":"string","description":"Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an index.","x-example":"string"},"attributes":{"type":"array","description":"Index attributes.","items":{"type":"string"},"x-example":[]},"orders":{"type":"array","description":"Index orders.","items":{"type":"string"},"x-example":[],"nullable":true}},"required":["key","type","status","error","attributes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"oneOf":[{"$ref":"#\/components\/schemas\/algoArgon2"},{"$ref":"#\/components\/schemas\/algoScrypt"},{"$ref":"#\/components\/schemas\/algoScryptModified"},{"$ref":"#\/components\/schemas\/algoBcrypt"},{"$ref":"#\/components\/schemas\/algoPhpass"},{"$ref":"#\/components\/schemas\/algoSha"},{"$ref":"#\/components\/schemas\/algoMd5"}]},"nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"$ref":"#\/components\/schemas\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"bucket":{"description":"Bucket","type":"object","properties":{"$id":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Bucket creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Bucket update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"fileSecurity":{"type":"boolean","description":"Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"name":{"type":"string","description":"Bucket name.","x-example":"Documents"},"enabled":{"type":"boolean","description":"Bucket enabled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size supported.","x-example":100,"format":"int32"},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions.","items":{"type":"string"},"x-example":["jpg","png"]},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).","x-example":"gzip"},"encryption":{"type":"boolean","description":"Bucket is encrypted.","x-example":false},"antivirus":{"type":"boolean","description":"Virus scanning is enabled.","x-example":false}},"required":["$id","$createdAt","$updatedAt","$permissions","fileSecurity","name","enabled","maximumFileSize","allowedFileExtensions","compression","encryption","antivirus"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"$ref":"#\/components\/schemas\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"function":{"description":"Function","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"execute":{"type":"array","description":"Execution permissions.","items":{"type":"string"},"x-example":"users"},"name":{"type":"string","description":"Function name.","x-example":"My Function"},"enabled":{"type":"boolean","description":"Function enabled.","x-example":false},"live":{"type":"boolean","description":"Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"runtime":{"type":"string","description":"Function execution runtime.","x-example":"python-3.8"},"deployment":{"type":"string","description":"Function's active deployment ID.","x-example":"5e5ea5c16897e"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"vars":{"type":"array","description":"Function variables.","items":{"$ref":"#\/components\/schemas\/variable"},"x-example":[]},"events":{"type":"array","description":"Function trigger events.","items":{"type":"string"},"x-example":"account.create"},"schedule":{"type":"string","description":"Function execution schedult in CRON format.","x-example":"5 4 * * *"},"timeout":{"type":"integer","description":"Function execution timeout in seconds.","x-example":300,"format":"int32"},"entrypoint":{"type":"string","description":"The entrypoint file used to execute the deployment.","x-example":"index.js"},"commands":{"type":"string","description":"The build command used to build the deployment.","x-example":"npm install"},"version":{"type":"string","description":"Version of Open Runtimes used for the function.","x-example":"v2"},"installationId":{"type":"string","description":"Function VCS (Version Control System) installation id.","x-example":"6m40at4ejk5h2u9s1hboo"},"providerRepositoryId":{"type":"string","description":"VCS (Version Control System) Repository ID","x-example":"appwrite"},"providerBranch":{"type":"string","description":"VCS (Version Control System) branch name","x-example":"main"},"providerRootDirectory":{"type":"string","description":"Path to function in VCS (Version Control System) repository","x-example":"functions\/helloWorld"},"providerSilentMode":{"type":"boolean","description":"Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests","x-example":false}},"required":["$id","$createdAt","$updatedAt","execute","name","enabled","live","logging","runtime","deployment","scopes","vars","events","schedule","timeout","entrypoint","commands","version","installationId","providerRepositoryId","providerBranch","providerRootDirectory","providerSilentMode"]},"runtime":{"description":"Runtime","type":"object","properties":{"$id":{"type":"string","description":"Runtime ID.","x-example":"python-3.8"},"name":{"type":"string","description":"Runtime Name.","x-example":"Python"},"version":{"type":"string","description":"Runtime version.","x-example":"3.8"},"base":{"type":"string","description":"Base Docker image used to build the runtime.","x-example":"python:3.8-alpine"},"image":{"type":"string","description":"Image name of Docker Hub.","x-example":"appwrite\\\/runtime-for-python:3.8"},"logo":{"type":"string","description":"Name of the logo image.","x-example":"python.png"},"supports":{"type":"array","description":"List of supported architectures.","items":{"type":"string"},"x-example":"amd64"}},"required":["$id","name","version","base","image","logo","supports"]},"deployment":{"description":"Deployment","type":"object","properties":{"$id":{"type":"string","description":"Deployment ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Deployment update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"type":{"type":"string","description":"Type of deployment.","x-example":"vcs"},"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea6g16897e"},"resourceType":{"type":"string","description":"Resource type.","x-example":"functions"},"entrypoint":{"type":"string","description":"The entrypoint file to use to execute the deployment code.","x-example":"index.js"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"},"buildId":{"type":"string","description":"The current build ID.","x-example":"5e5ea5c16897e"},"activate":{"type":"boolean","description":"Whether the deployment should be automatically activated.","x-example":true},"status":{"type":"string","description":"The deployment status. Possible values are \"processing\", \"building\", \"waiting\", \"ready\", and \"failed\".","x-example":"ready"},"buildLogs":{"type":"string","description":"The build logs.","x-example":"Compiling source files..."},"buildTime":{"type":"integer","description":"The current build time in seconds.","x-example":128,"format":"int32"},"providerRepositoryName":{"type":"string","description":"The name of the vcs provider repository","x-example":"database"},"providerRepositoryOwner":{"type":"string","description":"The name of the vcs provider repository owner","x-example":"utopia"},"providerRepositoryUrl":{"type":"string","description":"The url of the vcs provider repository","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function"},"providerBranch":{"type":"string","description":"The branch of the vcs repository","x-example":"0.7.x"},"providerCommitHash":{"type":"string","description":"The commit hash of the vcs commit","x-example":"7c3f25d"},"providerCommitAuthorUrl":{"type":"string","description":"The url of vcs commit author","x-example":"https:\/\/github.com\/vermakhushboo"},"providerCommitAuthor":{"type":"string","description":"The name of vcs commit author","x-example":"Khushboo Verma"},"providerCommitMessage":{"type":"string","description":"The commit message","x-example":"Update index.js"},"providerCommitUrl":{"type":"string","description":"The url of the vcs commit","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"},"providerBranchUrl":{"type":"string","description":"The branch of the vcs repository","x-example":"https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"}},"required":["$id","$createdAt","$updatedAt","type","resourceId","resourceType","entrypoint","size","buildId","activate","status","buildLogs","buildTime","providerRepositoryName","providerRepositoryOwner","providerRepositoryUrl","providerBranch","providerCommitHash","providerCommitAuthorUrl","providerCommitAuthor","providerCommitMessage","providerCommitUrl","providerBranchUrl"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"$ref":"#\/components\/schemas\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"build":{"description":"Build","type":"object","properties":{"$id":{"type":"string","description":"Build ID.","x-example":"5e5ea5c16897e"},"deploymentId":{"type":"string","description":"The deployment that created this build.","x-example":"5e5ea5c16897e"},"status":{"type":"string","description":"The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built","x-example":"ready"},"stdout":{"type":"string","description":"The stdout of the build.","x-example":""},"stderr":{"type":"string","description":"The stderr of the build.","x-example":""},"startTime":{"type":"string","description":"The deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"endTime":{"type":"string","description":"The time the build was finished in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"duration":{"type":"integer","description":"The build duration in seconds.","x-example":0,"format":"int32"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"}},"required":["$id","deploymentId","status","stdout","stderr","startTime","endTime","duration","size"]},"variable":{"description":"Variable","type":"object","properties":{"$id":{"type":"string","description":"Variable ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"key":{"type":"string","description":"Variable key.","x-example":"API_KEY"},"value":{"type":"string","description":"Variable value.","x-example":"myPa$$word1"},"resourceType":{"type":"string","description":"Service to which the variable belongs. Possible values are \"project\", \"function\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"}},"required":["$id","$createdAt","$updatedAt","key","value","resourceType","resourceId"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"healthAntivirus":{"description":"Health Antivirus","type":"object","properties":{"version":{"type":"string","description":"Antivirus version.","x-example":"1.0.0"},"status":{"type":"string","description":"Antivirus status. Possible values can are: `disabled`, `offline`, `online`","x-example":"online"}},"required":["version","status"]},"healthQueue":{"description":"Health Queue","type":"object","properties":{"size":{"type":"integer","description":"Amount of actions in the queue.","x-example":8,"format":"int32"}},"required":["size"]},"healthStatus":{"description":"Health Status","type":"object","properties":{"name":{"type":"string","description":"Name of the service.","x-example":"database"},"ping":{"type":"integer","description":"Duration in milliseconds how long the health check took.","x-example":128,"format":"int32"},"status":{"type":"string","description":"Service status. Possible values can are: `pass`, `fail`","x-example":"pass"}},"required":["name","ping","status"]},"healthCertificate":{"description":"Health Certificate","type":"object","properties":{"name":{"type":"string","description":"Certificate name","x-example":"\/CN=www.google.com"},"subjectSN":{"type":"string","description":"Subject SN","x-example":""},"issuerOrganisation":{"type":"string","description":"Issuer organisation","x-example":""},"validFrom":{"type":"string","description":"Valid from","x-example":"1704200998"},"validTo":{"type":"string","description":"Valid to","x-example":"1711458597"},"signatureTypeSN":{"type":"string","description":"Signature type SN","x-example":"RSA-SHA256"}},"required":["name","subjectSN","issuerOrganisation","validFrom","validTo","signatureTypeSN"]},"healthTime":{"description":"Health Time","type":"object","properties":{"remoteTime":{"type":"integer","description":"Current unix timestamp on trustful remote server.","x-example":1639490751,"format":"int32"},"localTime":{"type":"integer","description":"Current unix timestamp of local server where Appwrite runs.","x-example":1639490844,"format":"int32"},"diff":{"type":"integer","description":"Difference of unix remote and local timestamps in milliseconds.","x-example":93,"format":"int32"}},"required":["remoteTime","localTime","diff"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"provider":{"description":"Provider","type":"object","properties":{"$id":{"type":"string","description":"Provider ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Provider creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Provider update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name for the provider instance.","x-example":"Mailgun"},"provider":{"type":"string","description":"The name of the provider service.","x-example":"mailgun"},"enabled":{"type":"boolean","description":"Is provider enabled?","x-example":true},"type":{"type":"string","description":"Type of provider.","x-example":"sms"},"credentials":{"type":"object","description":"Provider credentials.","x-example":{"key":"123456789"}},"options":{"type":"object","description":"Provider options.","x-example":{"from":"sender-email@mydomain"},"nullable":true}},"required":["$id","$createdAt","$updatedAt","name","provider","enabled","type","credentials"]},"message":{"description":"Message","type":"object","properties":{"$id":{"type":"string","description":"Message ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Message creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Message update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerType":{"type":"string","description":"Message provider type.","x-example":"email"},"topics":{"type":"array","description":"Topic IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"users":{"type":"array","description":"User IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"targets":{"type":"array","description":"Target IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"scheduledAt":{"type":"string","description":"The scheduled time for message.","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true},"deliveredAt":{"type":"string","description":"The time when the message was delivered.","x-example":"2020-10-15T06:38:00.000+00:00","nullable":true},"deliveryErrors":{"type":"array","description":"Delivery errors if any.","items":{"type":"string"},"x-example":["Failed to send message to target 5e5ea5c16897e: Credentials not valid."],"nullable":true},"deliveredTotal":{"type":"integer","description":"Number of recipients the message was delivered to.","x-example":1,"format":"int32"},"data":{"type":"object","description":"Data of the message.","x-example":{"subject":"Welcome to Appwrite","content":"Hi there, welcome to Appwrite family."}},"status":{"type":"string","description":"Status of delivery.","x-example":"Message status can be one of the following: draft, processing, scheduled, sent, or failed."}},"required":["$id","$createdAt","$updatedAt","providerType","topics","users","targets","deliveredTotal","data","status"]},"topic":{"description":"Topic","type":"object","properties":{"$id":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Topic creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Topic update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name of the topic.","x-example":"events"},"emailTotal":{"type":"integer","description":"Total count of email subscribers subscribed to the topic.","x-example":100,"format":"int32"},"smsTotal":{"type":"integer","description":"Total count of SMS subscribers subscribed to the topic.","x-example":100,"format":"int32"},"pushTotal":{"type":"integer","description":"Total count of push subscribers subscribed to the topic.","x-example":100,"format":"int32"},"subscribe":{"type":"array","description":"Subscribe permissions.","items":{"type":"string"},"x-example":"users"}},"required":["$id","$createdAt","$updatedAt","name","emailTotal","smsTotal","pushTotal","subscribe"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"$ref":"#\/components\/schemas\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]}},"securitySchemes":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"Key":{"type":"apiKey","name":"X-Appwrite-Key","description":"Your secret API key","in":"header","x-appwrite":{"demo":"<YOUR_API_KEY>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header"},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Session":{"type":"apiKey","name":"X-Appwrite-Session","description":"The user session to authenticate with","in":"header"},"ForwardedUserAgent":{"type":"apiKey","name":"X-Forwarded-User-Agent","description":"The user agent string of the client that made the request","in":"header"}}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file diff --git a/app/config/specs/swagger2-latest-client.json b/app/config/specs/swagger2-latest-client.json index a9affb0f9a..20d8c0a6ff 100644 --- a/app/config/specs/swagger2-latest-client.json +++ b/app/config/specs/swagger2-latest-client.json @@ -1 +1 @@ -{"swagger":"2.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"host":"cloud.appwrite.io","basePath":"\/v1","schemes":["https"],"consumes":["application\/json","multipart\/form-data"],"produces":["application\/json"],"securityDefinitions":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header","x-appwrite":{"demo":"<YOUR_JWT>"}},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Session":{"type":"apiKey","name":"X-Appwrite-Session","description":"The user session to authenticate with","in":"header"}},"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","schema":{"$ref":"#\/definitions\/mfaType"}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","schema":{"$ref":"#\/definitions\/mfaChallenge"}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","default":null,"x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}]},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","default":null,"x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["challengeId","otp"]}}]}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","default":"","x-example":"password"}},"required":["password"]}}]}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["phone","password"]}}]}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["email","url"]}}]},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","default":null,"x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null}},"required":["userId","secret","password"]}}]}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 session","operationId":"accountCreateOAuth2Session","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Session","weight":18,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/targets\/push":{"post":{"summary":"Create push target","operationId":"accountCreatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createPushTarget","weight":53,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"}},"required":["targetId","identifier"]}}]}},"\/account\/targets\/{targetId}\/push":{"put":{"summary":"Update push target","operationId":"accountUpdatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updatePushTarget","weight":54,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"}},"required":["identifier"]}}]},"delete":{"summary":"Delete push target","operationId":"accountDeletePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deletePushTarget","weight":55,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","default":"","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"}},"required":["userId","phone"]}}]}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["url"]}}]},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"type":"string","x-example":"<NAME>","default":"","in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"type":"string","default":"","in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"type":"string","x-example":"<TEXT>","in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":1,"default":400,"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"type":"integer","format":"int32","x-example":0,"default":1,"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"type":"boolean","x-example":false,"default":false,"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","schema":{"$ref":"#\/definitions\/documentList"}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","default":{},"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","default":[],"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","schema":{"$ref":"#\/definitions\/executionList"}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","default":"","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","default":false,"x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","default":"\/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","default":"POST","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","default":[],"x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","schema":{"$ref":"#\/definitions\/locale"}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","schema":{"$ref":"#\/definitions\/localeCodeList"}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","schema":{"$ref":"#\/definitions\/continentList"}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","schema":{"$ref":"#\/definitions\/phoneList"}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","schema":{"$ref":"#\/definitions\/currencyList"}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","schema":{"$ref":"#\/definitions\/languageList"}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Session":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","default":null,"x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","default":null,"x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}]}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Session":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","schema":{"$ref":"#\/definitions\/fileList"}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"x-upload-id":true,"type":"string","x-example":"<FILE_ID>","in":"formData"},{"name":"file","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","required":true,"type":"file","in":"formData"},{"name":"permissions","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"x-example":"[\"read(\"any\")\"]","in":"formData"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","consumes":["application\/json"],"produces":["image\/*"],"tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center","in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"type":"number","format":"float","x-example":0,"default":1,"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"type":"integer","format":"int32","x-example":-360,"default":0,"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":"","in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","schema":{"$ref":"#\/definitions\/teamList"}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":["owner"],"x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}]}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]},"delete":{"summary":"Delete team","operationId":"teamsDelete","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","default":"","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","default":"","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","default":"","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["roles"]}}]}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["roles"]}}]},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"definitions":{"any":{"description":"Any","type":"object","additionalProperties":true},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"type":"object","$ref":"#\/definitions\/document"},"x-example":""}},"required":["total","documents"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"type":"object","$ref":"#\/definitions\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"type":"object","$ref":"#\/definitions\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"type":"object","$ref":"#\/definitions\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"type":"object","$ref":"#\/definitions\/file"},"x-example":""}},"required":["total","files"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"type":"object","$ref":"#\/definitions\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"type":"object","$ref":"#\/definitions\/membership"},"x-example":""}},"required":["total","memberships"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"type":"object","$ref":"#\/definitions\/execution"},"x-example":""}},"required":["total","executions"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"type":"object","$ref":"#\/definitions\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"type":"object","$ref":"#\/definitions\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"type":"object","$ref":"#\/definitions\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"type":"object","$ref":"#\/definitions\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"type":"object","$ref":"#\/definitions\/phone"},"x-example":""}},"required":["total","phones"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"type":"object","$ref":"#\/definitions\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","x-nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","x-nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"x-oneOf":[{"$ref":"#\/definitions\/algoArgon2"},{"$ref":"#\/definitions\/algoScrypt"},{"$ref":"#\/definitions\/algoScryptModified"},{"$ref":"#\/definitions\/algoBcrypt"},{"$ref":"#\/definitions\/algoPhpass"},{"$ref":"#\/definitions\/algoSha"},{"$ref":"#\/definitions\/algoMd5"}]},"x-nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"type":"object","$ref":"#\/definitions\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","x-nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file +{"swagger":"2.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"host":"cloud.appwrite.io","basePath":"\/v1","schemes":["https"],"consumes":["application\/json","multipart\/form-data"],"produces":["application\/json"],"securityDefinitions":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header","x-appwrite":{"demo":"<YOUR_JWT>"}},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Session":{"type":"apiKey","name":"X-Appwrite-Session","description":"The user session to authenticate with","in":"header"}},"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","schema":{"$ref":"#\/definitions\/mfaType"}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","schema":{"$ref":"#\/definitions\/mfaChallenge"}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","default":null,"x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}]},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","default":null,"x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["challengeId","otp"]}}]}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","default":"","x-example":"password"}},"required":["password"]}}]}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["phone","password"]}}]}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["email","url"]}}]},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","default":null,"x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null}},"required":["userId","secret","password"]}}]}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 session","operationId":"accountCreateOAuth2Session","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Session","weight":18,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/targets\/push":{"post":{"summary":"Create push target","operationId":"accountCreatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createPushTarget","weight":53,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"}},"required":["targetId","identifier"]}}]}},"\/account\/targets\/{targetId}\/push":{"put":{"summary":"Update push target","operationId":"accountUpdatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updatePushTarget","weight":54,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"}},"required":["identifier"]}}]},"delete":{"summary":"Delete push target","operationId":"accountDeletePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deletePushTarget","weight":55,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","default":"","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"}},"required":["userId","phone"]}}]}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["url"]}}]},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"type":"string","x-example":"<NAME>","default":"","in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"type":"string","default":"","in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"type":"string","x-example":"<TEXT>","in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":1,"default":400,"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"type":"integer","format":"int32","x-example":0,"default":1,"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"type":"boolean","x-example":false,"default":false,"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","schema":{"$ref":"#\/definitions\/documentList"}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","default":{},"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","default":[],"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","schema":{"$ref":"#\/definitions\/executionList"}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","default":"","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","default":false,"x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","default":"\/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","default":"POST","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","default":[],"x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","schema":{"$ref":"#\/definitions\/locale"}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","schema":{"$ref":"#\/definitions\/localeCodeList"}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","schema":{"$ref":"#\/definitions\/continentList"}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","schema":{"$ref":"#\/definitions\/phoneList"}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","schema":{"$ref":"#\/definitions\/currencyList"}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","schema":{"$ref":"#\/definitions\/languageList"}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Session":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","default":null,"x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","default":null,"x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}]}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Session":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","schema":{"$ref":"#\/definitions\/fileList"}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"x-upload-id":true,"type":"string","x-example":"<FILE_ID>","in":"formData"},{"name":"file","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","required":true,"type":"file","in":"formData"},{"name":"permissions","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"x-example":"[\"read(\"any\")\"]","in":"formData"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","consumes":["application\/json"],"produces":["image\/*"],"tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center","in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"type":"number","format":"float","x-example":0,"default":1,"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"type":"integer","format":"int32","x-example":-360,"default":0,"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":"","in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","schema":{"$ref":"#\/definitions\/teamList"}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":["owner"],"x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}]}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]},"delete":{"summary":"Delete team","operationId":"teamsDelete","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","default":"","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","default":"","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","default":"","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["roles"]}}]}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["roles"]}}]},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"definitions":{"any":{"description":"Any","type":"object","additionalProperties":true},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"type":"object","$ref":"#\/definitions\/document"},"x-example":""}},"required":["total","documents"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"type":"object","$ref":"#\/definitions\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"type":"object","$ref":"#\/definitions\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"type":"object","$ref":"#\/definitions\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"type":"object","$ref":"#\/definitions\/file"},"x-example":""}},"required":["total","files"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"type":"object","$ref":"#\/definitions\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"type":"object","$ref":"#\/definitions\/membership"},"x-example":""}},"required":["total","memberships"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"type":"object","$ref":"#\/definitions\/execution"},"x-example":""}},"required":["total","executions"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"type":"object","$ref":"#\/definitions\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"type":"object","$ref":"#\/definitions\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"type":"object","$ref":"#\/definitions\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"type":"object","$ref":"#\/definitions\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"type":"object","$ref":"#\/definitions\/phone"},"x-example":""}},"required":["total","phones"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"type":"object","$ref":"#\/definitions\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","x-nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","x-nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"x-oneOf":[{"$ref":"#\/definitions\/algoArgon2"},{"$ref":"#\/definitions\/algoScrypt"},{"$ref":"#\/definitions\/algoScryptModified"},{"$ref":"#\/definitions\/algoBcrypt"},{"$ref":"#\/definitions\/algoPhpass"},{"$ref":"#\/definitions\/algoSha"},{"$ref":"#\/definitions\/algoMd5"}]},"x-nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"type":"object","$ref":"#\/definitions\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","x-nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file diff --git a/app/config/specs/swagger2-latest-console.json b/app/config/specs/swagger2-latest-console.json index d1f57ad99c..61993ac308 100644 --- a/app/config/specs/swagger2-latest-console.json +++ b/app/config/specs/swagger2-latest-console.json @@ -1 +1 @@ -{"swagger":"2.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"host":"cloud.appwrite.io","basePath":"\/v1","schemes":["https"],"consumes":["application\/json","multipart\/form-data"],"produces":["application\/json"],"securityDefinitions":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"Key":{"type":"apiKey","name":"X-Appwrite-Key","description":"Your secret API key","in":"header","x-appwrite":{"demo":"<YOUR_API_KEY>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header","x-appwrite":{"demo":"<YOUR_JWT>"}},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Mode":{"type":"apiKey","name":"X-Appwrite-Mode","description":"","in":"header","x-appwrite":{"demo":""}}},"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]},"delete":{"summary":"Delete account","operationId":"accountDelete","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete the currently logged in user.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":9,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","schema":{"$ref":"#\/definitions\/mfaType"}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","schema":{"$ref":"#\/definitions\/mfaChallenge"}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","default":null,"x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}]},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","default":null,"x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["challengeId","otp"]}}]}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","default":"","x-example":"password"}},"required":["password"]}}]}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["phone","password"]}}]}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["email","url"]}}]},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","default":null,"x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null}},"required":["userId","secret","password"]}}]}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 session","operationId":"accountCreateOAuth2Session","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Session","weight":18,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/targets\/push":{"post":{"summary":"Create push target","operationId":"accountCreatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createPushTarget","weight":53,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"}},"required":["targetId","identifier"]}}]}},"\/account\/targets\/{targetId}\/push":{"put":{"summary":"Update push target","operationId":"accountUpdatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updatePushTarget","weight":54,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"}},"required":["identifier"]}}]},"delete":{"summary":"Delete push target","operationId":"accountDeletePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deletePushTarget","weight":55,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","default":"","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"}},"required":["userId","phone"]}}]}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["url"]}}]},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"type":"string","x-example":"<NAME>","default":"","in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"type":"string","default":"","in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"type":"string","x-example":"<TEXT>","in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":1,"default":400,"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"type":"integer","format":"int32","x-example":0,"default":1,"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"type":"boolean","x-example":false,"default":false,"in":"query"}]}},"\/console\/assistant":{"post":{"summary":"Ask Query","operationId":"assistantChat","consumes":["application\/json"],"produces":["text\/plain"],"tags":["assistant"],"description":"","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"chat","weight":328,"cookies":false,"type":"","deprecated":false,"demo":"assistant\/chat.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/assistant\/chat.md","rate-limit":15,"rate-time":3600,"rate-key":"userId:{userId}","scope":"assistant.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prompt":{"type":"string","description":"Prompt. A string containing questions asked to the AI assistant.","default":null,"x-example":"<PROMPT>"}},"required":["prompt"]}}]}},"\/console\/variables":{"get":{"summary":"Get variables","operationId":"consoleVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["console"],"description":"Get all Environment Variables that are relevant for the console.","responses":{"200":{"description":"Console Variables","schema":{"$ref":"#\/definitions\/consoleVariables"}}},"x-appwrite":{"method":"variables","weight":327,"cookies":false,"type":"","deprecated":false,"demo":"console\/variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/console\/variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/databases":{"get":{"summary":"List databases","operationId":"databasesList","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.","responses":{"200":{"description":"Databases List","schema":{"$ref":"#\/definitions\/databaseList"}}},"x-appwrite":{"method":"list","weight":69,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create database","operationId":"databasesCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Database.\n","responses":{"201":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"create","weight":68,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"databaseId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DATABASE_ID>"},"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["databaseId","name"]}}]}},"\/databases\/usage":{"get":{"summary":"Get databases usage stats","operationId":"databasesGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"","responses":{"200":{"description":"UsageDatabases","schema":{"$ref":"#\/definitions\/usageDatabases"}}},"x-appwrite":{"method":"getUsage","weight":113,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"`Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/databases\/{databaseId}":{"get":{"summary":"Get database","operationId":"databasesGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"get","weight":70,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]},"put":{"summary":"Update database","operationId":"databasesUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a database by its unique ID.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"update","weight":72,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete database","operationId":"databasesDelete","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":73,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections":{"get":{"summary":"List collections","operationId":"databasesListCollections","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.","responses":{"200":{"description":"Collections List","schema":{"$ref":"#\/definitions\/collectionList"}}},"x-appwrite":{"method":"listCollections","weight":75,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collections.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"queries","description":"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: name, enabled, documentSecurity","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create collection","operationId":"databasesCreateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"createCollection","weight":74,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"collectionId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<COLLECTION_ID>"},"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["collectionId","name"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}":{"get":{"summary":"Get collection","operationId":"databasesGetCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"getCollection","weight":76,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]},"put":{"summary":"Update collection","operationId":"databasesUpdateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a collection by its unique ID.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"updateCollection","weight":78,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete collection","operationId":"databasesDeleteCollection","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteCollection","weight":79,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes":{"get":{"summary":"List attributes","operationId":"databasesListAttributes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List attributes in the collection.","responses":{"200":{"description":"Attributes List","schema":{"$ref":"#\/definitions\/attributeList"}}},"x-appwrite":{"method":"listAttributes","weight":90,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-attributes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, size, required, array, status, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean":{"post":{"summary":"Create boolean attribute","operationId":"databasesCreateBooleanAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a boolean attribute.\n","responses":{"202":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"createBooleanAttribute","weight":87,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}":{"patch":{"summary":"Update boolean attribute","operationId":"databasesUpdateBooleanAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a boolean attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"updateBooleanAttribute","weight":99,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime":{"post":{"summary":"Create datetime attribute","operationId":"databasesCreateDatetimeAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a date time attribute according to the ISO 8601 standard.","responses":{"202":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"createDatetimeAttribute","weight":88,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}":{"patch":{"summary":"Update dateTime attribute","operationId":"databasesUpdateDatetimeAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a date time attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"updateDatetimeAttribute","weight":100,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email":{"post":{"summary":"Create email attribute","operationId":"databasesCreateEmailAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an email attribute.\n","responses":{"202":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"createEmailAttribute","weight":81,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}":{"patch":{"summary":"Update email attribute","operationId":"databasesUpdateEmailAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an email attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"updateEmailAttribute","weight":93,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum":{"post":{"summary":"Create enum attribute","operationId":"databasesCreateEnumAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n","responses":{"202":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"createEnumAttribute","weight":82,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","elements","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}":{"patch":{"summary":"Update enum attribute","operationId":"databasesUpdateEnumAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an enum attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"updateEnumAttribute","weight":94,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["elements","required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float":{"post":{"summary":"Create float attribute","operationId":"databasesCreateFloatAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a float attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"createFloatAttribute","weight":86,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float\/{key}":{"patch":{"summary":"Update float attribute","operationId":"databasesUpdateFloatAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a float attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"updateFloatAttribute","weight":98,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer":{"post":{"summary":"Create integer attribute","operationId":"databasesCreateIntegerAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an integer attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"createIntegerAttribute","weight":85,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer\/{key}":{"patch":{"summary":"Update integer attribute","operationId":"databasesUpdateIntegerAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an integer attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"updateIntegerAttribute","weight":97,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip":{"post":{"summary":"Create IP address attribute","operationId":"databasesCreateIpAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create IP address attribute.\n","responses":{"202":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"createIpAttribute","weight":83,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}":{"patch":{"summary":"Update IP address attribute","operationId":"databasesUpdateIpAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an ip attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"updateIpAttribute","weight":95,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship":{"post":{"summary":"Create relationship attribute","operationId":"databasesCreateRelationshipAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"202":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"createRelationshipAttribute","weight":89,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"relatedCollectionId":{"type":"string","description":"Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","default":null,"x-example":"<RELATED_COLLECTION_ID>"},"type":{"type":"string","description":"Relation type","default":null,"x-example":"oneToOne","enum":["oneToOne","manyToOne","manyToMany","oneToMany"],"x-enum-name":"RelationshipType","x-enum-keys":[]},"twoWay":{"type":"boolean","description":"Is Two Way?","default":false,"x-example":false},"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"twoWayKey":{"type":"string","description":"Two Way Attribute Key.","default":null,"x-example":null},"onDelete":{"type":"string","description":"Constraints option","default":"restrict","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}},"required":["relatedCollectionId","type"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string":{"post":{"summary":"Create string attribute","operationId":"databasesCreateStringAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a string attribute.\n","responses":{"202":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"createStringAttribute","weight":80,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"size":{"type":"integer","description":"Attribute size for text attributes, in number of characters.","default":null,"x-example":1},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false},"encrypt":{"type":"boolean","description":"Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.","default":false,"x-example":false}},"required":["key","size","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}":{"patch":{"summary":"Update string attribute","operationId":"databasesUpdateStringAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a string attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"updateStringAttribute","weight":92,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url":{"post":{"summary":"Create URL attribute","operationId":"databasesCreateUrlAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a URL attribute.\n","responses":{"202":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"createUrlAttribute","weight":84,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}":{"patch":{"summary":"Update URL attribute","operationId":"databasesUpdateUrlAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an url attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"updateUrlAttribute","weight":96,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}":{"get":{"summary":"Get attribute","operationId":"databasesGetAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get attribute by ID.","responses":{"200":{"description":"AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString","schema":{"x-oneOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]}}},"x-appwrite":{"method":"getAttribute","weight":91,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete attribute","operationId":"databasesDeleteAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Deletes an attribute.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteAttribute","weight":102,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship":{"patch":{"summary":"Update relationship attribute","operationId":"databasesUpdateRelationshipAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"200":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"updateRelationshipAttribute","weight":101,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"onDelete":{"type":"string","description":"Constraints option","default":null,"x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}}}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","schema":{"$ref":"#\/definitions\/documentList"}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","default":{},"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","default":[],"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs":{"get":{"summary":"List document logs","operationId":"databasesListDocumentLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get the document activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listDocumentLogs","weight":110,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-document-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes":{"get":{"summary":"List indexes","operationId":"databasesListIndexes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List indexes in the collection.","responses":{"200":{"description":"Indexes List","schema":{"$ref":"#\/definitions\/indexList"}}},"x-appwrite":{"method":"listIndexes","weight":104,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-indexes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, status, attributes, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create index","operationId":"databasesCreateIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.","responses":{"202":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"createIndex","weight":103,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Index Key.","default":null,"x-example":null},"type":{"type":"string","description":"Index type.","default":null,"x-example":"key","enum":["key","fulltext","unique"],"x-enum-name":"IndexType","x-enum-keys":[]},"attributes":{"type":"array","description":"Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"orders":{"type":"array","description":"Array of index orders. Maximum of 100 orders are allowed.","default":[],"x-example":null,"items":{"type":"string"}}},"required":["key","type","attributes"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}":{"get":{"summary":"Get index","operationId":"databasesGetIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get index by ID.","responses":{"200":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"getIndex","weight":105,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete index","operationId":"databasesDeleteIndex","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete an index.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIndex","weight":106,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/logs":{"get":{"summary":"List collection logs","operationId":"databasesListCollectionLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get the collection activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listCollectionLogs","weight":77,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collection-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/usage":{"get":{"summary":"Get collection usage stats","operationId":"databasesGetCollectionUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"","responses":{"200":{"description":"UsageCollection","schema":{"$ref":"#\/definitions\/usageCollection"}}},"x-appwrite":{"method":"getCollectionUsage","weight":115,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]}},"\/databases\/{databaseId}\/logs":{"get":{"summary":"List database logs","operationId":"databasesListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get the database activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":71,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/usage":{"get":{"summary":"Get database usage stats","operationId":"databasesGetDatabaseUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"","responses":{"200":{"description":"UsageDatabase","schema":{"$ref":"#\/definitions\/usageDatabase"}}},"x-appwrite":{"method":"getDatabaseUsage","weight":114,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-database-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"range","description":"`Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/functions":{"get":{"summary":"List functions","operationId":"functionsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's functions. You can use the query params to filter your results.","responses":{"200":{"description":"Functions List","schema":{"$ref":"#\/definitions\/functionList"}}},"x-appwrite":{"method":"list","weight":287,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create function","operationId":"functionsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.","responses":{"201":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"create","weight":286,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"functionId":{"type":"string","description":"Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<FUNCTION_ID>"},"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":null,"x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.21","deno-1.24","deno-1.35","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Function maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Control System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function.","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function.","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"},"templateRepository":{"type":"string","description":"Repository name of the template.","default":"","x-example":"<TEMPLATE_REPOSITORY>"},"templateOwner":{"type":"string","description":"The name of the owner of the template.","default":"","x-example":"<TEMPLATE_OWNER>"},"templateRootDirectory":{"type":"string","description":"Path to function code in the template repo.","default":"","x-example":"<TEMPLATE_ROOT_DIRECTORY>"},"templateBranch":{"type":"string","description":"Production branch for the repo linked to the function template.","default":"","x-example":"<TEMPLATE_BRANCH>"}},"required":["functionId","name","runtime"]}}]}},"\/functions\/runtimes":{"get":{"summary":"List runtimes","operationId":"functionsListRuntimes","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all runtimes that are currently active on your instance.","responses":{"200":{"description":"Runtimes List","schema":{"$ref":"#\/definitions\/runtimeList"}}},"x-appwrite":{"method":"listRuntimes","weight":288,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-runtimes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-runtimes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/functions\/usage":{"get":{"summary":"Get functions usage","operationId":"functionsGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"UsageFunctions","schema":{"$ref":"#\/definitions\/usageFunctions"}}},"x-appwrite":{"method":"getUsage","weight":291,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"FunctionUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/functions\/{functionId}":{"get":{"summary":"Get function","operationId":"functionsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"get","weight":289,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"put":{"summary":"Update function","operationId":"functionsUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"update","weight":292,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":"","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.21","deno-1.24","deno-1.35","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Controle System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"}},"required":["name"]}}]},"delete":{"summary":"Delete function","operationId":"functionsDelete","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":295,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments":{"get":{"summary":"List deployments","operationId":"functionsListDeployments","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's code deployments. You can use the query params to filter your results.","responses":{"200":{"description":"Deployments List","schema":{"$ref":"#\/definitions\/deploymentList"}}},"x-appwrite":{"method":"listDeployments","weight":297,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: size, buildId, activate, entrypoint, commands","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create deployment","operationId":"functionsCreateDeployment","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.","responses":{"202":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"createDeployment","weight":296,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":true,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"entrypoint","description":"Entrypoint File.","required":false,"type":"string","x-example":"<ENTRYPOINT>","in":"formData"},{"name":"commands","description":"Build Commands.","required":false,"type":"string","x-example":"<COMMANDS>","in":"formData"},{"name":"code","description":"Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.","required":true,"type":"file","in":"formData"},{"name":"activate","description":"Automatically activate the deployment when it is finished building.","required":true,"type":"boolean","x-example":false,"in":"formData"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}":{"get":{"summary":"Get deployment","operationId":"functionsGetDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a code deployment by its unique ID.","responses":{"200":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"getDeployment","weight":298,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"patch":{"summary":"Update function deployment","operationId":"functionsUpdateDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"updateDeployment","weight":294,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"delete":{"summary":"Delete deployment","operationId":"functionsDeleteDeployment","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a code deployment by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDeployment","weight":299,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/build":{"post":{"summary":"Rebuild deployment","operationId":"functionsCreateBuild","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createBuild","weight":300,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"buildId":{"type":"string","description":"Build unique ID.","default":"","x-example":"<BUILD_ID>"}}}}]},"patch":{"summary":"Cancel deployment","operationId":"functionsUpdateDeploymentBuild","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"Build","schema":{"$ref":"#\/definitions\/build"}}},"x-appwrite":{"method":"updateDeploymentBuild","weight":301,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/download":{"get":{"summary":"Download Deployment","operationId":"functionsDownloadDeployment","consumes":["application\/json"],"produces":["*\/*"],"tags":["functions"],"description":"Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"downloadDeployment","weight":293,"cookies":false,"type":"location","deprecated":false,"demo":"functions\/download-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/download-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","schema":{"$ref":"#\/definitions\/executionList"}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","default":"","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","default":false,"x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","default":"\/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","default":"POST","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","default":[],"x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]},"delete":{"summary":"Delete execution","operationId":"functionsDeleteExecution","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function execution by its unique ID.\n","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteExecution","weight":305,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/usage":{"get":{"summary":"Get function usage","operationId":"functionsGetFunctionUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"UsageFunction","schema":{"$ref":"#\/definitions\/usageFunction"}}},"x-appwrite":{"method":"getFunctionUsage","weight":290,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-function-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"FunctionUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/functions\/{functionId}\/variables":{"get":{"summary":"List variables","operationId":"functionsListVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all variables of a specific function.","responses":{"200":{"description":"Variables List","schema":{"$ref":"#\/definitions\/variableList"}}},"x-appwrite":{"method":"listVariables","weight":307,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"post":{"summary":"Create variable","operationId":"functionsCreateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.","responses":{"201":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"createVariable","weight":306,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key","value"]}}]}},"\/functions\/{functionId}\/variables\/{variableId}":{"get":{"summary":"Get variable","operationId":"functionsGetVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"getVariable","weight":308,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]},"put":{"summary":"Update variable","operationId":"functionsUpdateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"updateVariable","weight":309,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key"]}}]},"delete":{"summary":"Delete variable","operationId":"functionsDeleteVariable","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a variable by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":310,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/health":{"get":{"summary":"Get HTTP","operationId":"healthGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite HTTP server is up and responsive.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"get","weight":124,"cookies":false,"type":"","deprecated":false,"demo":"health\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/anti-virus":{"get":{"summary":"Get antivirus","operationId":"healthGetAntivirus","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite Antivirus server is up and connection is successful.","responses":{"200":{"description":"Health Antivirus","schema":{"$ref":"#\/definitions\/healthAntivirus"}}},"x-appwrite":{"method":"getAntivirus","weight":146,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-antivirus.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/cache":{"get":{"summary":"Get cache","operationId":"healthGetCache","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite in-memory cache servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getCache","weight":127,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-cache.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/certificate":{"get":{"summary":"Get the SSL certificate for a domain","operationId":"healthGetCertificate","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the SSL certificate for a domain","responses":{"200":{"description":"Health Certificate","schema":{"$ref":"#\/definitions\/healthCertificate"}}},"x-appwrite":{"method":"getCertificate","weight":133,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-certificate.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"domain","description":"string","required":false,"type":"string","in":"query"}]}},"\/health\/db":{"get":{"summary":"Get DB","operationId":"healthGetDB","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite database servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getDB","weight":126,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-d-b.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/pubsub":{"get":{"summary":"Get pubsub","operationId":"healthGetPubSub","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite pub-sub servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getPubSub","weight":129,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-pub-sub.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue":{"get":{"summary":"Get queue","operationId":"healthGetQueue","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite queue messaging servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getQueue","weight":128,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue\/builds":{"get":{"summary":"Get builds queue","operationId":"healthGetQueueBuilds","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of builds that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueBuilds","weight":135,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-builds.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/certificates":{"get":{"summary":"Get certificates queue","operationId":"healthGetQueueCertificates","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of certificates that are waiting to be issued against [Letsencrypt](https:\/\/letsencrypt.org\/) in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueCertificates","weight":134,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-certificates.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/databases":{"get":{"summary":"Get databases queue","operationId":"healthGetQueueDatabases","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDatabases","weight":136,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-databases.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"Queue name for which to check the queue size","required":false,"type":"string","x-example":"<NAME>","default":"database_db_main","in":"query"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/deletes":{"get":{"summary":"Get deletes queue","operationId":"healthGetQueueDeletes","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDeletes","weight":137,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-deletes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/failed\/{name}":{"get":{"summary":"Get number of failed queue jobs","operationId":"healthGetFailedJobs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Returns the amount of failed jobs in a given queue.\n","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getFailedJobs","weight":147,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-failed-jobs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"The name of the queue","required":true,"type":"string","x-example":"v1-database","enum":["v1-database","v1-deletes","v1-audits","v1-mails","v1-functions","v1-usage","v1-usage-dump","v1-webhooks","v1-certificates","v1-builds","v1-messaging","v1-migrations"],"x-enum-name":null,"x-enum-keys":[],"in":"path"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/functions":{"get":{"summary":"Get functions queue","operationId":"healthGetQueueFunctions","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueFunctions","weight":141,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-functions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/logs":{"get":{"summary":"Get logs queue","operationId":"healthGetQueueLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of logs that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueLogs","weight":132,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/mails":{"get":{"summary":"Get mails queue","operationId":"healthGetQueueMails","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of mails that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMails","weight":138,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-mails.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/messaging":{"get":{"summary":"Get messaging queue","operationId":"healthGetQueueMessaging","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of messages that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMessaging","weight":139,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-messaging.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/migrations":{"get":{"summary":"Get migrations queue","operationId":"healthGetQueueMigrations","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMigrations","weight":140,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-migrations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage":{"get":{"summary":"Get usage queue","operationId":"healthGetQueueUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsage","weight":142,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage-dump":{"get":{"summary":"Get usage dump queue","operationId":"healthGetQueueUsageDump","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsageDump","weight":143,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage-dump.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage-dump.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/webhooks":{"get":{"summary":"Get webhooks queue","operationId":"healthGetQueueWebhooks","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueWebhooks","weight":131,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/storage":{"get":{"summary":"Get storage","operationId":"healthGetStorage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorage","weight":145,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/storage\/local":{"get":{"summary":"Get local storage","operationId":"healthGetStorageLocal","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite local storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorageLocal","weight":144,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage-local.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/time":{"get":{"summary":"Get time","operationId":"healthGetTime","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https:\/\/en.wikipedia.org\/wiki\/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.","responses":{"200":{"description":"Health Time","schema":{"$ref":"#\/definitions\/healthTime"}}},"x-appwrite":{"method":"getTime","weight":130,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-time.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","schema":{"$ref":"#\/definitions\/locale"}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","schema":{"$ref":"#\/definitions\/localeCodeList"}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","schema":{"$ref":"#\/definitions\/continentList"}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","schema":{"$ref":"#\/definitions\/phoneList"}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","schema":{"$ref":"#\/definitions\/currencyList"}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","schema":{"$ref":"#\/definitions\/languageList"}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/messaging\/messages":{"get":{"summary":"List messages","operationId":"messagingListMessages","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all messages from the current Appwrite project.","responses":{"200":{"description":"Message list","schema":{"$ref":"#\/definitions\/messageList"}}},"x-appwrite":{"method":"listMessages","weight":385,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-messages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/messages\/email":{"post":{"summary":"Create email","operationId":"messagingCreateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new email message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createEmail","weight":382,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":[],"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":[],"x-example":null,"items":{"type":"string"}},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","subject","content"]}}]}},"\/messaging\/messages\/email\/{messageId}":{"patch":{"summary":"Update email","operationId":"messagingUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateEmail","weight":389,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":null,"x-example":false},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":null,"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":null,"x-example":null,"items":{"type":"string"}},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":null,"items":{"type":"string"}}}}}]}},"\/messaging\/messages\/push":{"post":{"summary":"Create push notification","operationId":"messagingCreatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new push notification.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createPush","weight":384,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":"","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":"","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web Platform.","default":"","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and IOS Platform.","default":"","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android Platform.","default":"","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android Platform.","default":"","x-example":"<TAG>"},"badge":{"type":"string","description":"Badge for push notification. Available only for IOS Platform.","default":"","x-example":"<BADGE>"},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","title","body"]}}]}},"\/messaging\/messages\/push\/{messageId}":{"patch":{"summary":"Update push notification","operationId":"messagingUpdatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a push notification by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updatePush","weight":391,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":null,"x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web platforms.","default":null,"x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and iOS platforms.","default":null,"x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android platforms.","default":null,"x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android platforms.","default":null,"x-example":"<TAG>"},"badge":{"type":"integer","description":"Badge for push notification. Available only for iOS platforms.","default":null,"x-example":null},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/sms":{"post":{"summary":"Create SMS","operationId":"messagingCreateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMS message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createSms","weight":383,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"content":{"type":"string","description":"SMS Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","content"]}}]}},"\/messaging\/messages\/sms\/{messageId}":{"patch":{"summary":"Update SMS","operationId":"messagingUpdateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateSms","weight":390,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/{messageId}":{"get":{"summary":"Get message","operationId":"messagingGetMessage","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"getMessage","weight":388,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-message.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]},"delete":{"summary":"Delete message","operationId":"messagingDelete","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":392,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]}},"\/messaging\/messages\/{messageId}\/logs":{"get":{"summary":"List message logs","operationId":"messagingListMessageLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the message activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listMessageLogs","weight":386,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-message-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/messages\/{messageId}\/targets":{"get":{"summary":"List message targets","operationId":"messagingListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of the targets associated with a message.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":387,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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, providerId, identifier, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/providers":{"get":{"summary":"List providers","operationId":"messagingListProviders","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all providers from the current Appwrite project.","responses":{"200":{"description":"Provider list","schema":{"$ref":"#\/definitions\/providerList"}}},"x-appwrite":{"method":"listProviders","weight":357,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-providers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/providers\/apns":{"post":{"summary":"Create APNS provider","operationId":"messagingCreateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Apple Push Notification service provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createApnsProvider","weight":356,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/apns\/{providerId}":{"patch":{"summary":"Update APNS provider","operationId":"messagingUpdateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Apple Push Notification service provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateApnsProvider","weight":369,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/fcm":{"post":{"summary":"Create FCM provider","operationId":"messagingCreateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Firebase Cloud Messaging provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createFcmProvider","weight":355,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/fcm\/{providerId}":{"patch":{"summary":"Update FCM provider","operationId":"messagingUpdateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Firebase Cloud Messaging provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateFcmProvider","weight":368,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"}}}}]}},"\/messaging\/providers\/mailgun":{"post":{"summary":"Create Mailgun provider","operationId":"messagingCreateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Mailgun provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMailgunProvider","weight":347,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/mailgun\/{providerId}":{"patch":{"summary":"Update Mailgun provider","operationId":"messagingUpdateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Mailgun provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMailgunProvider","weight":360,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/msg91":{"post":{"summary":"Create Msg91 provider","operationId":"messagingCreateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new MSG91 provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMsg91Provider","weight":350,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"templateId":{"type":"string","description":"Msg91 template ID","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/msg91\/{providerId}":{"patch":{"summary":"Update Msg91 provider","operationId":"messagingUpdateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a MSG91 provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMsg91Provider","weight":363,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"templateId":{"type":"string","description":"Msg91 template ID.","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"}}}}]}},"\/messaging\/providers\/sendgrid":{"post":{"summary":"Create Sendgrid provider","operationId":"messagingCreateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Sendgrid provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSendgridProvider","weight":348,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/sendgrid\/{providerId}":{"patch":{"summary":"Update Sendgrid provider","operationId":"messagingUpdateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Sendgrid provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSendgridProvider","weight":361,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/smtp":{"post":{"summary":"Create SMTP provider","operationId":"messagingCreateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMTP provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSmtpProvider","weight":349,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":null,"x-example":"<HOST>"},"port":{"type":"integer","description":"The default SMTP server port.","default":587,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be omitted, 'ssl', or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":true,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name","host"]}}]}},"\/messaging\/providers\/smtp\/{providerId}":{"patch":{"summary":"Update SMTP provider","operationId":"messagingUpdateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a SMTP provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSmtpProvider","weight":362,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":"","x-example":"<HOST>"},"port":{"type":"integer","description":"SMTP port.","default":null,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be 'ssl' or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":null,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/telesign":{"post":{"summary":"Create Telesign provider","operationId":"messagingCreateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Telesign provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTelesignProvider","weight":351,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/telesign\/{providerId}":{"patch":{"summary":"Update Telesign provider","operationId":"messagingUpdateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Telesign provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTelesignProvider","weight":364,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/textmagic":{"post":{"summary":"Create Textmagic provider","operationId":"messagingCreateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Textmagic provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTextmagicProvider","weight":352,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/textmagic\/{providerId}":{"patch":{"summary":"Update Textmagic provider","operationId":"messagingUpdateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Textmagic provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTextmagicProvider","weight":365,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/twilio":{"post":{"summary":"Create Twilio provider","operationId":"messagingCreateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Twilio provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTwilioProvider","weight":353,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/twilio\/{providerId}":{"patch":{"summary":"Update Twilio provider","operationId":"messagingUpdateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Twilio provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTwilioProvider","weight":366,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/vonage":{"post":{"summary":"Create Vonage provider","operationId":"messagingCreateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Vonage provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createVonageProvider","weight":354,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/vonage\/{providerId}":{"patch":{"summary":"Update Vonage provider","operationId":"messagingUpdateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Vonage provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateVonageProvider","weight":367,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/{providerId}":{"get":{"summary":"Get provider","operationId":"messagingGetProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a provider by its unique ID.\n","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"getProvider","weight":359,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]},"delete":{"summary":"Delete provider","operationId":"messagingDeleteProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a provider by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteProvider","weight":370,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]}},"\/messaging\/providers\/{providerId}\/logs":{"get":{"summary":"List provider logs","operationId":"messagingListProviderLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the provider activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listProviderLogs","weight":358,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-provider-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/subscribers\/{subscriberId}\/logs":{"get":{"summary":"List subscriber logs","operationId":"messagingListSubscriberLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the subscriber activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listSubscriberLogs","weight":379,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscriber-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics":{"get":{"summary":"List topics","operationId":"messagingListTopics","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all topics from the current Appwrite project.","responses":{"200":{"description":"Topic list","schema":{"$ref":"#\/definitions\/topicList"}}},"x-appwrite":{"method":"listTopics","weight":372,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topics.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, description, emailTotal, smsTotal, pushTotal","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create topic","operationId":"messagingCreateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new topic.","responses":{"201":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"createTopic","weight":371,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"topicId":{"type":"string","description":"Topic ID. Choose a custom Topic ID or a new Topic ID.","default":null,"x-example":"<TOPIC_ID>"},"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":["users"],"x-example":"[\"any\"]","items":{"type":"string"}}},"required":["topicId","name"]}}]}},"\/messaging\/topics\/{topicId}":{"get":{"summary":"Get topic","operationId":"messagingGetTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"getTopic","weight":374,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]},"patch":{"summary":"Update topic","operationId":"messagingUpdateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"updateTopic","weight":375,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":null,"x-example":"[\"any\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete topic","operationId":"messagingDeleteTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a topic by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTopic","weight":376,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]}},"\/messaging\/topics\/{topicId}\/logs":{"get":{"summary":"List topic logs","operationId":"messagingListTopicLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the topic activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listTopicLogs","weight":373,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topic-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"get":{"summary":"List subscribers","operationId":"messagingListSubscribers","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all subscribers from the current Appwrite project.","responses":{"200":{"description":"Subscriber list","schema":{"$ref":"#\/definitions\/subscriberList"}}},"x-appwrite":{"method":"listSubscribers","weight":378,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscribers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","default":null,"x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","default":null,"x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}]}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"get":{"summary":"Get subscriber","operationId":"messagingGetSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a subscriber by its unique ID.\n","responses":{"200":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"getSubscriber","weight":380,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]},"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]}},"\/migrations":{"get":{"summary":"List Migrations","operationId":"migrationsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migrations List","schema":{"$ref":"#\/definitions\/migrationList"}}},"x-appwrite":{"method":"list","weight":334,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/list-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, resources, statusCounters, resourceData, errors","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/migrations\/appwrite":{"post":{"summary":"Migrate Appwrite Data","operationId":"migrationsCreateAppwriteMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createAppwriteMigration","weight":329,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-appwrite-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"endpoint":{"type":"string","description":"Source's Appwrite Endpoint","default":null,"x-example":"https:\/\/example.com"},"projectId":{"type":"string","description":"Source's Project ID","default":null,"x-example":"<PROJECT_ID>"},"apiKey":{"type":"string","description":"Source's API Key","default":null,"x-example":"<API_KEY>"}},"required":["resources","endpoint","projectId","apiKey"]}}]}},"\/migrations\/appwrite\/report":{"get":{"summary":"Generate a report on Appwrite Data","operationId":"migrationsGetAppwriteReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getAppwriteReport","weight":336,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-appwrite-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"endpoint","description":"Source's Appwrite Endpoint","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"projectID","description":"Source's Project ID","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"query"},{"name":"key","description":"Source's API Key","required":true,"type":"string","x-example":"<KEY>","in":"query"}]}},"\/migrations\/firebase":{"post":{"summary":"Migrate Firebase Data (Service Account)","operationId":"migrationsCreateFirebaseMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createFirebaseMigration","weight":331,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-firebase-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"serviceAccount":{"type":"string","description":"JSON of the Firebase service account credentials","default":null,"x-example":"<SERVICE_ACCOUNT>"}},"required":["resources","serviceAccount"]}}]}},"\/migrations\/firebase\/deauthorize":{"get":{"summary":"Revoke Appwrite's authorization to access Firebase Projects","operationId":"migrationsDeleteFirebaseAuth","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"deleteFirebaseAuth","weight":342,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/delete-firebase-auth.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/migrations\/firebase\/oauth":{"post":{"summary":"Migrate Firebase Data (OAuth)","operationId":"migrationsCreateFirebaseOAuthMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createFirebaseOAuthMigration","weight":330,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-firebase-o-auth-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"projectId":{"type":"string","description":"Project ID of the Firebase Project","default":null,"x-example":"<PROJECT_ID>"}},"required":["resources","projectId"]}}]}},"\/migrations\/firebase\/projects":{"get":{"summary":"List Firebase Projects","operationId":"migrationsListFirebaseProjects","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migrations Firebase Projects List","schema":{"$ref":"#\/definitions\/firebaseProjectList"}}},"x-appwrite":{"method":"listFirebaseProjects","weight":341,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/list-firebase-projects.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/migrations\/firebase\/report":{"get":{"summary":"Generate a report on Firebase Data","operationId":"migrationsGetFirebaseReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getFirebaseReport","weight":337,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-firebase-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"serviceAccount","description":"JSON of the Firebase service account credentials","required":true,"type":"string","x-example":"<SERVICE_ACCOUNT>","in":"query"}]}},"\/migrations\/firebase\/report\/oauth":{"get":{"summary":"Generate a report on Firebase Data using OAuth","operationId":"migrationsGetFirebaseReportOAuth","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getFirebaseReportOAuth","weight":338,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-firebase-report-o-auth.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"projectId","description":"Project ID","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"query"}]}},"\/migrations\/nhost":{"post":{"summary":"Migrate NHost Data","operationId":"migrationsCreateNHostMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createNHostMigration","weight":333,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-n-host-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"subdomain":{"type":"string","description":"Source's Subdomain","default":null,"x-example":"<SUBDOMAIN>"},"region":{"type":"string","description":"Source's Region","default":null,"x-example":"<REGION>"},"adminSecret":{"type":"string","description":"Source's Admin Secret","default":null,"x-example":"<ADMIN_SECRET>"},"database":{"type":"string","description":"Source's Database Name","default":null,"x-example":"<DATABASE>"},"username":{"type":"string","description":"Source's Database Username","default":null,"x-example":"<USERNAME>"},"password":{"type":"string","description":"Source's Database Password","default":null,"x-example":"<PASSWORD>"},"port":{"type":"integer","description":"Source's Database Port","default":5432,"x-example":null}},"required":["resources","subdomain","region","adminSecret","database","username","password"]}}]}},"\/migrations\/nhost\/report":{"get":{"summary":"Generate a report on NHost Data","operationId":"migrationsGetNHostReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getNHostReport","weight":344,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-n-host-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate.","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"subdomain","description":"Source's Subdomain.","required":true,"type":"string","x-example":"<SUBDOMAIN>","in":"query"},{"name":"region","description":"Source's Region.","required":true,"type":"string","x-example":"<REGION>","in":"query"},{"name":"adminSecret","description":"Source's Admin Secret.","required":true,"type":"string","x-example":"<ADMIN_SECRET>","in":"query"},{"name":"database","description":"Source's Database Name.","required":true,"type":"string","x-example":"<DATABASE>","in":"query"},{"name":"username","description":"Source's Database Username.","required":true,"type":"string","x-example":"<USERNAME>","in":"query"},{"name":"password","description":"Source's Database Password.","required":true,"type":"string","x-example":"<PASSWORD>","in":"query"},{"name":"port","description":"Source's Database Port.","required":false,"type":"integer","format":"int32","default":5432,"in":"query"}]}},"\/migrations\/supabase":{"post":{"summary":"Migrate Supabase Data","operationId":"migrationsCreateSupabaseMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createSupabaseMigration","weight":332,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-supabase-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"endpoint":{"type":"string","description":"Source's Supabase Endpoint","default":null,"x-example":"https:\/\/example.com"},"apiKey":{"type":"string","description":"Source's API Key","default":null,"x-example":"<API_KEY>"},"databaseHost":{"type":"string","description":"Source's Database Host","default":null,"x-example":"<DATABASE_HOST>"},"username":{"type":"string","description":"Source's Database Username","default":null,"x-example":"<USERNAME>"},"password":{"type":"string","description":"Source's Database Password","default":null,"x-example":"<PASSWORD>"},"port":{"type":"integer","description":"Source's Database Port","default":5432,"x-example":null}},"required":["resources","endpoint","apiKey","databaseHost","username","password"]}}]}},"\/migrations\/supabase\/report":{"get":{"summary":"Generate a report on Supabase Data","operationId":"migrationsGetSupabaseReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getSupabaseReport","weight":343,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-supabase-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"endpoint","description":"Source's Supabase Endpoint.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"apiKey","description":"Source's API Key.","required":true,"type":"string","x-example":"<API_KEY>","in":"query"},{"name":"databaseHost","description":"Source's Database Host.","required":true,"type":"string","x-example":"<DATABASE_HOST>","in":"query"},{"name":"username","description":"Source's Database Username.","required":true,"type":"string","x-example":"<USERNAME>","in":"query"},{"name":"password","description":"Source's Database Password.","required":true,"type":"string","x-example":"<PASSWORD>","in":"query"},{"name":"port","description":"Source's Database Port.","required":false,"type":"integer","format":"int32","default":5432,"in":"query"}]}},"\/migrations\/{migrationId}":{"get":{"summary":"Get Migration","operationId":"migrationsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"get","weight":335,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/get-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration unique ID.","required":true,"type":"string","x-example":"<MIGRATION_ID>","in":"path"}]},"patch":{"summary":"Retry Migration","operationId":"migrationsRetry","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"retry","weight":345,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/retry.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/retry-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration unique ID.","required":true,"type":"string","x-example":"<MIGRATION_ID>","in":"path"}]},"delete":{"summary":"Delete Migration","operationId":"migrationsDelete","consumes":["application\/json"],"produces":[],"tags":["migrations"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":346,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/delete-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration ID.","required":true,"type":"string","x-example":"<MIGRATION_ID>","in":"path"}]}},"\/project\/usage":{"get":{"summary":"Get project usage stats","operationId":"projectGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"","responses":{"200":{"description":"UsageProject","schema":{"$ref":"#\/definitions\/usageProject"}}},"x-appwrite":{"method":"getUsage","weight":194,"cookies":false,"type":"","deprecated":false,"demo":"project\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"startDate","description":"Starting date for the usage","required":true,"type":"string","in":"query"},{"name":"endDate","description":"End date for the usage","required":true,"type":"string","in":"query"},{"name":"period","description":"Period used","required":false,"type":"string","x-example":"1h","enum":["1h","1d"],"x-enum-name":"ProjectUsageRange","x-enum-keys":["One Hour","One Day"],"default":"1d","in":"query"}]}},"\/project\/variables":{"get":{"summary":"List Variables","operationId":"projectListVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Get a list of all project variables. These variables will be accessible in all Appwrite Functions at runtime.","responses":{"200":{"description":"Variables List","schema":{"$ref":"#\/definitions\/variableList"}}},"x-appwrite":{"method":"listVariables","weight":196,"cookies":false,"type":"","deprecated":false,"demo":"project\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]},"post":{"summary":"Create Variable","operationId":"projectCreateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.","responses":{"201":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"createVariable","weight":195,"cookies":false,"type":"","deprecated":false,"demo":"project\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key","value"]}}]}},"\/project\/variables\/{variableId}":{"get":{"summary":"Get Variable","operationId":"projectGetVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Get a project variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"getVariable","weight":197,"cookies":false,"type":"","deprecated":false,"demo":"project\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]},"put":{"summary":"Update Variable","operationId":"projectUpdateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"updateVariable","weight":198,"cookies":false,"type":"","deprecated":false,"demo":"project\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key"]}}]},"delete":{"summary":"Delete Variable","operationId":"projectDeleteVariable","consumes":["application\/json"],"produces":[],"tags":["project"],"description":"Delete a project variable by its unique ID. ","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":199,"cookies":false,"type":"","deprecated":false,"demo":"project\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]}},"\/projects":{"get":{"summary":"List projects","operationId":"projectsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Projects List","schema":{"$ref":"#\/definitions\/projectList"}}},"x-appwrite":{"method":"list","weight":150,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"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: name, teamId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create project","operationId":"projectsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"create","weight":149,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"projectId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":null},"name":{"type":"string","description":"Project name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"teamId":{"type":"string","description":"Team unique ID.","default":null,"x-example":"<TEAM_ID>"},"region":{"type":"string","description":"Project Region.","default":"default","x-example":"default","enum":["default","fra"],"x-enum-name":null,"x-enum-keys":[]},"description":{"type":"string","description":"Project description. Max length: 256 chars.","default":"","x-example":"<DESCRIPTION>"},"logo":{"type":"string","description":"Project logo.","default":"","x-example":"<LOGO>"},"url":{"type":"string","description":"Project URL.","default":"","x-example":"https:\/\/example.com"},"legalName":{"type":"string","description":"Project legal Name. Max length: 256 chars.","default":"","x-example":"<LEGAL_NAME>"},"legalCountry":{"type":"string","description":"Project legal Country. Max length: 256 chars.","default":"","x-example":"<LEGAL_COUNTRY>"},"legalState":{"type":"string","description":"Project legal State. Max length: 256 chars.","default":"","x-example":"<LEGAL_STATE>"},"legalCity":{"type":"string","description":"Project legal City. Max length: 256 chars.","default":"","x-example":"<LEGAL_CITY>"},"legalAddress":{"type":"string","description":"Project legal Address. Max length: 256 chars.","default":"","x-example":"<LEGAL_ADDRESS>"},"legalTaxId":{"type":"string","description":"Project legal Tax ID. Max length: 256 chars.","default":"","x-example":"<LEGAL_TAX_ID>"}},"required":["projectId","name","teamId"]}}]}},"\/projects\/{projectId}":{"get":{"summary":"Get project","operationId":"projectsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"get","weight":151,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"patch":{"summary":"Update project","operationId":"projectsUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"update","weight":152,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Project name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"description":{"type":"string","description":"Project description. Max length: 256 chars.","default":"","x-example":"<DESCRIPTION>"},"logo":{"type":"string","description":"Project logo.","default":"","x-example":"<LOGO>"},"url":{"type":"string","description":"Project URL.","default":"","x-example":"https:\/\/example.com"},"legalName":{"type":"string","description":"Project legal name. Max length: 256 chars.","default":"","x-example":"<LEGAL_NAME>"},"legalCountry":{"type":"string","description":"Project legal country. Max length: 256 chars.","default":"","x-example":"<LEGAL_COUNTRY>"},"legalState":{"type":"string","description":"Project legal state. Max length: 256 chars.","default":"","x-example":"<LEGAL_STATE>"},"legalCity":{"type":"string","description":"Project legal city. Max length: 256 chars.","default":"","x-example":"<LEGAL_CITY>"},"legalAddress":{"type":"string","description":"Project legal address. Max length: 256 chars.","default":"","x-example":"<LEGAL_ADDRESS>"},"legalTaxId":{"type":"string","description":"Project legal tax ID. Max length: 256 chars.","default":"","x-example":"<LEGAL_TAX_ID>"}},"required":["name"]}}]},"delete":{"summary":"Delete project","operationId":"projectsDelete","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":168,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]}},"\/projects\/{projectId}\/api":{"patch":{"summary":"Update API status","operationId":"projectsUpdateApiStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateApiStatus","weight":156,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-api-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"api":{"type":"string","description":"API name.","default":null,"x-example":"rest","enum":["rest","graphql","realtime"],"x-enum-name":null,"x-enum-keys":[]},"status":{"type":"boolean","description":"API status.","default":null,"x-example":false}},"required":["api","status"]}}]}},"\/projects\/{projectId}\/api\/all":{"patch":{"summary":"Update all API status","operationId":"projectsUpdateApiStatusAll","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateApiStatusAll","weight":157,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-api-status-all.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"API status.","default":null,"x-example":false}},"required":["status"]}}]}},"\/projects\/{projectId}\/auth\/duration":{"patch":{"summary":"Update project authentication duration","operationId":"projectsUpdateAuthDuration","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthDuration","weight":161,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-duration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"duration":{"type":"integer","description":"Project session length in seconds. Max length: 31536000 seconds.","default":null,"x-example":0}},"required":["duration"]}}]}},"\/projects\/{projectId}\/auth\/limit":{"patch":{"summary":"Update project users limit","operationId":"projectsUpdateAuthLimit","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthLimit","weight":160,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-limit.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of users allowed in this project. Use 0 for unlimited.","default":null,"x-example":0}},"required":["limit"]}}]}},"\/projects\/{projectId}\/auth\/max-sessions":{"patch":{"summary":"Update project user sessions limit","operationId":"projectsUpdateAuthSessionsLimit","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthSessionsLimit","weight":166,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-sessions-limit.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10","default":null,"x-example":1}},"required":["limit"]}}]}},"\/projects\/{projectId}\/auth\/mock-numbers":{"patch":{"summary":"Update the mock numbers for the project","operationId":"projectsUpdateMockNumbers","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateMockNumbers","weight":167,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-mock-numbers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"numbers":{"type":"array","description":"An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.","default":null,"x-example":null,"items":{"type":"object"}}},"required":["numbers"]}}]}},"\/projects\/{projectId}\/auth\/password-dictionary":{"patch":{"summary":"Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password","operationId":"projectsUpdateAuthPasswordDictionary","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthPasswordDictionary","weight":164,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-password-dictionary.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Set whether or not to enable checking user's password against most commonly used passwords. Default is false.","default":null,"x-example":false}},"required":["enabled"]}}]}},"\/projects\/{projectId}\/auth\/password-history":{"patch":{"summary":"Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.","operationId":"projectsUpdateAuthPasswordHistory","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthPasswordHistory","weight":163,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-password-history.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0","default":null,"x-example":0}},"required":["limit"]}}]}},"\/projects\/{projectId}\/auth\/personal-data":{"patch":{"summary":"Enable or disable checking user passwords for similarity with their personal data.","operationId":"projectsUpdatePersonalDataCheck","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updatePersonalDataCheck","weight":165,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-personal-data-check.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Set whether or not to check a password for similarity with personal data. Default is false.","default":null,"x-example":false}},"required":["enabled"]}}]}},"\/projects\/{projectId}\/auth\/session-alerts":{"patch":{"summary":"Update project sessions emails","operationId":"projectsUpdateSessionAlerts","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateSessionAlerts","weight":159,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-session-alerts.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"alerts":{"type":"boolean","description":"Set to true to enable session emails.","default":null,"x-example":false}},"required":["alerts"]}}]}},"\/projects\/{projectId}\/auth\/{method}":{"patch":{"summary":"Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.","operationId":"projectsUpdateAuthStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthStatus","weight":162,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"method","description":"Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone","required":true,"type":"string","x-example":"email-password","enum":["email-password","magic-url","email-otp","anonymous","invites","jwt","phone"],"x-enum-name":"AuthMethod","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"Set the status of this auth method.","default":null,"x-example":false}},"required":["status"]}}]}},"\/projects\/{projectId}\/jwts":{"post":{"summary":"Create JWT","operationId":"projectsCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":180,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"scopes":{"type":"array","description":"List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","default":900,"x-example":0}},"required":["scopes"]}}]}},"\/projects\/{projectId}\/keys":{"get":{"summary":"List keys","operationId":"projectsListKeys","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"API Keys List","schema":{"$ref":"#\/definitions\/keyList"}}},"x-appwrite":{"method":"listKeys","weight":176,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-keys.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"post":{"summary":"Create key","operationId":"projectsCreateKey","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Key","schema":{"$ref":"#\/definitions\/key"}}},"x-appwrite":{"method":"createKey","weight":175,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Key name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"scopes":{"type":"array","description":"Key scopes list. Maximum of 100 scopes are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"expire":{"type":"string","description":"Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.","default":null,"x-example":null}},"required":["name","scopes"]}}]}},"\/projects\/{projectId}\/keys\/{keyId}":{"get":{"summary":"Get key","operationId":"projectsGetKey","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Key","schema":{"$ref":"#\/definitions\/key"}}},"x-appwrite":{"method":"getKey","weight":177,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"type":"string","x-example":"<KEY_ID>","in":"path"}]},"put":{"summary":"Update key","operationId":"projectsUpdateKey","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Key","schema":{"$ref":"#\/definitions\/key"}}},"x-appwrite":{"method":"updateKey","weight":178,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"type":"string","x-example":"<KEY_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Key name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"scopes":{"type":"array","description":"Key scopes list. Maximum of 100 events are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"expire":{"type":"string","description":"Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.","default":null,"x-example":null}},"required":["name","scopes"]}}]},"delete":{"summary":"Delete key","operationId":"projectsDeleteKey","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteKey","weight":179,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"type":"string","x-example":"<KEY_ID>","in":"path"}]}},"\/projects\/{projectId}\/oauth2":{"patch":{"summary":"Update project OAuth2","operationId":"projectsUpdateOAuth2","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateOAuth2","weight":158,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-o-auth2.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"provider":{"type":"string","description":"Provider Name","default":null,"x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"appId":{"type":"string","description":"Provider app ID. Max length: 256 chars.","default":null,"x-example":"<APP_ID>"},"secret":{"type":"string","description":"Provider secret key. Max length: 512 chars.","default":null,"x-example":"<SECRET>"},"enabled":{"type":"boolean","description":"Provider status. Set to 'false' to disable new session creation.","default":null,"x-example":false}},"required":["provider"]}}]}},"\/projects\/{projectId}\/platforms":{"get":{"summary":"List platforms","operationId":"projectsListPlatforms","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Platforms List","schema":{"$ref":"#\/definitions\/platformList"}}},"x-appwrite":{"method":"listPlatforms","weight":182,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-platforms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"post":{"summary":"Create platform","operationId":"projectsCreatePlatform","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Platform","schema":{"$ref":"#\/definitions\/platform"}}},"x-appwrite":{"method":"createPlatform","weight":181,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"type":{"type":"string","description":"Platform type.","default":null,"x-example":"web","enum":["web","flutter-web","flutter-ios","flutter-android","flutter-linux","flutter-macos","flutter-windows","apple-ios","apple-macos","apple-watchos","apple-tvos","android","unity"],"x-enum-name":"PlatformType","x-enum-keys":[]},"name":{"type":"string","description":"Platform name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"key":{"type":"string","description":"Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.","default":"","x-example":"<KEY>"},"store":{"type":"string","description":"App store or Google Play store ID. Max length: 256 chars.","default":"","x-example":"<STORE>"},"hostname":{"type":"string","description":"Platform client hostname. Max length: 256 chars.","default":"","x-example":null}},"required":["type","name"]}}]}},"\/projects\/{projectId}\/platforms\/{platformId}":{"get":{"summary":"Get platform","operationId":"projectsGetPlatform","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Platform","schema":{"$ref":"#\/definitions\/platform"}}},"x-appwrite":{"method":"getPlatform","weight":183,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"type":"string","x-example":"<PLATFORM_ID>","in":"path"}]},"put":{"summary":"Update platform","operationId":"projectsUpdatePlatform","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Platform","schema":{"$ref":"#\/definitions\/platform"}}},"x-appwrite":{"method":"updatePlatform","weight":184,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"type":"string","x-example":"<PLATFORM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Platform name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"key":{"type":"string","description":"Package name for android or bundle ID for iOS. Max length: 256 chars.","default":"","x-example":"<KEY>"},"store":{"type":"string","description":"App store or Google Play store ID. Max length: 256 chars.","default":"","x-example":"<STORE>"},"hostname":{"type":"string","description":"Platform client URL. Max length: 256 chars.","default":"","x-example":null}},"required":["name"]}}]},"delete":{"summary":"Delete platform","operationId":"projectsDeletePlatform","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deletePlatform","weight":185,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"type":"string","x-example":"<PLATFORM_ID>","in":"path"}]}},"\/projects\/{projectId}\/service":{"patch":{"summary":"Update service status","operationId":"projectsUpdateServiceStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateServiceStatus","weight":154,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-service-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"service":{"type":"string","description":"Service name.","default":null,"x-example":"account","enum":["account","avatars","databases","locale","health","storage","teams","users","functions","graphql","messaging"],"x-enum-name":"ApiService","x-enum-keys":[]},"status":{"type":"boolean","description":"Service status.","default":null,"x-example":false}},"required":["service","status"]}}]}},"\/projects\/{projectId}\/service\/all":{"patch":{"summary":"Update all service status","operationId":"projectsUpdateServiceStatusAll","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateServiceStatusAll","weight":155,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-service-status-all.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"Service status.","default":null,"x-example":false}},"required":["status"]}}]}},"\/projects\/{projectId}\/smtp":{"patch":{"summary":"Update SMTP","operationId":"projectsUpdateSmtp","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateSmtp","weight":186,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-smtp.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable custom SMTP service","default":null,"x-example":false},"senderName":{"type":"string","description":"Name of the email sender","default":"","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","default":"","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","default":"","x-example":"email@example.com"},"host":{"type":"string","description":"SMTP server host name","default":"","x-example":null},"port":{"type":"integer","description":"SMTP server port","default":587,"x-example":null},"username":{"type":"string","description":"SMTP server username","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"SMTP server password","default":"","x-example":"<PASSWORD>"},"secure":{"type":"string","description":"Does SMTP server use secure connection","default":"","x-example":"tls","enum":["tls","ssl"],"x-enum-name":"SMTPSecure","x-enum-keys":[]}},"required":["enabled"]}}]}},"\/projects\/{projectId}\/smtp\/tests":{"post":{"summary":"Create SMTP test","operationId":"projectsCreateSmtpTest","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createSmtpTest","weight":187,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-smtp-test.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"emails":{"type":"array","description":"Array of emails to send test email to. Maximum of 10 emails are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"senderName":{"type":"string","description":"Name of the email sender","default":null,"x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","default":null,"x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","default":"","x-example":"email@example.com"},"host":{"type":"string","description":"SMTP server host name","default":null,"x-example":null},"port":{"type":"integer","description":"SMTP server port","default":587,"x-example":null},"username":{"type":"string","description":"SMTP server username","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"SMTP server password","default":"","x-example":"<PASSWORD>"},"secure":{"type":"string","description":"Does SMTP server use secure connection","default":"","x-example":"tls","enum":["tls"],"x-enum-name":"SMTPSecure","x-enum-keys":[]}},"required":["emails","senderName","senderEmail","host"]}}]}},"\/projects\/{projectId}\/team":{"patch":{"summary":"Update project team","operationId":"projectsUpdateTeam","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateTeam","weight":153,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-team.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID of the team to transfer project to.","default":null,"x-example":"<TEAM_ID>"}},"required":["teamId"]}}]}},"\/projects\/{projectId}\/templates\/email\/{type}\/{locale}":{"get":{"summary":"Get custom email template","operationId":"projectsGetEmailTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"EmailTemplate","schema":{"$ref":"#\/definitions\/emailTemplate"}}},"x-appwrite":{"method":"getEmailTemplate","weight":189,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[],"in":"path"}]},"patch":{"summary":"Update custom email templates","operationId":"projectsUpdateEmailTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateEmailTemplate","weight":191,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subject":{"type":"string","description":"Email Subject","default":null,"x-example":"<SUBJECT>"},"message":{"type":"string","description":"Template message","default":null,"x-example":"<MESSAGE>"},"senderName":{"type":"string","description":"Name of the email sender","default":"","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","default":"","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","default":"","x-example":"email@example.com"}},"required":["subject","message"]}}]},"delete":{"summary":"Reset custom email template","operationId":"projectsDeleteEmailTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"EmailTemplate","schema":{"$ref":"#\/definitions\/emailTemplate"}}},"x-appwrite":{"method":"deleteEmailTemplate","weight":193,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[],"in":"path"}]}},"\/projects\/{projectId}\/templates\/sms\/{type}\/{locale}":{"get":{"summary":"Get custom SMS template","operationId":"projectsGetSmsTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","schema":{"$ref":"#\/definitions\/smsTemplate"}}},"x-appwrite":{"method":"getSmsTemplate","weight":188,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[],"in":"path"}]},"patch":{"summary":"Update custom SMS template","operationId":"projectsUpdateSmsTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","schema":{"$ref":"#\/definitions\/smsTemplate"}}},"x-appwrite":{"method":"updateSmsTemplate","weight":190,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"message":{"type":"string","description":"Template message","default":null,"x-example":"<MESSAGE>"}},"required":["message"]}}]},"delete":{"summary":"Reset custom SMS template","operationId":"projectsDeleteSmsTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","schema":{"$ref":"#\/definitions\/smsTemplate"}}},"x-appwrite":{"method":"deleteSmsTemplate","weight":192,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[],"in":"path"}]}},"\/projects\/{projectId}\/webhooks":{"get":{"summary":"List webhooks","operationId":"projectsListWebhooks","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhooks List","schema":{"$ref":"#\/definitions\/webhookList"}}},"x-appwrite":{"method":"listWebhooks","weight":170,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"post":{"summary":"Create webhook","operationId":"projectsCreateWebhook","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"createWebhook","weight":169,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Webhook name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Enable or disable a webhook.","default":true,"x-example":false},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"Webhook URL.","default":null,"x-example":null},"security":{"type":"boolean","description":"Certificate verification, false for disabled or true for enabled.","default":null,"x-example":false},"httpUser":{"type":"string","description":"Webhook HTTP user. Max length: 256 chars.","default":"","x-example":"<HTTP_USER>"},"httpPass":{"type":"string","description":"Webhook HTTP password. Max length: 256 chars.","default":"","x-example":"<HTTP_PASS>"}},"required":["name","events","url","security"]}}]}},"\/projects\/{projectId}\/webhooks\/{webhookId}":{"get":{"summary":"Get webhook","operationId":"projectsGetWebhook","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"getWebhook","weight":171,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"}]},"put":{"summary":"Update webhook","operationId":"projectsUpdateWebhook","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"updateWebhook","weight":172,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Webhook name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Enable or disable a webhook.","default":true,"x-example":false},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"Webhook URL.","default":null,"x-example":null},"security":{"type":"boolean","description":"Certificate verification, false for disabled or true for enabled.","default":null,"x-example":false},"httpUser":{"type":"string","description":"Webhook HTTP user. Max length: 256 chars.","default":"","x-example":"<HTTP_USER>"},"httpPass":{"type":"string","description":"Webhook HTTP password. Max length: 256 chars.","default":"","x-example":"<HTTP_PASS>"}},"required":["name","events","url","security"]}}]},"delete":{"summary":"Delete webhook","operationId":"projectsDeleteWebhook","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteWebhook","weight":174,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"}]}},"\/projects\/{projectId}\/webhooks\/{webhookId}\/signature":{"patch":{"summary":"Update webhook signature key","operationId":"projectsUpdateWebhookSignature","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"updateWebhookSignature","weight":173,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-webhook-signature.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"}]}},"\/proxy\/rules":{"get":{"summary":"List Rules","operationId":"proxyListRules","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"Get a list of all the proxy rules. You can use the query params to filter your results.","responses":{"200":{"description":"Rule List","schema":{"$ref":"#\/definitions\/proxyRuleList"}}},"x-appwrite":{"method":"listRules","weight":312,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/list-rules.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/list-rules.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, resourceType, resourceId, url","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create Rule","operationId":"proxyCreateRule","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"Create a new proxy rule.","responses":{"201":{"description":"Rule","schema":{"$ref":"#\/definitions\/proxyRule"}}},"x-appwrite":{"method":"createRule","weight":311,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/create-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/create-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"domain":{"type":"string","description":"Domain name.","default":null,"x-example":null},"resourceType":{"type":"string","description":"Action definition for the rule. Possible values are \"api\", \"function\"","default":null,"x-example":"api","enum":["api","function"],"x-enum-name":null,"x-enum-keys":[]},"resourceId":{"type":"string","description":"ID of resource for the action type. If resourceType is \"api\", leave empty. If resourceType is \"function\", provide ID of the function.","default":"","x-example":"<RESOURCE_ID>"}},"required":["domain","resourceType"]}}]}},"\/proxy\/rules\/{ruleId}":{"get":{"summary":"Get Rule","operationId":"proxyGetRule","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"Get a proxy rule by its unique ID.","responses":{"200":{"description":"Rule","schema":{"$ref":"#\/definitions\/proxyRule"}}},"x-appwrite":{"method":"getRule","weight":313,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/get-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/get-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"type":"string","x-example":"<RULE_ID>","in":"path"}]},"delete":{"summary":"Delete Rule","operationId":"proxyDeleteRule","consumes":["application\/json"],"produces":[],"tags":["proxy"],"description":"Delete a proxy rule by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteRule","weight":314,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/delete-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/delete-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"type":"string","x-example":"<RULE_ID>","in":"path"}]}},"\/proxy\/rules\/{ruleId}\/verification":{"patch":{"summary":"Update Rule Verification Status","operationId":"proxyUpdateRuleVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"","responses":{"200":{"description":"Rule","schema":{"$ref":"#\/definitions\/proxyRule"}}},"x-appwrite":{"method":"updateRuleVerification","weight":315,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/update-rule-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"type":"string","x-example":"<RULE_ID>","in":"path"}]}},"\/storage\/buckets":{"get":{"summary":"List buckets","operationId":"storageListBuckets","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the storage buckets. You can use the query params to filter your results.","responses":{"200":{"description":"Buckets List","schema":{"$ref":"#\/definitions\/bucketList"}}},"x-appwrite":{"method":"listBuckets","weight":201,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-buckets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create bucket","operationId":"storageCreateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new storage bucket.","responses":{"201":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"createBucket","weight":200,"cookies":false,"type":"","deprecated":false,"demo":"storage\/create-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"bucketId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<BUCKET_ID>"},"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["bucketId","name"]}}]}},"\/storage\/buckets\/{bucketId}":{"get":{"summary":"Get bucket","operationId":"storageGetBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"getBucket","weight":202,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]},"put":{"summary":"Update bucket","operationId":"storageUpdateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a storage bucket by its unique ID.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"updateBucket","weight":203,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete bucket","operationId":"storageDeleteBucket","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a storage bucket by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteBucket","weight":204,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","schema":{"$ref":"#\/definitions\/fileList"}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"x-upload-id":true,"type":"string","x-example":"<FILE_ID>","in":"formData"},{"name":"file","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","required":true,"type":"file","in":"formData"},{"name":"permissions","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"x-example":"[\"read(\"any\")\"]","in":"formData"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","consumes":["application\/json"],"produces":["image\/*"],"tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center","in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"type":"number","format":"float","x-example":0,"default":1,"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"type":"integer","format":"int32","x-example":-360,"default":0,"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":"","in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/usage":{"get":{"summary":"Get storage usage stats","operationId":"storageGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"","responses":{"200":{"description":"StorageUsage","schema":{"$ref":"#\/definitions\/usageStorage"}}},"x-appwrite":{"method":"getUsage","weight":214,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"StorageUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/storage\/{bucketId}\/usage":{"get":{"summary":"Get bucket usage stats","operationId":"storageGetBucketUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"","responses":{"200":{"description":"UsageBuckets","schema":{"$ref":"#\/definitions\/usageBuckets"}}},"x-appwrite":{"method":"getBucketUsage","weight":215,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"bucketId","description":"Bucket ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"StorageUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","schema":{"$ref":"#\/definitions\/teamList"}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":["owner"],"x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}]}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]},"delete":{"summary":"Delete team","operationId":"teamsDelete","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]}},"\/teams\/{teamId}\/logs":{"get":{"summary":"List team logs","operationId":"teamsListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":229,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","default":"","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","default":"","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","default":"","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["roles"]}}]}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["roles"]}}]},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users":{"get":{"summary":"List users","operationId":"usersList","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a list of all the project's users. You can use the query params to filter your results.","responses":{"200":{"description":"Users List","schema":{"$ref":"#\/definitions\/userList"}}},"x-appwrite":{"method":"list","weight":239,"cookies":false,"type":"","deprecated":false,"demo":"users\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create user","operationId":"usersCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":230,"cookies":false,"type":"","deprecated":false,"demo":"users\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"Plain text user password. Must be at least 8 chars.","default":"","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId"]}}]}},"\/users\/argon2":{"post":{"summary":"Create user with Argon2 password","operationId":"usersCreateArgon2User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createArgon2User","weight":233,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-argon2user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Argon2.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/bcrypt":{"post":{"summary":"Create user with bcrypt password","operationId":"usersCreateBcryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createBcryptUser","weight":231,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-bcrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Bcrypt.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/identities":{"get":{"summary":"List Identities","operationId":"usersListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get identities for all users.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":247,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/users\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"usersDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":270,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/users\/md5":{"post":{"summary":"Create user with MD5 password","operationId":"usersCreateMD5User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createMD5User","weight":232,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-m-d5user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using MD5.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/phpass":{"post":{"summary":"Create user with PHPass password","operationId":"usersCreatePHPassUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createPHPassUser","weight":235,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-p-h-pass-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using PHPass.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/scrypt":{"post":{"summary":"Create user with Scrypt password","operationId":"usersCreateScryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptUser","weight":236,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Optional salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordCpu":{"type":"integer","description":"Optional CPU cost used to hash password.","default":null,"x-example":null},"passwordMemory":{"type":"integer","description":"Optional memory cost used to hash password.","default":null,"x-example":null},"passwordParallel":{"type":"integer","description":"Optional parallelization cost used to hash password.","default":null,"x-example":null},"passwordLength":{"type":"integer","description":"Optional hash length used to hash password.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordCpu","passwordMemory","passwordParallel","passwordLength"]}}]}},"\/users\/scrypt-modified":{"post":{"summary":"Create user with Scrypt modified password","operationId":"usersCreateScryptModifiedUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptModifiedUser","weight":237,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-modified-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt Modified.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordSaltSeparator":{"type":"string","description":"Salt separator used to hash password.","default":null,"x-example":"<PASSWORD_SALT_SEPARATOR>"},"passwordSignerKey":{"type":"string","description":"Signer key used to hash password.","default":null,"x-example":"<PASSWORD_SIGNER_KEY>"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordSaltSeparator","passwordSignerKey"]}}]}},"\/users\/sha":{"post":{"summary":"Create user with SHA password","operationId":"usersCreateSHAUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createSHAUser","weight":234,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-s-h-a-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using SHA.","default":null,"x-example":"password"},"passwordVersion":{"type":"string","description":"Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'","default":"","x-example":"sha1","enum":["sha1","sha224","sha256","sha384","sha512\/224","sha512\/256","sha512","sha3-224","sha3-256","sha3-384","sha3-512"],"x-enum-name":"PasswordHash","x-enum-keys":[]},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/usage":{"get":{"summary":"Get users usage stats","operationId":"usersGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"","responses":{"200":{"description":"UsageUsers","schema":{"$ref":"#\/definitions\/usageUsers"}}},"x-appwrite":{"method":"getUsage","weight":272,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"UserUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/users\/{userId}":{"get":{"summary":"Get user","operationId":"usersGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":240,"cookies":false,"type":"","deprecated":false,"demo":"users\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user","operationId":"usersDelete","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":268,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/email":{"patch":{"summary":"Update email","operationId":"usersUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":253,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"}},"required":["email"]}}]}},"\/users\/{userId}\/jwts":{"post":{"summary":"Create user JWT","operationId":"usersCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":271,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.","default":"recent","x-example":"<SESSION_ID>"},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","default":900,"x-example":0}}}}]}},"\/users\/{userId}\/labels":{"put":{"summary":"Update user labels","operationId":"usersUpdateLabels","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateLabels","weight":249,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-labels.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"labels":{"type":"array","description":"Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["labels"]}}]}},"\/users\/{userId}\/logs":{"get":{"summary":"List user logs","operationId":"usersListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":245,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/users\/{userId}\/memberships":{"get":{"summary":"List user memberships","operationId":"usersListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user membership list by its unique ID.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":244,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa":{"patch":{"summary":"Update MFA","operationId":"usersUpdateMfa","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Enable or disable MFA on a user account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfa","weight":258,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/users\/{userId}\/mfa\/authenticators\/{type}":{"delete":{"summary":"Delete Authenticator","operationId":"usersDeleteMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete an authenticator app.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":263,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/users\/{userId}\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"usersListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":259,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"usersGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":260,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"put":{"summary":"Regenerate MFA Recovery Codes","operationId":"usersUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":262,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Create MFA Recovery Codes","operationId":"usersCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":261,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/name":{"patch":{"summary":"Update name","operationId":"usersUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user name by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":251,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/users\/{userId}\/password":{"patch":{"summary":"Update password","operationId":"usersUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user password by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":252,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null}},"required":["password"]}}]}},"\/users\/{userId}\/phone":{"patch":{"summary":"Update phone","operationId":"usersUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":254,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"number":{"type":"string","description":"User phone number.","default":null,"x-example":"+12065550100"}},"required":["number"]}}]}},"\/users\/{userId}\/prefs":{"get":{"summary":"Get user preferences","operationId":"usersGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user preferences by its unique ID.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":241,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Update user preferences","operationId":"usersUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user preferences by its unique ID. 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.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":256,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users\/{userId}\/sessions":{"get":{"summary":"List user sessions","operationId":"usersListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user sessions list by its unique ID.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":243,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"post":{"summary":"Create session","operationId":"usersCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":264,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user sessions","operationId":"usersDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete all user's sessions by using the user's unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":267,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/sessions\/{sessionId}":{"delete":{"summary":"Delete user session","operationId":"usersDeleteSession","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user sessions by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":266,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"sessionId","description":"Session ID.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/users\/{userId}\/status":{"patch":{"summary":"Update user status","operationId":"usersUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":248,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"User Status. To activate the user pass `true` and to block the user pass `false`.","default":null,"x-example":false}},"required":["status"]}}]}},"\/users\/{userId}\/targets":{"get":{"summary":"List User Targets","operationId":"usersListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the messaging targets that are associated with a user.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":246,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create User Target","operationId":"usersCreateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a messaging target.","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createTarget","weight":238,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","default":null,"x-example":"email","enum":["email","sms","push"],"x-enum-name":"MessagingProviderType","x-enum-keys":[]},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}},"required":["targetId","providerType","identifier"]}}]}},"\/users\/{userId}\/targets\/{targetId}":{"get":{"summary":"Get User Target","operationId":"usersGetTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user's push notification target by ID.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"getTarget","weight":242,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]},"patch":{"summary":"Update User target","operationId":"usersUpdateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update a messaging target.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updateTarget","weight":257,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":"","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}}}}]},"delete":{"summary":"Delete user target","operationId":"usersDeleteTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete a messaging target.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTarget","weight":269,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/users\/{userId}\/tokens":{"post":{"summary":"Create token","operationId":"usersCreateToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createToken","weight":265,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"length":{"type":"integer","description":"Token length in characters. The default length is 6 characters","default":6,"x-example":4},"expire":{"type":"integer","description":"Token expiration period in seconds. The default expiration is 15 minutes.","default":900,"x-example":60}}}}]}},"\/users\/{userId}\/verification":{"patch":{"summary":"Update email verification","operationId":"usersUpdateEmailVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmailVerification","weight":255,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"emailVerification":{"type":"boolean","description":"User email verification status.","default":null,"x-example":false}},"required":["emailVerification"]}}]}},"\/users\/{userId}\/verification\/phone":{"patch":{"summary":"Update phone verification","operationId":"usersUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":250,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"phoneVerification":{"type":"boolean","description":"User phone verification status.","default":null,"x-example":false}},"required":["phoneVerification"]}}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories":{"get":{"summary":"List Repositories","operationId":"vcsListRepositories","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Provider Repositories List","schema":{"$ref":"#\/definitions\/providerRepositoryList"}}},"x-appwrite":{"method":"listRepositories","weight":277,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-repositories.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create repository","operationId":"vcsCreateRepository","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"ProviderRepository","schema":{"$ref":"#\/definitions\/providerRepository"}}},"x-appwrite":{"method":"createRepository","weight":278,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/create-repository.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Repository name (slug)","default":null,"x-example":"<NAME>"},"private":{"type":"boolean","description":"Mark repository public or private","default":null,"x-example":false}},"required":["name","private"]}}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}":{"get":{"summary":"Get repository","operationId":"vcsGetRepository","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"ProviderRepository","schema":{"$ref":"#\/definitions\/providerRepository"}}},"x-appwrite":{"method":"getRepository","weight":279,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-repository.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/branches":{"get":{"summary":"List Repository Branches","operationId":"vcsListRepositoryBranches","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Branches List","schema":{"$ref":"#\/definitions\/branchList"}}},"x-appwrite":{"method":"listRepositoryBranches","weight":280,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-repository-branches.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/contents":{"get":{"summary":"Get files and directories of a VCS repository","operationId":"vcsGetRepositoryContents","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"VCS Content List","schema":{"$ref":"#\/definitions\/vcsContentList"}}},"x-appwrite":{"method":"getRepositoryContents","weight":275,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-repository-contents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"},{"name":"providerRootDirectory","description":"Path to get contents of nested directory","required":false,"type":"string","x-example":"<PROVIDER_ROOT_DIRECTORY>","default":"","in":"query"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/detection":{"post":{"summary":"Detect runtime settings from source code","operationId":"vcsCreateRepositoryDetection","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Detection","schema":{"$ref":"#\/definitions\/detection"}}},"x-appwrite":{"method":"createRepositoryDetection","weight":276,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/create-repository-detection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerRootDirectory":{"type":"string","description":"Path to Root Directory","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"}}}}]}},"\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}":{"patch":{"summary":"Authorize external deployment","operationId":"vcsUpdateExternalDeployments","consumes":["application\/json"],"produces":[],"tags":["vcs"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateExternalDeployments","weight":285,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/update-external-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"repositoryId","description":"VCS Repository Id","required":true,"type":"string","x-example":"<REPOSITORY_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerPullRequestId":{"type":"string","description":"GitHub Pull Request Id","default":null,"x-example":"<PROVIDER_PULL_REQUEST_ID>"}},"required":["providerPullRequestId"]}}]}},"\/vcs\/installations":{"get":{"summary":"List installations","operationId":"vcsListInstallations","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Installations List","schema":{"$ref":"#\/definitions\/installationList"}}},"x-appwrite":{"method":"listInstallations","weight":282,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-installations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-installations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"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: provider, organization","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/vcs\/installations\/{installationId}":{"get":{"summary":"Get installation","operationId":"vcsGetInstallation","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Installation","schema":{"$ref":"#\/definitions\/installation"}}},"x-appwrite":{"method":"getInstallation","weight":283,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-installation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-installation.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"}]},"delete":{"summary":"Delete Installation","operationId":"vcsDeleteInstallation","consumes":["application\/json"],"produces":[],"tags":["vcs"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteInstallation","weight":284,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/delete-installation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/delete-installation.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"}]}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"definitions":{"any":{"description":"Any","type":"object","additionalProperties":true},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"type":"object","$ref":"#\/definitions\/document"},"x-example":""}},"required":["total","documents"]},"collectionList":{"description":"Collections List","type":"object","properties":{"total":{"type":"integer","description":"Total number of collections documents that matched your query.","x-example":5,"format":"int32"},"collections":{"type":"array","description":"List of collections.","items":{"type":"object","$ref":"#\/definitions\/collection"},"x-example":""}},"required":["total","collections"]},"databaseList":{"description":"Databases List","type":"object","properties":{"total":{"type":"integer","description":"Total number of databases documents that matched your query.","x-example":5,"format":"int32"},"databases":{"type":"array","description":"List of databases.","items":{"type":"object","$ref":"#\/definitions\/database"},"x-example":""}},"required":["total","databases"]},"indexList":{"description":"Indexes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of indexes documents that matched your query.","x-example":5,"format":"int32"},"indexes":{"type":"array","description":"List of indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":""}},"required":["total","indexes"]},"userList":{"description":"Users List","type":"object","properties":{"total":{"type":"integer","description":"Total number of users documents that matched your query.","x-example":5,"format":"int32"},"users":{"type":"array","description":"List of users.","items":{"type":"object","$ref":"#\/definitions\/user"},"x-example":""}},"required":["total","users"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"type":"object","$ref":"#\/definitions\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"type":"object","$ref":"#\/definitions\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"type":"object","$ref":"#\/definitions\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"type":"object","$ref":"#\/definitions\/file"},"x-example":""}},"required":["total","files"]},"bucketList":{"description":"Buckets List","type":"object","properties":{"total":{"type":"integer","description":"Total number of buckets documents that matched your query.","x-example":5,"format":"int32"},"buckets":{"type":"array","description":"List of buckets.","items":{"type":"object","$ref":"#\/definitions\/bucket"},"x-example":""}},"required":["total","buckets"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"type":"object","$ref":"#\/definitions\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"type":"object","$ref":"#\/definitions\/membership"},"x-example":""}},"required":["total","memberships"]},"functionList":{"description":"Functions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of functions documents that matched your query.","x-example":5,"format":"int32"},"functions":{"type":"array","description":"List of functions.","items":{"type":"object","$ref":"#\/definitions\/function"},"x-example":""}},"required":["total","functions"]},"installationList":{"description":"Installations List","type":"object","properties":{"total":{"type":"integer","description":"Total number of installations documents that matched your query.","x-example":5,"format":"int32"},"installations":{"type":"array","description":"List of installations.","items":{"type":"object","$ref":"#\/definitions\/installation"},"x-example":""}},"required":["total","installations"]},"providerRepositoryList":{"description":"Provider Repositories List","type":"object","properties":{"total":{"type":"integer","description":"Total number of providerRepositories documents that matched your query.","x-example":5,"format":"int32"},"providerRepositories":{"type":"array","description":"List of providerRepositories.","items":{"type":"object","$ref":"#\/definitions\/providerRepository"},"x-example":""}},"required":["total","providerRepositories"]},"branchList":{"description":"Branches List","type":"object","properties":{"total":{"type":"integer","description":"Total number of branches documents that matched your query.","x-example":5,"format":"int32"},"branches":{"type":"array","description":"List of branches.","items":{"type":"object","$ref":"#\/definitions\/branch"},"x-example":""}},"required":["total","branches"]},"runtimeList":{"description":"Runtimes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of runtimes documents that matched your query.","x-example":5,"format":"int32"},"runtimes":{"type":"array","description":"List of runtimes.","items":{"type":"object","$ref":"#\/definitions\/runtime"},"x-example":""}},"required":["total","runtimes"]},"deploymentList":{"description":"Deployments List","type":"object","properties":{"total":{"type":"integer","description":"Total number of deployments documents that matched your query.","x-example":5,"format":"int32"},"deployments":{"type":"array","description":"List of deployments.","items":{"type":"object","$ref":"#\/definitions\/deployment"},"x-example":""}},"required":["total","deployments"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"type":"object","$ref":"#\/definitions\/execution"},"x-example":""}},"required":["total","executions"]},"projectList":{"description":"Projects List","type":"object","properties":{"total":{"type":"integer","description":"Total number of projects documents that matched your query.","x-example":5,"format":"int32"},"projects":{"type":"array","description":"List of projects.","items":{"type":"object","$ref":"#\/definitions\/project"},"x-example":""}},"required":["total","projects"]},"webhookList":{"description":"Webhooks List","type":"object","properties":{"total":{"type":"integer","description":"Total number of webhooks documents that matched your query.","x-example":5,"format":"int32"},"webhooks":{"type":"array","description":"List of webhooks.","items":{"type":"object","$ref":"#\/definitions\/webhook"},"x-example":""}},"required":["total","webhooks"]},"keyList":{"description":"API Keys List","type":"object","properties":{"total":{"type":"integer","description":"Total number of keys documents that matched your query.","x-example":5,"format":"int32"},"keys":{"type":"array","description":"List of keys.","items":{"type":"object","$ref":"#\/definitions\/key"},"x-example":""}},"required":["total","keys"]},"platformList":{"description":"Platforms List","type":"object","properties":{"total":{"type":"integer","description":"Total number of platforms documents that matched your query.","x-example":5,"format":"int32"},"platforms":{"type":"array","description":"List of platforms.","items":{"type":"object","$ref":"#\/definitions\/platform"},"x-example":""}},"required":["total","platforms"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"type":"object","$ref":"#\/definitions\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"type":"object","$ref":"#\/definitions\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"type":"object","$ref":"#\/definitions\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"type":"object","$ref":"#\/definitions\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"type":"object","$ref":"#\/definitions\/phone"},"x-example":""}},"required":["total","phones"]},"variableList":{"description":"Variables List","type":"object","properties":{"total":{"type":"integer","description":"Total number of variables documents that matched your query.","x-example":5,"format":"int32"},"variables":{"type":"array","description":"List of variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":""}},"required":["total","variables"]},"proxyRuleList":{"description":"Rule List","type":"object","properties":{"total":{"type":"integer","description":"Total number of rules documents that matched your query.","x-example":5,"format":"int32"},"rules":{"type":"array","description":"List of rules.","items":{"type":"object","$ref":"#\/definitions\/proxyRule"},"x-example":""}},"required":["total","rules"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"type":"object","$ref":"#\/definitions\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"providerList":{"description":"Provider list","type":"object","properties":{"total":{"type":"integer","description":"Total number of providers documents that matched your query.","x-example":5,"format":"int32"},"providers":{"type":"array","description":"List of providers.","items":{"type":"object","$ref":"#\/definitions\/provider"},"x-example":""}},"required":["total","providers"]},"messageList":{"description":"Message list","type":"object","properties":{"total":{"type":"integer","description":"Total number of messages documents that matched your query.","x-example":5,"format":"int32"},"messages":{"type":"array","description":"List of messages.","items":{"type":"object","$ref":"#\/definitions\/message"},"x-example":""}},"required":["total","messages"]},"topicList":{"description":"Topic list","type":"object","properties":{"total":{"type":"integer","description":"Total number of topics documents that matched your query.","x-example":5,"format":"int32"},"topics":{"type":"array","description":"List of topics.","items":{"type":"object","$ref":"#\/definitions\/topic"},"x-example":""}},"required":["total","topics"]},"subscriberList":{"description":"Subscriber list","type":"object","properties":{"total":{"type":"integer","description":"Total number of subscribers documents that matched your query.","x-example":5,"format":"int32"},"subscribers":{"type":"array","description":"List of subscribers.","items":{"type":"object","$ref":"#\/definitions\/subscriber"},"x-example":""}},"required":["total","subscribers"]},"targetList":{"description":"Target list","type":"object","properties":{"total":{"type":"integer","description":"Total number of targets documents that matched your query.","x-example":5,"format":"int32"},"targets":{"type":"array","description":"List of targets.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":""}},"required":["total","targets"]},"migrationList":{"description":"Migrations List","type":"object","properties":{"total":{"type":"integer","description":"Total number of migrations documents that matched your query.","x-example":5,"format":"int32"},"migrations":{"type":"array","description":"List of migrations.","items":{"type":"object","$ref":"#\/definitions\/migration"},"x-example":""}},"required":["total","migrations"]},"firebaseProjectList":{"description":"Migrations Firebase Projects List","type":"object","properties":{"total":{"type":"integer","description":"Total number of projects documents that matched your query.","x-example":5,"format":"int32"},"projects":{"type":"array","description":"List of projects.","items":{"type":"object","$ref":"#\/definitions\/firebaseProject"},"x-example":""}},"required":["total","projects"]},"vcsContentList":{"description":"VCS Content List","type":"object","properties":{"total":{"type":"integer","description":"Total number of contents documents that matched your query.","x-example":5,"format":"int32"},"contents":{"type":"array","description":"List of contents.","items":{"type":"object","$ref":"#\/definitions\/vcsContent"},"x-example":""}},"required":["total","contents"]},"database":{"description":"Database","type":"object","properties":{"$id":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Database name.","x-example":"My Database"},"$createdAt":{"type":"string","description":"Database creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Database update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"enabled":{"type":"boolean","description":"If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false}},"required":["$id","name","$createdAt","$updatedAt","enabled"]},"collection":{"description":"Collection","type":"object","properties":{"$id":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Collection creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Collection update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Collection name.","x-example":"My Collection"},"enabled":{"type":"boolean","description":"Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false},"documentSecurity":{"type":"boolean","description":"Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"attributes":{"type":"array","description":"Collection attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":{}},"indexes":{"type":"array","description":"Collection indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":{}}},"required":["$id","$createdAt","$updatedAt","$permissions","databaseId","name","enabled","documentSecurity","attributes","indexes"]},"attributeList":{"description":"Attributes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of attributes in the given collection.","x-example":5,"format":"int32"},"attributes":{"type":"array","description":"List of attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":""}},"required":["total","attributes"]},"attributeString":{"description":"AttributeString","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"size":{"type":"integer","description":"Attribute size.","x-example":128,"format":"int32"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default","x-nullable":true}},"required":["key","type","status","error","required","size"]},"attributeInteger":{"description":"AttributeInteger","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"count"},"type":{"type":"string","description":"Attribute type.","x-example":"integer"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"integer","description":"Minimum value to enforce for new documents.","x-example":1,"format":"int32","x-nullable":true},"max":{"type":"integer","description":"Maximum value to enforce for new documents.","x-example":10,"format":"int32","x-nullable":true},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":10,"format":"int32","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeFloat":{"description":"AttributeFloat","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"percentageCompleted"},"type":{"type":"string","description":"Attribute type.","x-example":"double"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"number","description":"Minimum value to enforce for new documents.","x-example":1.5,"format":"double","x-nullable":true},"max":{"type":"number","description":"Maximum value to enforce for new documents.","x-example":10.5,"format":"double","x-nullable":true},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":2.5,"format":"double","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeBoolean":{"description":"AttributeBoolean","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"isEnabled"},"type":{"type":"string","description":"Attribute type.","x-example":"boolean"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"x-nullable":true}},"required":["key","type","status","error","required"]},"attributeEmail":{"description":"AttributeEmail","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"userEmail"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"email"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default@example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeEnum":{"description":"AttributeEnum","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"status"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"elements":{"type":"array","description":"Array of elements in enumerated type.","items":{"type":"string"},"x-example":"element"},"format":{"type":"string","description":"String format.","x-example":"enum"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"element","x-nullable":true}},"required":["key","type","status","error","required","elements","format"]},"attributeIp":{"description":"AttributeIP","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"ipAddress"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"ip"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"192.0.2.0","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeUrl":{"description":"AttributeURL","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"githubUrl"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"url"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"http:\/\/example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeDatetime":{"description":"AttributeDatetime","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"birthDay"},"type":{"type":"string","description":"Attribute type.","x-example":"datetime"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"ISO 8601 format.","x-example":"datetime"},"default":{"type":"string","description":"Default value for attribute when not provided. Only null is optional","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeRelationship":{"description":"AttributeRelationship","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"relatedCollection":{"type":"string","description":"The ID of the related collection.","x-example":"collection"},"relationType":{"type":"string","description":"The type of the relationship.","x-example":"oneToOne|oneToMany|manyToOne|manyToMany"},"twoWay":{"type":"boolean","description":"Is the relationship two-way?","x-example":false},"twoWayKey":{"type":"string","description":"The key of the two-way relationship.","x-example":"string"},"onDelete":{"type":"string","description":"How deleting the parent document will propagate to child documents.","x-example":"restrict|cascade|setNull"},"side":{"type":"string","description":"Whether this is the parent or child side of the relationship","x-example":"parent|child"}},"required":["key","type","status","error","required","relatedCollection","relationType","twoWay","twoWayKey","onDelete","side"]},"index":{"description":"Index","type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":"index1"},"type":{"type":"string","description":"Index type.","x-example":"primary"},"status":{"type":"string","description":"Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an index.","x-example":"string"},"attributes":{"type":"array","description":"Index attributes.","items":{"type":"string"},"x-example":[]},"orders":{"type":"array","description":"Index orders.","items":{"type":"string"},"x-example":[],"x-nullable":true}},"required":["key","type","status","error","attributes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","x-nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","x-nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"x-oneOf":[{"$ref":"#\/definitions\/algoArgon2"},{"$ref":"#\/definitions\/algoScrypt"},{"$ref":"#\/definitions\/algoScryptModified"},{"$ref":"#\/definitions\/algoBcrypt"},{"$ref":"#\/definitions\/algoPhpass"},{"$ref":"#\/definitions\/algoSha"},{"$ref":"#\/definitions\/algoMd5"}]},"x-nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"bucket":{"description":"Bucket","type":"object","properties":{"$id":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Bucket creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Bucket update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"fileSecurity":{"type":"boolean","description":"Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"name":{"type":"string","description":"Bucket name.","x-example":"Documents"},"enabled":{"type":"boolean","description":"Bucket enabled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size supported.","x-example":100,"format":"int32"},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions.","items":{"type":"string"},"x-example":["jpg","png"]},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).","x-example":"gzip"},"encryption":{"type":"boolean","description":"Bucket is encrypted.","x-example":false},"antivirus":{"type":"boolean","description":"Virus scanning is enabled.","x-example":false}},"required":["$id","$createdAt","$updatedAt","$permissions","fileSecurity","name","enabled","maximumFileSize","allowedFileExtensions","compression","encryption","antivirus"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"function":{"description":"Function","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"execute":{"type":"array","description":"Execution permissions.","items":{"type":"string"},"x-example":"users"},"name":{"type":"string","description":"Function name.","x-example":"My Function"},"enabled":{"type":"boolean","description":"Function enabled.","x-example":false},"live":{"type":"boolean","description":"Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"runtime":{"type":"string","description":"Function execution runtime.","x-example":"python-3.8"},"deployment":{"type":"string","description":"Function's active deployment ID.","x-example":"5e5ea5c16897e"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"vars":{"type":"array","description":"Function variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":[]},"events":{"type":"array","description":"Function trigger events.","items":{"type":"string"},"x-example":"account.create"},"schedule":{"type":"string","description":"Function execution schedult in CRON format.","x-example":"5 4 * * *"},"timeout":{"type":"integer","description":"Function execution timeout in seconds.","x-example":300,"format":"int32"},"entrypoint":{"type":"string","description":"The entrypoint file used to execute the deployment.","x-example":"index.js"},"commands":{"type":"string","description":"The build command used to build the deployment.","x-example":"npm install"},"version":{"type":"string","description":"Version of Open Runtimes used for the function.","x-example":"v2"},"installationId":{"type":"string","description":"Function VCS (Version Control System) installation id.","x-example":"6m40at4ejk5h2u9s1hboo"},"providerRepositoryId":{"type":"string","description":"VCS (Version Control System) Repository ID","x-example":"appwrite"},"providerBranch":{"type":"string","description":"VCS (Version Control System) branch name","x-example":"main"},"providerRootDirectory":{"type":"string","description":"Path to function in VCS (Version Control System) repository","x-example":"functions\/helloWorld"},"providerSilentMode":{"type":"boolean","description":"Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests","x-example":false}},"required":["$id","$createdAt","$updatedAt","execute","name","enabled","live","logging","runtime","deployment","scopes","vars","events","schedule","timeout","entrypoint","commands","version","installationId","providerRepositoryId","providerBranch","providerRootDirectory","providerSilentMode"]},"installation":{"description":"Installation","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"VCS (Version Control System) provider name.","x-example":"github"},"organization":{"type":"string","description":"VCS (Version Control System) organization name.","x-example":"appwrite"},"providerInstallationId":{"type":"string","description":"VCS (Version Control System) installation ID.","x-example":"5322"}},"required":["$id","$createdAt","$updatedAt","provider","organization","providerInstallationId"]},"providerRepository":{"description":"ProviderRepository","type":"object","properties":{"id":{"type":"string","description":"VCS (Version Control System) repository ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"VCS (Version Control System) repository name.","x-example":"appwrite"},"organization":{"type":"string","description":"VCS (Version Control System) organization name","x-example":"appwrite"},"provider":{"type":"string","description":"VCS (Version Control System) provider name.","x-example":"github"},"private":{"type":"boolean","description":"Is VCS (Version Control System) repository private?","x-example":true},"runtime":{"type":"string","description":"Auto-detected runtime suggestion. Empty if getting response of getRuntime().","x-example":"node"},"pushedAt":{"type":"string","description":"Last commit date in ISO 8601 format.","x-example":"datetime"}},"required":["id","name","organization","provider","private","runtime","pushedAt"]},"detection":{"description":"Detection","type":"object","properties":{"runtime":{"type":"string","description":"Runtime","x-example":"node"}},"required":["runtime"]},"vcsContent":{"description":"VcsContents","type":"object","properties":{"size":{"type":"integer","description":"Content size in bytes. Only files have size, and for directories, 0 is returned.","x-example":1523,"format":"int32","x-nullable":true},"isDirectory":{"type":"boolean","description":"If a content is a directory. Directories can be used to check nested contents.","x-example":true,"x-nullable":true},"name":{"type":"string","description":"Name of directory or file.","x-example":"Main.java"}},"required":["name"]},"branch":{"description":"Branch","type":"object","properties":{"name":{"type":"string","description":"Branch Name.","x-example":"main"}},"required":["name"]},"runtime":{"description":"Runtime","type":"object","properties":{"$id":{"type":"string","description":"Runtime ID.","x-example":"python-3.8"},"name":{"type":"string","description":"Runtime Name.","x-example":"Python"},"version":{"type":"string","description":"Runtime version.","x-example":"3.8"},"base":{"type":"string","description":"Base Docker image used to build the runtime.","x-example":"python:3.8-alpine"},"image":{"type":"string","description":"Image name of Docker Hub.","x-example":"appwrite\\\/runtime-for-python:3.8"},"logo":{"type":"string","description":"Name of the logo image.","x-example":"python.png"},"supports":{"type":"array","description":"List of supported architectures.","items":{"type":"string"},"x-example":"amd64"}},"required":["$id","name","version","base","image","logo","supports"]},"deployment":{"description":"Deployment","type":"object","properties":{"$id":{"type":"string","description":"Deployment ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Deployment update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"type":{"type":"string","description":"Type of deployment.","x-example":"vcs"},"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea6g16897e"},"resourceType":{"type":"string","description":"Resource type.","x-example":"functions"},"entrypoint":{"type":"string","description":"The entrypoint file to use to execute the deployment code.","x-example":"index.js"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"},"buildId":{"type":"string","description":"The current build ID.","x-example":"5e5ea5c16897e"},"activate":{"type":"boolean","description":"Whether the deployment should be automatically activated.","x-example":true},"status":{"type":"string","description":"The deployment status. Possible values are \"processing\", \"building\", \"waiting\", \"ready\", and \"failed\".","x-example":"ready"},"buildLogs":{"type":"string","description":"The build logs.","x-example":"Compiling source files..."},"buildTime":{"type":"integer","description":"The current build time in seconds.","x-example":128,"format":"int32"},"providerRepositoryName":{"type":"string","description":"The name of the vcs provider repository","x-example":"database"},"providerRepositoryOwner":{"type":"string","description":"The name of the vcs provider repository owner","x-example":"utopia"},"providerRepositoryUrl":{"type":"string","description":"The url of the vcs provider repository","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function"},"providerBranch":{"type":"string","description":"The branch of the vcs repository","x-example":"0.7.x"},"providerCommitHash":{"type":"string","description":"The commit hash of the vcs commit","x-example":"7c3f25d"},"providerCommitAuthorUrl":{"type":"string","description":"The url of vcs commit author","x-example":"https:\/\/github.com\/vermakhushboo"},"providerCommitAuthor":{"type":"string","description":"The name of vcs commit author","x-example":"Khushboo Verma"},"providerCommitMessage":{"type":"string","description":"The commit message","x-example":"Update index.js"},"providerCommitUrl":{"type":"string","description":"The url of the vcs commit","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"},"providerBranchUrl":{"type":"string","description":"The branch of the vcs repository","x-example":"https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"}},"required":["$id","$createdAt","$updatedAt","type","resourceId","resourceType","entrypoint","size","buildId","activate","status","buildLogs","buildTime","providerRepositoryName","providerRepositoryOwner","providerRepositoryUrl","providerBranch","providerCommitHash","providerCommitAuthorUrl","providerCommitAuthor","providerCommitMessage","providerCommitUrl","providerBranchUrl"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"build":{"description":"Build","type":"object","properties":{"$id":{"type":"string","description":"Build ID.","x-example":"5e5ea5c16897e"},"deploymentId":{"type":"string","description":"The deployment that created this build.","x-example":"5e5ea5c16897e"},"status":{"type":"string","description":"The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built","x-example":"ready"},"stdout":{"type":"string","description":"The stdout of the build.","x-example":""},"stderr":{"type":"string","description":"The stderr of the build.","x-example":""},"startTime":{"type":"string","description":"The deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"endTime":{"type":"string","description":"The time the build was finished in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"duration":{"type":"integer","description":"The build duration in seconds.","x-example":0,"format":"int32"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"}},"required":["$id","deploymentId","status","stdout","stderr","startTime","endTime","duration","size"]},"project":{"description":"Project","type":"object","properties":{"$id":{"type":"string","description":"Project ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Project creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Project update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Project name.","x-example":"New Project"},"description":{"type":"string","description":"Project description.","x-example":"This is a new project."},"teamId":{"type":"string","description":"Project team ID.","x-example":"1592981250"},"logo":{"type":"string","description":"Project logo file ID.","x-example":"5f5c451b403cb"},"url":{"type":"string","description":"Project website URL.","x-example":"5f5c451b403cb"},"legalName":{"type":"string","description":"Company legal name.","x-example":"Company LTD."},"legalCountry":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.","x-example":"US"},"legalState":{"type":"string","description":"State name.","x-example":"New York"},"legalCity":{"type":"string","description":"City name.","x-example":"New York City."},"legalAddress":{"type":"string","description":"Company Address.","x-example":"620 Eighth Avenue, New York, NY 10018"},"legalTaxId":{"type":"string","description":"Company Tax ID.","x-example":"131102020"},"authDuration":{"type":"integer","description":"Session duration in seconds.","x-example":60,"format":"int32"},"authLimit":{"type":"integer","description":"Max users allowed. 0 is unlimited.","x-example":100,"format":"int32"},"authSessionsLimit":{"type":"integer","description":"Max sessions allowed per user. 100 maximum.","x-example":10,"format":"int32"},"authPasswordHistory":{"type":"integer","description":"Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.","x-example":5,"format":"int32"},"authPasswordDictionary":{"type":"boolean","description":"Whether or not to check user's password against most commonly used passwords.","x-example":true},"authPersonalDataCheck":{"type":"boolean","description":"Whether or not to check the user password for similarity with their personal data.","x-example":true},"authMockNumbers":{"type":"array","description":"An array of mock numbers and their corresponding verification codes (OTPs).","items":{"type":"object","$ref":"#\/definitions\/mockNumber"},"x-example":[{}]},"authSessionAlerts":{"type":"boolean","description":"Whether or not to send session alert emails to users.","x-example":true},"oAuthProviders":{"type":"array","description":"List of Auth Providers.","items":{"type":"object","$ref":"#\/definitions\/authProvider"},"x-example":[{}]},"platforms":{"type":"array","description":"List of Platforms.","items":{"type":"object","$ref":"#\/definitions\/platform"},"x-example":{}},"webhooks":{"type":"array","description":"List of Webhooks.","items":{"type":"object","$ref":"#\/definitions\/webhook"},"x-example":{}},"keys":{"type":"array","description":"List of API Keys.","items":{"type":"object","$ref":"#\/definitions\/key"},"x-example":{}},"smtpEnabled":{"type":"boolean","description":"Status for custom SMTP","x-example":false},"smtpSenderName":{"type":"string","description":"SMTP sender name","x-example":"John Appwrite"},"smtpSenderEmail":{"type":"string","description":"SMTP sender email","x-example":"john@appwrite.io"},"smtpReplyTo":{"type":"string","description":"SMTP reply to email","x-example":"support@appwrite.io"},"smtpHost":{"type":"string","description":"SMTP server host name","x-example":"mail.appwrite.io"},"smtpPort":{"type":"integer","description":"SMTP server port","x-example":25,"format":"int32"},"smtpUsername":{"type":"string","description":"SMTP server username","x-example":"emailuser"},"smtpPassword":{"type":"string","description":"SMTP server password","x-example":"securepassword"},"smtpSecure":{"type":"string","description":"SMTP server secure protocol","x-example":"tls"},"authEmailPassword":{"type":"boolean","description":"Email\/Password auth method status","x-example":true},"authUsersAuthMagicURL":{"type":"boolean","description":"Magic URL auth method status","x-example":true},"authEmailOtp":{"type":"boolean","description":"Email (OTP) auth method status","x-example":true},"authAnonymous":{"type":"boolean","description":"Anonymous auth method status","x-example":true},"authInvites":{"type":"boolean","description":"Invites auth method status","x-example":true},"authJWT":{"type":"boolean","description":"JWT auth method status","x-example":true},"authPhone":{"type":"boolean","description":"Phone auth method status","x-example":true},"serviceStatusForAccount":{"type":"boolean","description":"Account service status","x-example":true},"serviceStatusForAvatars":{"type":"boolean","description":"Avatars service status","x-example":true},"serviceStatusForDatabases":{"type":"boolean","description":"Databases service status","x-example":true},"serviceStatusForLocale":{"type":"boolean","description":"Locale service status","x-example":true},"serviceStatusForHealth":{"type":"boolean","description":"Health service status","x-example":true},"serviceStatusForStorage":{"type":"boolean","description":"Storage service status","x-example":true},"serviceStatusForTeams":{"type":"boolean","description":"Teams service status","x-example":true},"serviceStatusForUsers":{"type":"boolean","description":"Users service status","x-example":true},"serviceStatusForFunctions":{"type":"boolean","description":"Functions service status","x-example":true},"serviceStatusForGraphql":{"type":"boolean","description":"GraphQL service status","x-example":true},"serviceStatusForMessaging":{"type":"boolean","description":"Messaging service status","x-example":true}},"required":["$id","$createdAt","$updatedAt","name","description","teamId","logo","url","legalName","legalCountry","legalState","legalCity","legalAddress","legalTaxId","authDuration","authLimit","authSessionsLimit","authPasswordHistory","authPasswordDictionary","authPersonalDataCheck","authMockNumbers","authSessionAlerts","oAuthProviders","platforms","webhooks","keys","smtpEnabled","smtpSenderName","smtpSenderEmail","smtpReplyTo","smtpHost","smtpPort","smtpUsername","smtpPassword","smtpSecure","authEmailPassword","authUsersAuthMagicURL","authEmailOtp","authAnonymous","authInvites","authJWT","authPhone","serviceStatusForAccount","serviceStatusForAvatars","serviceStatusForDatabases","serviceStatusForLocale","serviceStatusForHealth","serviceStatusForStorage","serviceStatusForTeams","serviceStatusForUsers","serviceStatusForFunctions","serviceStatusForGraphql","serviceStatusForMessaging"]},"webhook":{"description":"Webhook","type":"object","properties":{"$id":{"type":"string","description":"Webhook ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Webhook creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Webhook update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Webhook name.","x-example":"My Webhook"},"url":{"type":"string","description":"Webhook URL endpoint.","x-example":"https:\/\/example.com\/webhook"},"events":{"type":"array","description":"Webhook trigger events.","items":{"type":"string"},"x-example":"database.collections.update"},"security":{"type":"boolean","description":"Indicated if SSL \/ TLS Certificate verification is enabled.","x-example":true},"httpUser":{"type":"string","description":"HTTP basic authentication username.","x-example":"username"},"httpPass":{"type":"string","description":"HTTP basic authentication password.","x-example":"password"},"signatureKey":{"type":"string","description":"Signature key which can be used to validated incoming","x-example":"ad3d581ca230e2b7059c545e5a"},"enabled":{"type":"boolean","description":"Indicates if this webhook is enabled.","x-example":true},"logs":{"type":"string","description":"Webhook error logs from the most recent failure.","x-example":"Failed to connect to remote server."},"attempts":{"type":"integer","description":"Number of consecutive failed webhook attempts.","x-example":10,"format":"int32"}},"required":["$id","$createdAt","$updatedAt","name","url","events","security","httpUser","httpPass","signatureKey","enabled","logs","attempts"]},"key":{"description":"Key","type":"object","properties":{"$id":{"type":"string","description":"Key ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Key creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Key update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Key name.","x-example":"My API Key"},"expire":{"type":"string","description":"Key expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"secret":{"type":"string","description":"Secret key.","x-example":"919c2d18fb5d4...a2ae413da83346ad2"},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"},"sdks":{"type":"array","description":"List of SDK user agents that used this key.","items":{"type":"string"},"x-example":"appwrite:flutter"}},"required":["$id","$createdAt","$updatedAt","name","expire","scopes","secret","accessedAt","sdks"]},"mockNumber":{"description":"Mock Number","type":"object","properties":{"phone":{"type":"string","description":"Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.","x-example":"+1612842323"},"otp":{"type":"string","description":"Mock OTP for the number. ","x-example":"123456"}},"required":["phone","otp"]},"authProvider":{"description":"AuthProvider","type":"object","properties":{"key":{"type":"string","description":"Auth Provider.","x-example":"github"},"name":{"type":"string","description":"Auth Provider name.","x-example":"GitHub"},"appId":{"type":"string","description":"OAuth 2.0 application ID.","x-example":"259125845563242502"},"secret":{"type":"string","description":"OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.","x-example":"Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ"},"enabled":{"type":"boolean","description":"Auth Provider is active and can be used to create session.","x-example":""}},"required":["key","name","appId","secret","enabled"]},"platform":{"description":"Platform","type":"object","properties":{"$id":{"type":"string","description":"Platform ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Platform creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Platform update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Platform name.","x-example":"My Web App"},"type":{"type":"string","description":"Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, ios, android, and unity.","x-example":"web"},"key":{"type":"string","description":"Platform Key. iOS bundle ID or Android package name. Empty string for other platforms.","x-example":"com.company.appname"},"store":{"type":"string","description":"App store or Google Play store ID.","x-example":""},"hostname":{"type":"string","description":"Web app hostname. Empty string for other platforms.","x-example":true},"httpUser":{"type":"string","description":"HTTP basic authentication username.","x-example":"username"},"httpPass":{"type":"string","description":"HTTP basic authentication password.","x-example":"password"}},"required":["$id","$createdAt","$updatedAt","name","type","key","store","hostname","httpUser","httpPass"]},"variable":{"description":"Variable","type":"object","properties":{"$id":{"type":"string","description":"Variable ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"key":{"type":"string","description":"Variable key.","x-example":"API_KEY"},"value":{"type":"string","description":"Variable value.","x-example":"myPa$$word1"},"resourceType":{"type":"string","description":"Service to which the variable belongs. Possible values are \"project\", \"function\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"}},"required":["$id","$createdAt","$updatedAt","key","value","resourceType","resourceId"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"healthAntivirus":{"description":"Health Antivirus","type":"object","properties":{"version":{"type":"string","description":"Antivirus version.","x-example":"1.0.0"},"status":{"type":"string","description":"Antivirus status. Possible values can are: `disabled`, `offline`, `online`","x-example":"online"}},"required":["version","status"]},"healthQueue":{"description":"Health Queue","type":"object","properties":{"size":{"type":"integer","description":"Amount of actions in the queue.","x-example":8,"format":"int32"}},"required":["size"]},"healthStatus":{"description":"Health Status","type":"object","properties":{"name":{"type":"string","description":"Name of the service.","x-example":"database"},"ping":{"type":"integer","description":"Duration in milliseconds how long the health check took.","x-example":128,"format":"int32"},"status":{"type":"string","description":"Service status. Possible values can are: `pass`, `fail`","x-example":"pass"}},"required":["name","ping","status"]},"healthCertificate":{"description":"Health Certificate","type":"object","properties":{"name":{"type":"string","description":"Certificate name","x-example":"\/CN=www.google.com"},"subjectSN":{"type":"string","description":"Subject SN","x-example":""},"issuerOrganisation":{"type":"string","description":"Issuer organisation","x-example":""},"validFrom":{"type":"string","description":"Valid from","x-example":"1704200998"},"validTo":{"type":"string","description":"Valid to","x-example":"1711458597"},"signatureTypeSN":{"type":"string","description":"Signature type SN","x-example":"RSA-SHA256"}},"required":["name","subjectSN","issuerOrganisation","validFrom","validTo","signatureTypeSN"]},"healthTime":{"description":"Health Time","type":"object","properties":{"remoteTime":{"type":"integer","description":"Current unix timestamp on trustful remote server.","x-example":1639490751,"format":"int32"},"localTime":{"type":"integer","description":"Current unix timestamp of local server where Appwrite runs.","x-example":1639490844,"format":"int32"},"diff":{"type":"integer","description":"Difference of unix remote and local timestamps in milliseconds.","x-example":93,"format":"int32"}},"required":["remoteTime","localTime","diff"]},"metric":{"description":"Metric","type":"object","properties":{"value":{"type":"integer","description":"The value of this metric at the timestamp.","x-example":1,"format":"int32"},"date":{"type":"string","description":"The date at which this metric was aggregated in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["value","date"]},"metricBreakdown":{"description":"Metric Breakdown","type":"object","properties":{"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Resource name.","x-example":"Documents"},"value":{"type":"integer","description":"The value of this metric at the timestamp.","x-example":1,"format":"int32"}},"required":["resourceId","name","value"]},"usageDatabases":{"description":"UsageDatabases","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"databasesTotal":{"type":"integer","description":"Total aggregated number of databases.","x-example":0,"format":"int32"},"collectionsTotal":{"type":"integer","description":"Total aggregated number of collections.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"databases":{"type":"array","description":"Aggregated number of databases per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"collections":{"type":"array","description":"Aggregated number of collections per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","databasesTotal","collectionsTotal","documentsTotal","databases","collections","documents"]},"usageDatabase":{"description":"UsageDatabase","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"collectionsTotal":{"type":"integer","description":"Total aggregated number of collections.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"collections":{"type":"array","description":"Aggregated number of collections per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","collectionsTotal","documentsTotal","collections","documents"]},"usageCollection":{"description":"UsageCollection","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"documentsTotal":{"type":"integer","description":"Total aggregated number of of documents.","x-example":0,"format":"int32"},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","documentsTotal","documents"]},"usageUsers":{"description":"UsageUsers","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"usersTotal":{"type":"integer","description":"Total aggregated number of statistics of users.","x-example":0,"format":"int32"},"sessionsTotal":{"type":"integer","description":"Total aggregated number of active sessions.","x-example":0,"format":"int32"},"users":{"type":"array","description":"Aggregated number of users per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"sessions":{"type":"array","description":"Aggregated number of active sessions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","usersTotal","sessionsTotal","users","sessions"]},"usageStorage":{"description":"StorageUsage","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"bucketsTotal":{"type":"integer","description":"Total aggregated number of buckets","x-example":0,"format":"int32"},"filesTotal":{"type":"integer","description":"Total aggregated number of files.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated number of files storage (in bytes).","x-example":0,"format":"int32"},"buckets":{"type":"array","description":"Aggregated number of buckets per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"files":{"type":"array","description":"Aggregated number of files per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"storage":{"type":"array","description":"Aggregated number of files storage (in bytes) per period .","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","bucketsTotal","filesTotal","filesStorageTotal","buckets","files","storage"]},"usageBuckets":{"description":"UsageBuckets","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"filesTotal":{"type":"integer","description":"Total aggregated number of bucket files.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated number of bucket files storage (in bytes).","x-example":0,"format":"int32"},"files":{"type":"array","description":"Aggregated number of bucket files per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"storage":{"type":"array","description":"Aggregated number of bucket storage files (in bytes) per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","filesTotal","filesStorageTotal","files","storage"]},"usageFunctions":{"description":"UsageFunctions","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"functionsTotal":{"type":"integer","description":"Total aggregated number of functions.","x-example":0,"format":"int32"},"deploymentsTotal":{"type":"integer","description":"Total aggregated number of functions deployments.","x-example":0,"format":"int32"},"deploymentsStorageTotal":{"type":"integer","description":"Total aggregated sum of functions deployment storage.","x-example":0,"format":"int32"},"buildsTotal":{"type":"integer","description":"Total aggregated number of functions build.","x-example":0,"format":"int32"},"buildsStorageTotal":{"type":"integer","description":"total aggregated sum of functions build storage.","x-example":0,"format":"int32"},"buildsTimeTotal":{"type":"integer","description":"Total aggregated sum of functions build compute time.","x-example":0,"format":"int32"},"executionsTotal":{"type":"integer","description":"Total aggregated number of functions execution.","x-example":0,"format":"int32"},"executionsTimeTotal":{"type":"integer","description":"Total aggregated sum of functions execution compute time.","x-example":0,"format":"int32"},"functions":{"type":"array","description":"Aggregated number of functions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":0},"deployments":{"type":"array","description":"Aggregated number of functions deployment per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"deploymentsStorage":{"type":"array","description":"Aggregated number of functions deployment storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"builds":{"type":"array","description":"Aggregated number of functions build per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsStorage":{"type":"array","description":"Aggregated sum of functions build storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsTime":{"type":"array","description":"Aggregated sum of functions build compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of functions execution per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executionsTime":{"type":"array","description":"Aggregated number of functions execution compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","functionsTotal","deploymentsTotal","deploymentsStorageTotal","buildsTotal","buildsStorageTotal","buildsTimeTotal","executionsTotal","executionsTimeTotal","functions","deployments","deploymentsStorage","builds","buildsStorage","buildsTime","executions","executionsTime"]},"usageFunction":{"description":"UsageFunction","type":"object","properties":{"range":{"type":"string","description":"The time range of the usage stats.","x-example":"30d"},"deploymentsTotal":{"type":"integer","description":"Total aggregated number of function deployments.","x-example":0,"format":"int32"},"deploymentsStorageTotal":{"type":"integer","description":"Total aggregated sum of function deployments storage.","x-example":0,"format":"int32"},"buildsTotal":{"type":"integer","description":"Total aggregated number of function builds.","x-example":0,"format":"int32"},"buildsStorageTotal":{"type":"integer","description":"total aggregated sum of function builds storage.","x-example":0,"format":"int32"},"buildsTimeTotal":{"type":"integer","description":"Total aggregated sum of function builds compute time.","x-example":0,"format":"int32"},"executionsTotal":{"type":"integer","description":"Total aggregated number of function executions.","x-example":0,"format":"int32"},"executionsTimeTotal":{"type":"integer","description":"Total aggregated sum of function executions compute time.","x-example":0,"format":"int32"},"deployments":{"type":"array","description":"Aggregated number of function deployments per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"deploymentsStorage":{"type":"array","description":"Aggregated number of function deployments storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"builds":{"type":"array","description":"Aggregated number of function builds per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsStorage":{"type":"array","description":"Aggregated sum of function builds storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsTime":{"type":"array","description":"Aggregated sum of function builds compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of function executions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executionsTime":{"type":"array","description":"Aggregated number of function executions compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","deploymentsTotal","deploymentsStorageTotal","buildsTotal","buildsStorageTotal","buildsTimeTotal","executionsTotal","executionsTimeTotal","deployments","deploymentsStorage","builds","buildsStorage","buildsTime","executions","executionsTime"]},"usageProject":{"description":"UsageProject","type":"object","properties":{"executionsTotal":{"type":"integer","description":"Total aggregated number of function executions.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"databasesTotal":{"type":"integer","description":"Total aggregated number of databases.","x-example":0,"format":"int32"},"usersTotal":{"type":"integer","description":"Total aggregated number of users.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated sum of files storage size (in bytes).","x-example":0,"format":"int32"},"bucketsTotal":{"type":"integer","description":"Total aggregated number of buckets.","x-example":0,"format":"int32"},"requests":{"type":"array","description":"Aggregated number of requests per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"network":{"type":"array","description":"Aggregated number of consumed bandwidth per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"users":{"type":"array","description":"Aggregated number of users per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of executions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executionsBreakdown":{"type":"array","description":"Aggregated breakdown in totals of executions by functions.","items":{"type":"object","$ref":"#\/definitions\/metricBreakdown"},"x-example":[]},"bucketsBreakdown":{"type":"array","description":"Aggregated breakdown in totals of usage by buckets.","items":{"type":"object","$ref":"#\/definitions\/metricBreakdown"},"x-example":[]}},"required":["executionsTotal","documentsTotal","databasesTotal","usersTotal","filesStorageTotal","bucketsTotal","requests","network","users","executions","executionsBreakdown","bucketsBreakdown"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"proxyRule":{"description":"Rule","type":"object","properties":{"$id":{"type":"string","description":"Rule ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Rule creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Rule update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"domain":{"type":"string","description":"Domain name.","x-example":"appwrite.company.com"},"resourceType":{"type":"string","description":"Action definition for the rule. Possible values are \"api\", \"function\", or \"redirect\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource for the action type. If resourceType is \"api\" or \"url\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"},"status":{"type":"string","description":"Domain verification status. Possible values are \"created\", \"verifying\", \"verified\" and \"unverified\"","x-example":"verified"},"logs":{"type":"string","description":"Certificate generation logs. This will return an empty string if generation did not run, or succeeded.","x-example":"HTTP challegne failed."},"renewAt":{"type":"string","description":"Certificate auto-renewal date in ISO 8601 format.","x-example":"datetime"}},"required":["$id","$createdAt","$updatedAt","domain","resourceType","resourceId","status","logs","renewAt"]},"smsTemplate":{"description":"SmsTemplate","type":"object","properties":{"type":{"type":"string","description":"Template type","x-example":"verification"},"locale":{"type":"string","description":"Template locale","x-example":"en_us"},"message":{"type":"string","description":"Template message","x-example":"Click on the link to verify your account."}},"required":["type","locale","message"]},"emailTemplate":{"description":"EmailTemplate","type":"object","properties":{"type":{"type":"string","description":"Template type","x-example":"verification"},"locale":{"type":"string","description":"Template locale","x-example":"en_us"},"message":{"type":"string","description":"Template message","x-example":"Click on the link to verify your account."},"senderName":{"type":"string","description":"Name of the sender","x-example":"My User"},"senderEmail":{"type":"string","description":"Email of the sender","x-example":"mail@appwrite.io"},"replyTo":{"type":"string","description":"Reply to email address","x-example":"emails@appwrite.io"},"subject":{"type":"string","description":"Email subject","x-example":"Please verify your email address"}},"required":["type","locale","message","senderName","senderEmail","replyTo","subject"]},"consoleVariables":{"description":"Console Variables","type":"object","properties":{"_APP_DOMAIN_TARGET":{"type":"string","description":"CNAME target for your Appwrite custom domains.","x-example":"appwrite.io"},"_APP_STORAGE_LIMIT":{"type":"integer","description":"Maximum file size allowed for file upload in bytes.","x-example":"30000000","format":"int32"},"_APP_FUNCTIONS_SIZE_LIMIT":{"type":"integer","description":"Maximum file size allowed for deployment in bytes.","x-example":"30000000","format":"int32"},"_APP_USAGE_STATS":{"type":"string","description":"Defines if usage stats are enabled. This value is set to 'enabled' by default, to disable the usage stats set the value to 'disabled'.","x-example":"enabled"},"_APP_VCS_ENABLED":{"type":"boolean","description":"Defines if VCS (Version Control System) is enabled.","x-example":true},"_APP_DOMAIN_ENABLED":{"type":"boolean","description":"Defines if main domain is configured. If so, custom domains can be created.","x-example":true},"_APP_ASSISTANT_ENABLED":{"type":"boolean","description":"Defines if AI assistant is enabled.","x-example":true}},"required":["_APP_DOMAIN_TARGET","_APP_STORAGE_LIMIT","_APP_FUNCTIONS_SIZE_LIMIT","_APP_USAGE_STATS","_APP_VCS_ENABLED","_APP_DOMAIN_ENABLED","_APP_ASSISTANT_ENABLED"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"provider":{"description":"Provider","type":"object","properties":{"$id":{"type":"string","description":"Provider ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Provider creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Provider update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name for the provider instance.","x-example":"Mailgun"},"provider":{"type":"string","description":"The name of the provider service.","x-example":"mailgun"},"enabled":{"type":"boolean","description":"Is provider enabled?","x-example":true},"type":{"type":"string","description":"Type of provider.","x-example":"sms"},"credentials":{"type":"object","additionalProperties":true,"description":"Provider credentials.","x-example":{"key":"123456789"}},"options":{"type":"object","additionalProperties":true,"description":"Provider options.","x-example":{"from":"sender-email@mydomain"}}},"required":["$id","$createdAt","$updatedAt","name","provider","enabled","type","credentials"]},"message":{"description":"Message","type":"object","properties":{"$id":{"type":"string","description":"Message ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Message creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Message update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerType":{"type":"string","description":"Message provider type.","x-example":"email"},"topics":{"type":"array","description":"Topic IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"users":{"type":"array","description":"User IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"targets":{"type":"array","description":"Target IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"scheduledAt":{"type":"string","description":"The scheduled time for message.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveredAt":{"type":"string","description":"The time when the message was delivered.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveryErrors":{"type":"array","description":"Delivery errors if any.","items":{"type":"string"},"x-example":["Failed to send message to target 5e5ea5c16897e: Credentials not valid."],"x-nullable":true},"deliveredTotal":{"type":"integer","description":"Number of recipients the message was delivered to.","x-example":1,"format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Data of the message.","x-example":{"subject":"Welcome to Appwrite","content":"Hi there, welcome to Appwrite family."}},"status":{"type":"string","description":"Status of delivery.","x-example":"Message status can be one of the following: draft, processing, scheduled, sent, or failed."}},"required":["$id","$createdAt","$updatedAt","providerType","topics","users","targets","deliveredTotal","data","status"]},"topic":{"description":"Topic","type":"object","properties":{"$id":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Topic creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Topic update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name of the topic.","x-example":"events"},"emailTotal":{"type":"integer","description":"Total count of email subscribers subscribed to the topic.","x-example":100,"format":"int32"},"smsTotal":{"type":"integer","description":"Total count of SMS subscribers subscribed to the topic.","x-example":100,"format":"int32"},"pushTotal":{"type":"integer","description":"Total count of push subscribers subscribed to the topic.","x-example":100,"format":"int32"},"subscribe":{"type":"array","description":"Subscribe permissions.","items":{"type":"string"},"x-example":"users"}},"required":["$id","$createdAt","$updatedAt","name","emailTotal","smsTotal","pushTotal","subscribe"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"type":"object","$ref":"#\/definitions\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","x-nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]},"migration":{"description":"Migration","type":"object","properties":{"$id":{"type":"string","description":"Migration ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"string","description":"Migration status ( pending, processing, failed, completed ) ","x-example":"pending"},"stage":{"type":"string","description":"Migration stage ( init, processing, source-check, destination-check, migrating, finished )","x-example":"init"},"source":{"type":"string","description":"A string containing the type of source of the migration.","x-example":"Appwrite"},"resources":{"type":"array","description":"Resources to migration.","items":{"type":"string"},"x-example":["user"]},"statusCounters":{"type":"object","additionalProperties":true,"description":"A group of counters that represent the total progress of the migration.","x-example":"{\"Database\": {\"PENDING\": 0, \"SUCCESS\": 1, \"ERROR\": 0, \"SKIP\": 0, \"PROCESSING\": 0, \"WARNING\": 0}}"},"resourceData":{"type":"object","additionalProperties":true,"description":"An array of objects containing the report data of the resources that were migrated.","x-example":"[{\"resource\":\"Database\",\"id\":\"public\",\"status\":\"SUCCESS\",\"message\":\"\"}]"},"errors":{"type":"array","description":"All errors that occurred during the migration process.","items":{"type":"string"},"x-example":[]}},"required":["$id","$createdAt","$updatedAt","status","stage","source","resources","statusCounters","resourceData","errors"]},"migrationReport":{"description":"Migration Report","type":"object","properties":{"user":{"type":"integer","description":"Number of users to be migrated.","x-example":20,"format":"int32"},"team":{"type":"integer","description":"Number of teams to be migrated.","x-example":20,"format":"int32"},"database":{"type":"integer","description":"Number of databases to be migrated.","x-example":20,"format":"int32"},"document":{"type":"integer","description":"Number of documents to be migrated.","x-example":20,"format":"int32"},"file":{"type":"integer","description":"Number of files to be migrated.","x-example":20,"format":"int32"},"bucket":{"type":"integer","description":"Number of buckets to be migrated.","x-example":20,"format":"int32"},"function":{"type":"integer","description":"Number of functions to be migrated.","x-example":20,"format":"int32"},"size":{"type":"integer","description":"Size of files to be migrated in mb.","x-example":30000,"format":"int32"},"version":{"type":"string","description":"Version of the Appwrite instance to be migrated.","x-example":"1.4.0"}},"required":["user","team","database","document","file","bucket","function","size","version"]},"firebaseProject":{"description":"MigrationFirebaseProject","type":"object","properties":{"projectId":{"type":"string","description":"Project ID.","x-example":"my-project"},"displayName":{"type":"string","description":"Project display name.","x-example":"My Project"}},"required":["projectId","displayName"]}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file +{"swagger":"2.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"host":"cloud.appwrite.io","basePath":"\/v1","schemes":["https"],"consumes":["application\/json","multipart\/form-data"],"produces":["application\/json"],"securityDefinitions":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"Key":{"type":"apiKey","name":"X-Appwrite-Key","description":"Your secret API key","in":"header","x-appwrite":{"demo":"<YOUR_API_KEY>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header","x-appwrite":{"demo":"<YOUR_JWT>"}},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Mode":{"type":"apiKey","name":"X-Appwrite-Mode","description":"","in":"header","x-appwrite":{"demo":""}}},"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]},"delete":{"summary":"Delete account","operationId":"accountDelete","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete the currently logged in user.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":9,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","schema":{"$ref":"#\/definitions\/mfaType"}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","schema":{"$ref":"#\/definitions\/mfaChallenge"}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","default":null,"x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}]},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","default":null,"x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["challengeId","otp"]}}]}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","default":"","x-example":"password"}},"required":["password"]}}]}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["phone","password"]}}]}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["email","url"]}}]},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","default":null,"x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null}},"required":["userId","secret","password"]}}]}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 session","operationId":"accountCreateOAuth2Session","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Session","weight":18,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/targets\/push":{"post":{"summary":"Create push target","operationId":"accountCreatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createPushTarget","weight":53,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"}},"required":["targetId","identifier"]}}]}},"\/account\/targets\/{targetId}\/push":{"put":{"summary":"Update push target","operationId":"accountUpdatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updatePushTarget","weight":54,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"}},"required":["identifier"]}}]},"delete":{"summary":"Delete push target","operationId":"accountDeletePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deletePushTarget","weight":55,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","default":"","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"}},"required":["userId","phone"]}}]}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["url"]}}]},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"type":"string","x-example":"<NAME>","default":"","in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"type":"string","default":"","in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"type":"string","x-example":"<TEXT>","in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":1,"default":400,"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"type":"integer","format":"int32","x-example":0,"default":1,"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"type":"boolean","x-example":false,"default":false,"in":"query"}]}},"\/console\/assistant":{"post":{"summary":"Ask Query","operationId":"assistantChat","consumes":["application\/json"],"produces":["text\/plain"],"tags":["assistant"],"description":"","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"chat","weight":328,"cookies":false,"type":"","deprecated":false,"demo":"assistant\/chat.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/assistant\/chat.md","rate-limit":15,"rate-time":3600,"rate-key":"userId:{userId}","scope":"assistant.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prompt":{"type":"string","description":"Prompt. A string containing questions asked to the AI assistant.","default":null,"x-example":"<PROMPT>"}},"required":["prompt"]}}]}},"\/console\/variables":{"get":{"summary":"Get variables","operationId":"consoleVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["console"],"description":"Get all Environment Variables that are relevant for the console.","responses":{"200":{"description":"Console Variables","schema":{"$ref":"#\/definitions\/consoleVariables"}}},"x-appwrite":{"method":"variables","weight":327,"cookies":false,"type":"","deprecated":false,"demo":"console\/variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/console\/variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/databases":{"get":{"summary":"List databases","operationId":"databasesList","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.","responses":{"200":{"description":"Databases List","schema":{"$ref":"#\/definitions\/databaseList"}}},"x-appwrite":{"method":"list","weight":69,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create database","operationId":"databasesCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Database.\n","responses":{"201":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"create","weight":68,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"databaseId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DATABASE_ID>"},"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["databaseId","name"]}}]}},"\/databases\/usage":{"get":{"summary":"Get databases usage stats","operationId":"databasesGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"","responses":{"200":{"description":"UsageDatabases","schema":{"$ref":"#\/definitions\/usageDatabases"}}},"x-appwrite":{"method":"getUsage","weight":113,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"`Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/databases\/{databaseId}":{"get":{"summary":"Get database","operationId":"databasesGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"get","weight":70,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]},"put":{"summary":"Update database","operationId":"databasesUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a database by its unique ID.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"update","weight":72,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete database","operationId":"databasesDelete","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":73,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections":{"get":{"summary":"List collections","operationId":"databasesListCollections","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.","responses":{"200":{"description":"Collections List","schema":{"$ref":"#\/definitions\/collectionList"}}},"x-appwrite":{"method":"listCollections","weight":75,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collections.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"queries","description":"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: name, enabled, documentSecurity","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create collection","operationId":"databasesCreateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"createCollection","weight":74,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"collectionId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<COLLECTION_ID>"},"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["collectionId","name"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}":{"get":{"summary":"Get collection","operationId":"databasesGetCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"getCollection","weight":76,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]},"put":{"summary":"Update collection","operationId":"databasesUpdateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a collection by its unique ID.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"updateCollection","weight":78,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete collection","operationId":"databasesDeleteCollection","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteCollection","weight":79,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes":{"get":{"summary":"List attributes","operationId":"databasesListAttributes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List attributes in the collection.","responses":{"200":{"description":"Attributes List","schema":{"$ref":"#\/definitions\/attributeList"}}},"x-appwrite":{"method":"listAttributes","weight":90,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-attributes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, size, required, array, status, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean":{"post":{"summary":"Create boolean attribute","operationId":"databasesCreateBooleanAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a boolean attribute.\n","responses":{"202":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"createBooleanAttribute","weight":87,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}":{"patch":{"summary":"Update boolean attribute","operationId":"databasesUpdateBooleanAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a boolean attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"updateBooleanAttribute","weight":99,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime":{"post":{"summary":"Create datetime attribute","operationId":"databasesCreateDatetimeAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a date time attribute according to the ISO 8601 standard.","responses":{"202":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"createDatetimeAttribute","weight":88,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}":{"patch":{"summary":"Update dateTime attribute","operationId":"databasesUpdateDatetimeAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a date time attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"updateDatetimeAttribute","weight":100,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email":{"post":{"summary":"Create email attribute","operationId":"databasesCreateEmailAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an email attribute.\n","responses":{"202":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"createEmailAttribute","weight":81,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}":{"patch":{"summary":"Update email attribute","operationId":"databasesUpdateEmailAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an email attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"updateEmailAttribute","weight":93,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum":{"post":{"summary":"Create enum attribute","operationId":"databasesCreateEnumAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n","responses":{"202":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"createEnumAttribute","weight":82,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","elements","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}":{"patch":{"summary":"Update enum attribute","operationId":"databasesUpdateEnumAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an enum attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"updateEnumAttribute","weight":94,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["elements","required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float":{"post":{"summary":"Create float attribute","operationId":"databasesCreateFloatAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a float attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"createFloatAttribute","weight":86,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float\/{key}":{"patch":{"summary":"Update float attribute","operationId":"databasesUpdateFloatAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a float attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"updateFloatAttribute","weight":98,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer":{"post":{"summary":"Create integer attribute","operationId":"databasesCreateIntegerAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an integer attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"createIntegerAttribute","weight":85,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer\/{key}":{"patch":{"summary":"Update integer attribute","operationId":"databasesUpdateIntegerAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an integer attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"updateIntegerAttribute","weight":97,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip":{"post":{"summary":"Create IP address attribute","operationId":"databasesCreateIpAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create IP address attribute.\n","responses":{"202":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"createIpAttribute","weight":83,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}":{"patch":{"summary":"Update IP address attribute","operationId":"databasesUpdateIpAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an ip attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"updateIpAttribute","weight":95,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship":{"post":{"summary":"Create relationship attribute","operationId":"databasesCreateRelationshipAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"202":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"createRelationshipAttribute","weight":89,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"relatedCollectionId":{"type":"string","description":"Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","default":null,"x-example":"<RELATED_COLLECTION_ID>"},"type":{"type":"string","description":"Relation type","default":null,"x-example":"oneToOne","enum":["oneToOne","manyToOne","manyToMany","oneToMany"],"x-enum-name":"RelationshipType","x-enum-keys":[]},"twoWay":{"type":"boolean","description":"Is Two Way?","default":false,"x-example":false},"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"twoWayKey":{"type":"string","description":"Two Way Attribute Key.","default":null,"x-example":null},"onDelete":{"type":"string","description":"Constraints option","default":"restrict","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}},"required":["relatedCollectionId","type"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string":{"post":{"summary":"Create string attribute","operationId":"databasesCreateStringAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a string attribute.\n","responses":{"202":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"createStringAttribute","weight":80,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"size":{"type":"integer","description":"Attribute size for text attributes, in number of characters.","default":null,"x-example":1},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false},"encrypt":{"type":"boolean","description":"Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.","default":false,"x-example":false}},"required":["key","size","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}":{"patch":{"summary":"Update string attribute","operationId":"databasesUpdateStringAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a string attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"updateStringAttribute","weight":92,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url":{"post":{"summary":"Create URL attribute","operationId":"databasesCreateUrlAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a URL attribute.\n","responses":{"202":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"createUrlAttribute","weight":84,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}":{"patch":{"summary":"Update URL attribute","operationId":"databasesUpdateUrlAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an url attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"updateUrlAttribute","weight":96,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}":{"get":{"summary":"Get attribute","operationId":"databasesGetAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get attribute by ID.","responses":{"200":{"description":"AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString","schema":{"x-oneOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]}}},"x-appwrite":{"method":"getAttribute","weight":91,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete attribute","operationId":"databasesDeleteAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Deletes an attribute.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteAttribute","weight":102,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship":{"patch":{"summary":"Update relationship attribute","operationId":"databasesUpdateRelationshipAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"200":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"updateRelationshipAttribute","weight":101,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"onDelete":{"type":"string","description":"Constraints option","default":null,"x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}}}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","schema":{"$ref":"#\/definitions\/documentList"}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","default":{},"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","default":[],"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs":{"get":{"summary":"List document logs","operationId":"databasesListDocumentLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get the document activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listDocumentLogs","weight":110,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-document-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes":{"get":{"summary":"List indexes","operationId":"databasesListIndexes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List indexes in the collection.","responses":{"200":{"description":"Indexes List","schema":{"$ref":"#\/definitions\/indexList"}}},"x-appwrite":{"method":"listIndexes","weight":104,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-indexes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, status, attributes, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create index","operationId":"databasesCreateIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.","responses":{"202":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"createIndex","weight":103,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Index Key.","default":null,"x-example":null},"type":{"type":"string","description":"Index type.","default":null,"x-example":"key","enum":["key","fulltext","unique"],"x-enum-name":"IndexType","x-enum-keys":[]},"attributes":{"type":"array","description":"Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"orders":{"type":"array","description":"Array of index orders. Maximum of 100 orders are allowed.","default":[],"x-example":null,"items":{"type":"string"}}},"required":["key","type","attributes"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}":{"get":{"summary":"Get index","operationId":"databasesGetIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get index by ID.","responses":{"200":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"getIndex","weight":105,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete index","operationId":"databasesDeleteIndex","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete an index.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIndex","weight":106,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/logs":{"get":{"summary":"List collection logs","operationId":"databasesListCollectionLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get the collection activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listCollectionLogs","weight":77,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collection-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/usage":{"get":{"summary":"Get collection usage stats","operationId":"databasesGetCollectionUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"","responses":{"200":{"description":"UsageCollection","schema":{"$ref":"#\/definitions\/usageCollection"}}},"x-appwrite":{"method":"getCollectionUsage","weight":115,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]}},"\/databases\/{databaseId}\/logs":{"get":{"summary":"List database logs","operationId":"databasesListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get the database activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":71,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/usage":{"get":{"summary":"Get database usage stats","operationId":"databasesGetDatabaseUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"","responses":{"200":{"description":"UsageDatabase","schema":{"$ref":"#\/definitions\/usageDatabase"}}},"x-appwrite":{"method":"getDatabaseUsage","weight":114,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-database-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"range","description":"`Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/functions":{"get":{"summary":"List functions","operationId":"functionsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's functions. You can use the query params to filter your results.","responses":{"200":{"description":"Functions List","schema":{"$ref":"#\/definitions\/functionList"}}},"x-appwrite":{"method":"list","weight":287,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create function","operationId":"functionsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.","responses":{"201":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"create","weight":286,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"functionId":{"type":"string","description":"Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<FUNCTION_ID>"},"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":null,"x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Function maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Control System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function.","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function.","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"},"templateRepository":{"type":"string","description":"Repository name of the template.","default":"","x-example":"<TEMPLATE_REPOSITORY>"},"templateOwner":{"type":"string","description":"The name of the owner of the template.","default":"","x-example":"<TEMPLATE_OWNER>"},"templateRootDirectory":{"type":"string","description":"Path to function code in the template repo.","default":"","x-example":"<TEMPLATE_ROOT_DIRECTORY>"},"templateBranch":{"type":"string","description":"Production branch for the repo linked to the function template.","default":"","x-example":"<TEMPLATE_BRANCH>"}},"required":["functionId","name","runtime"]}}]}},"\/functions\/runtimes":{"get":{"summary":"List runtimes","operationId":"functionsListRuntimes","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all runtimes that are currently active on your instance.","responses":{"200":{"description":"Runtimes List","schema":{"$ref":"#\/definitions\/runtimeList"}}},"x-appwrite":{"method":"listRuntimes","weight":288,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-runtimes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-runtimes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/functions\/usage":{"get":{"summary":"Get functions usage","operationId":"functionsGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"UsageFunctions","schema":{"$ref":"#\/definitions\/usageFunctions"}}},"x-appwrite":{"method":"getUsage","weight":291,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"FunctionUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/functions\/{functionId}":{"get":{"summary":"Get function","operationId":"functionsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"get","weight":289,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"put":{"summary":"Update function","operationId":"functionsUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"update","weight":292,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":"","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Controle System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"}},"required":["name"]}}]},"delete":{"summary":"Delete function","operationId":"functionsDelete","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":295,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments":{"get":{"summary":"List deployments","operationId":"functionsListDeployments","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's code deployments. You can use the query params to filter your results.","responses":{"200":{"description":"Deployments List","schema":{"$ref":"#\/definitions\/deploymentList"}}},"x-appwrite":{"method":"listDeployments","weight":297,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: size, buildId, activate, entrypoint, commands","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create deployment","operationId":"functionsCreateDeployment","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.","responses":{"202":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"createDeployment","weight":296,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":true,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"entrypoint","description":"Entrypoint File.","required":false,"type":"string","x-example":"<ENTRYPOINT>","in":"formData"},{"name":"commands","description":"Build Commands.","required":false,"type":"string","x-example":"<COMMANDS>","in":"formData"},{"name":"code","description":"Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.","required":true,"type":"file","in":"formData"},{"name":"activate","description":"Automatically activate the deployment when it is finished building.","required":true,"type":"boolean","x-example":false,"in":"formData"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}":{"get":{"summary":"Get deployment","operationId":"functionsGetDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a code deployment by its unique ID.","responses":{"200":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"getDeployment","weight":298,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"patch":{"summary":"Update function deployment","operationId":"functionsUpdateDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"updateDeployment","weight":294,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"delete":{"summary":"Delete deployment","operationId":"functionsDeleteDeployment","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a code deployment by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDeployment","weight":299,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/build":{"post":{"summary":"Rebuild deployment","operationId":"functionsCreateBuild","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createBuild","weight":300,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"buildId":{"type":"string","description":"Build unique ID.","default":"","x-example":"<BUILD_ID>"}}}}]},"patch":{"summary":"Cancel deployment","operationId":"functionsUpdateDeploymentBuild","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"Build","schema":{"$ref":"#\/definitions\/build"}}},"x-appwrite":{"method":"updateDeploymentBuild","weight":301,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/download":{"get":{"summary":"Download Deployment","operationId":"functionsDownloadDeployment","consumes":["application\/json"],"produces":["*\/*"],"tags":["functions"],"description":"Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"downloadDeployment","weight":293,"cookies":false,"type":"location","deprecated":false,"demo":"functions\/download-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/download-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","schema":{"$ref":"#\/definitions\/executionList"}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","default":"","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","default":false,"x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","default":"\/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","default":"POST","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","default":[],"x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]},"delete":{"summary":"Delete execution","operationId":"functionsDeleteExecution","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function execution by its unique ID.\n","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteExecution","weight":305,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/usage":{"get":{"summary":"Get function usage","operationId":"functionsGetFunctionUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"UsageFunction","schema":{"$ref":"#\/definitions\/usageFunction"}}},"x-appwrite":{"method":"getFunctionUsage","weight":290,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-function-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"FunctionUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/functions\/{functionId}\/variables":{"get":{"summary":"List variables","operationId":"functionsListVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all variables of a specific function.","responses":{"200":{"description":"Variables List","schema":{"$ref":"#\/definitions\/variableList"}}},"x-appwrite":{"method":"listVariables","weight":307,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"post":{"summary":"Create variable","operationId":"functionsCreateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.","responses":{"201":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"createVariable","weight":306,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key","value"]}}]}},"\/functions\/{functionId}\/variables\/{variableId}":{"get":{"summary":"Get variable","operationId":"functionsGetVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"getVariable","weight":308,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]},"put":{"summary":"Update variable","operationId":"functionsUpdateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"updateVariable","weight":309,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key"]}}]},"delete":{"summary":"Delete variable","operationId":"functionsDeleteVariable","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a variable by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":310,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/health":{"get":{"summary":"Get HTTP","operationId":"healthGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite HTTP server is up and responsive.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"get","weight":124,"cookies":false,"type":"","deprecated":false,"demo":"health\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/anti-virus":{"get":{"summary":"Get antivirus","operationId":"healthGetAntivirus","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite Antivirus server is up and connection is successful.","responses":{"200":{"description":"Health Antivirus","schema":{"$ref":"#\/definitions\/healthAntivirus"}}},"x-appwrite":{"method":"getAntivirus","weight":146,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-antivirus.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/cache":{"get":{"summary":"Get cache","operationId":"healthGetCache","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite in-memory cache servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getCache","weight":127,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-cache.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/certificate":{"get":{"summary":"Get the SSL certificate for a domain","operationId":"healthGetCertificate","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the SSL certificate for a domain","responses":{"200":{"description":"Health Certificate","schema":{"$ref":"#\/definitions\/healthCertificate"}}},"x-appwrite":{"method":"getCertificate","weight":133,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-certificate.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"domain","description":"string","required":false,"type":"string","in":"query"}]}},"\/health\/db":{"get":{"summary":"Get DB","operationId":"healthGetDB","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite database servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getDB","weight":126,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-d-b.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/pubsub":{"get":{"summary":"Get pubsub","operationId":"healthGetPubSub","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite pub-sub servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getPubSub","weight":129,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-pub-sub.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue":{"get":{"summary":"Get queue","operationId":"healthGetQueue","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite queue messaging servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getQueue","weight":128,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue\/builds":{"get":{"summary":"Get builds queue","operationId":"healthGetQueueBuilds","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of builds that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueBuilds","weight":135,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-builds.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/certificates":{"get":{"summary":"Get certificates queue","operationId":"healthGetQueueCertificates","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of certificates that are waiting to be issued against [Letsencrypt](https:\/\/letsencrypt.org\/) in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueCertificates","weight":134,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-certificates.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/databases":{"get":{"summary":"Get databases queue","operationId":"healthGetQueueDatabases","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDatabases","weight":136,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-databases.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"Queue name for which to check the queue size","required":false,"type":"string","x-example":"<NAME>","default":"database_db_main","in":"query"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/deletes":{"get":{"summary":"Get deletes queue","operationId":"healthGetQueueDeletes","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDeletes","weight":137,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-deletes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/failed\/{name}":{"get":{"summary":"Get number of failed queue jobs","operationId":"healthGetFailedJobs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Returns the amount of failed jobs in a given queue.\n","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getFailedJobs","weight":147,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-failed-jobs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"The name of the queue","required":true,"type":"string","x-example":"v1-database","enum":["v1-database","v1-deletes","v1-audits","v1-mails","v1-functions","v1-usage","v1-usage-dump","v1-webhooks","v1-certificates","v1-builds","v1-messaging","v1-migrations"],"x-enum-name":null,"x-enum-keys":[],"in":"path"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/functions":{"get":{"summary":"Get functions queue","operationId":"healthGetQueueFunctions","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueFunctions","weight":141,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-functions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/logs":{"get":{"summary":"Get logs queue","operationId":"healthGetQueueLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of logs that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueLogs","weight":132,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/mails":{"get":{"summary":"Get mails queue","operationId":"healthGetQueueMails","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of mails that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMails","weight":138,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-mails.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/messaging":{"get":{"summary":"Get messaging queue","operationId":"healthGetQueueMessaging","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of messages that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMessaging","weight":139,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-messaging.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/migrations":{"get":{"summary":"Get migrations queue","operationId":"healthGetQueueMigrations","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMigrations","weight":140,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-migrations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage":{"get":{"summary":"Get usage queue","operationId":"healthGetQueueUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsage","weight":142,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage-dump":{"get":{"summary":"Get usage dump queue","operationId":"healthGetQueueUsageDump","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsageDump","weight":143,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage-dump.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage-dump.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/webhooks":{"get":{"summary":"Get webhooks queue","operationId":"healthGetQueueWebhooks","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueWebhooks","weight":131,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/storage":{"get":{"summary":"Get storage","operationId":"healthGetStorage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorage","weight":145,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/storage\/local":{"get":{"summary":"Get local storage","operationId":"healthGetStorageLocal","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite local storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorageLocal","weight":144,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage-local.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/time":{"get":{"summary":"Get time","operationId":"healthGetTime","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https:\/\/en.wikipedia.org\/wiki\/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.","responses":{"200":{"description":"Health Time","schema":{"$ref":"#\/definitions\/healthTime"}}},"x-appwrite":{"method":"getTime","weight":130,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-time.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","schema":{"$ref":"#\/definitions\/locale"}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","schema":{"$ref":"#\/definitions\/localeCodeList"}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","schema":{"$ref":"#\/definitions\/continentList"}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","schema":{"$ref":"#\/definitions\/phoneList"}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","schema":{"$ref":"#\/definitions\/currencyList"}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","schema":{"$ref":"#\/definitions\/languageList"}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/messaging\/messages":{"get":{"summary":"List messages","operationId":"messagingListMessages","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all messages from the current Appwrite project.","responses":{"200":{"description":"Message list","schema":{"$ref":"#\/definitions\/messageList"}}},"x-appwrite":{"method":"listMessages","weight":385,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-messages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/messages\/email":{"post":{"summary":"Create email","operationId":"messagingCreateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new email message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createEmail","weight":382,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":[],"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":[],"x-example":null,"items":{"type":"string"}},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","subject","content"]}}]}},"\/messaging\/messages\/email\/{messageId}":{"patch":{"summary":"Update email","operationId":"messagingUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateEmail","weight":389,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":null,"x-example":false},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":null,"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":null,"x-example":null,"items":{"type":"string"}},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":null,"items":{"type":"string"}}}}}]}},"\/messaging\/messages\/push":{"post":{"summary":"Create push notification","operationId":"messagingCreatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new push notification.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createPush","weight":384,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":"","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":"","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web Platform.","default":"","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and IOS Platform.","default":"","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android Platform.","default":"","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android Platform.","default":"","x-example":"<TAG>"},"badge":{"type":"string","description":"Badge for push notification. Available only for IOS Platform.","default":"","x-example":"<BADGE>"},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","title","body"]}}]}},"\/messaging\/messages\/push\/{messageId}":{"patch":{"summary":"Update push notification","operationId":"messagingUpdatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a push notification by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updatePush","weight":391,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":null,"x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web platforms.","default":null,"x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and iOS platforms.","default":null,"x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android platforms.","default":null,"x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android platforms.","default":null,"x-example":"<TAG>"},"badge":{"type":"integer","description":"Badge for push notification. Available only for iOS platforms.","default":null,"x-example":null},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/sms":{"post":{"summary":"Create SMS","operationId":"messagingCreateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMS message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createSms","weight":383,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"content":{"type":"string","description":"SMS Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","content"]}}]}},"\/messaging\/messages\/sms\/{messageId}":{"patch":{"summary":"Update SMS","operationId":"messagingUpdateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateSms","weight":390,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/{messageId}":{"get":{"summary":"Get message","operationId":"messagingGetMessage","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"getMessage","weight":388,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-message.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]},"delete":{"summary":"Delete message","operationId":"messagingDelete","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":392,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]}},"\/messaging\/messages\/{messageId}\/logs":{"get":{"summary":"List message logs","operationId":"messagingListMessageLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the message activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listMessageLogs","weight":386,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-message-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/messages\/{messageId}\/targets":{"get":{"summary":"List message targets","operationId":"messagingListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of the targets associated with a message.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":387,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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, providerId, identifier, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/providers":{"get":{"summary":"List providers","operationId":"messagingListProviders","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all providers from the current Appwrite project.","responses":{"200":{"description":"Provider list","schema":{"$ref":"#\/definitions\/providerList"}}},"x-appwrite":{"method":"listProviders","weight":357,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-providers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/providers\/apns":{"post":{"summary":"Create APNS provider","operationId":"messagingCreateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Apple Push Notification service provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createApnsProvider","weight":356,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/apns\/{providerId}":{"patch":{"summary":"Update APNS provider","operationId":"messagingUpdateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Apple Push Notification service provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateApnsProvider","weight":369,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/fcm":{"post":{"summary":"Create FCM provider","operationId":"messagingCreateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Firebase Cloud Messaging provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createFcmProvider","weight":355,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/fcm\/{providerId}":{"patch":{"summary":"Update FCM provider","operationId":"messagingUpdateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Firebase Cloud Messaging provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateFcmProvider","weight":368,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"}}}}]}},"\/messaging\/providers\/mailgun":{"post":{"summary":"Create Mailgun provider","operationId":"messagingCreateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Mailgun provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMailgunProvider","weight":347,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/mailgun\/{providerId}":{"patch":{"summary":"Update Mailgun provider","operationId":"messagingUpdateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Mailgun provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMailgunProvider","weight":360,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/msg91":{"post":{"summary":"Create Msg91 provider","operationId":"messagingCreateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new MSG91 provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMsg91Provider","weight":350,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"templateId":{"type":"string","description":"Msg91 template ID","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/msg91\/{providerId}":{"patch":{"summary":"Update Msg91 provider","operationId":"messagingUpdateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a MSG91 provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMsg91Provider","weight":363,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"templateId":{"type":"string","description":"Msg91 template ID.","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"}}}}]}},"\/messaging\/providers\/sendgrid":{"post":{"summary":"Create Sendgrid provider","operationId":"messagingCreateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Sendgrid provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSendgridProvider","weight":348,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/sendgrid\/{providerId}":{"patch":{"summary":"Update Sendgrid provider","operationId":"messagingUpdateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Sendgrid provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSendgridProvider","weight":361,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/smtp":{"post":{"summary":"Create SMTP provider","operationId":"messagingCreateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMTP provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSmtpProvider","weight":349,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":null,"x-example":"<HOST>"},"port":{"type":"integer","description":"The default SMTP server port.","default":587,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be omitted, 'ssl', or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":true,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name","host"]}}]}},"\/messaging\/providers\/smtp\/{providerId}":{"patch":{"summary":"Update SMTP provider","operationId":"messagingUpdateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a SMTP provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSmtpProvider","weight":362,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":"","x-example":"<HOST>"},"port":{"type":"integer","description":"SMTP port.","default":null,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be 'ssl' or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":null,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/telesign":{"post":{"summary":"Create Telesign provider","operationId":"messagingCreateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Telesign provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTelesignProvider","weight":351,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/telesign\/{providerId}":{"patch":{"summary":"Update Telesign provider","operationId":"messagingUpdateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Telesign provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTelesignProvider","weight":364,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/textmagic":{"post":{"summary":"Create Textmagic provider","operationId":"messagingCreateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Textmagic provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTextmagicProvider","weight":352,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/textmagic\/{providerId}":{"patch":{"summary":"Update Textmagic provider","operationId":"messagingUpdateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Textmagic provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTextmagicProvider","weight":365,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/twilio":{"post":{"summary":"Create Twilio provider","operationId":"messagingCreateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Twilio provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTwilioProvider","weight":353,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/twilio\/{providerId}":{"patch":{"summary":"Update Twilio provider","operationId":"messagingUpdateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Twilio provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTwilioProvider","weight":366,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/vonage":{"post":{"summary":"Create Vonage provider","operationId":"messagingCreateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Vonage provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createVonageProvider","weight":354,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/vonage\/{providerId}":{"patch":{"summary":"Update Vonage provider","operationId":"messagingUpdateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Vonage provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateVonageProvider","weight":367,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/{providerId}":{"get":{"summary":"Get provider","operationId":"messagingGetProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a provider by its unique ID.\n","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"getProvider","weight":359,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]},"delete":{"summary":"Delete provider","operationId":"messagingDeleteProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a provider by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteProvider","weight":370,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]}},"\/messaging\/providers\/{providerId}\/logs":{"get":{"summary":"List provider logs","operationId":"messagingListProviderLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the provider activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listProviderLogs","weight":358,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-provider-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/subscribers\/{subscriberId}\/logs":{"get":{"summary":"List subscriber logs","operationId":"messagingListSubscriberLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the subscriber activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listSubscriberLogs","weight":379,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscriber-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics":{"get":{"summary":"List topics","operationId":"messagingListTopics","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all topics from the current Appwrite project.","responses":{"200":{"description":"Topic list","schema":{"$ref":"#\/definitions\/topicList"}}},"x-appwrite":{"method":"listTopics","weight":372,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topics.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, description, emailTotal, smsTotal, pushTotal","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create topic","operationId":"messagingCreateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new topic.","responses":{"201":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"createTopic","weight":371,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"topicId":{"type":"string","description":"Topic ID. Choose a custom Topic ID or a new Topic ID.","default":null,"x-example":"<TOPIC_ID>"},"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":["users"],"x-example":"[\"any\"]","items":{"type":"string"}}},"required":["topicId","name"]}}]}},"\/messaging\/topics\/{topicId}":{"get":{"summary":"Get topic","operationId":"messagingGetTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"getTopic","weight":374,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]},"patch":{"summary":"Update topic","operationId":"messagingUpdateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"updateTopic","weight":375,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":null,"x-example":"[\"any\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete topic","operationId":"messagingDeleteTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a topic by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTopic","weight":376,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]}},"\/messaging\/topics\/{topicId}\/logs":{"get":{"summary":"List topic logs","operationId":"messagingListTopicLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the topic activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listTopicLogs","weight":373,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topic-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"get":{"summary":"List subscribers","operationId":"messagingListSubscribers","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all subscribers from the current Appwrite project.","responses":{"200":{"description":"Subscriber list","schema":{"$ref":"#\/definitions\/subscriberList"}}},"x-appwrite":{"method":"listSubscribers","weight":378,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscribers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","default":null,"x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","default":null,"x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}]}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"get":{"summary":"Get subscriber","operationId":"messagingGetSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a subscriber by its unique ID.\n","responses":{"200":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"getSubscriber","weight":380,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]},"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]}},"\/migrations":{"get":{"summary":"List Migrations","operationId":"migrationsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migrations List","schema":{"$ref":"#\/definitions\/migrationList"}}},"x-appwrite":{"method":"list","weight":334,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/list-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, resources, statusCounters, resourceData, errors","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/migrations\/appwrite":{"post":{"summary":"Migrate Appwrite Data","operationId":"migrationsCreateAppwriteMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createAppwriteMigration","weight":329,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-appwrite-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"endpoint":{"type":"string","description":"Source's Appwrite Endpoint","default":null,"x-example":"https:\/\/example.com"},"projectId":{"type":"string","description":"Source's Project ID","default":null,"x-example":"<PROJECT_ID>"},"apiKey":{"type":"string","description":"Source's API Key","default":null,"x-example":"<API_KEY>"}},"required":["resources","endpoint","projectId","apiKey"]}}]}},"\/migrations\/appwrite\/report":{"get":{"summary":"Generate a report on Appwrite Data","operationId":"migrationsGetAppwriteReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getAppwriteReport","weight":336,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-appwrite-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"endpoint","description":"Source's Appwrite Endpoint","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"projectID","description":"Source's Project ID","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"query"},{"name":"key","description":"Source's API Key","required":true,"type":"string","x-example":"<KEY>","in":"query"}]}},"\/migrations\/firebase":{"post":{"summary":"Migrate Firebase Data (Service Account)","operationId":"migrationsCreateFirebaseMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createFirebaseMigration","weight":331,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-firebase-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"serviceAccount":{"type":"string","description":"JSON of the Firebase service account credentials","default":null,"x-example":"<SERVICE_ACCOUNT>"}},"required":["resources","serviceAccount"]}}]}},"\/migrations\/firebase\/deauthorize":{"get":{"summary":"Revoke Appwrite's authorization to access Firebase Projects","operationId":"migrationsDeleteFirebaseAuth","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"deleteFirebaseAuth","weight":342,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/delete-firebase-auth.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/migrations\/firebase\/oauth":{"post":{"summary":"Migrate Firebase Data (OAuth)","operationId":"migrationsCreateFirebaseOAuthMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createFirebaseOAuthMigration","weight":330,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-firebase-o-auth-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"projectId":{"type":"string","description":"Project ID of the Firebase Project","default":null,"x-example":"<PROJECT_ID>"}},"required":["resources","projectId"]}}]}},"\/migrations\/firebase\/projects":{"get":{"summary":"List Firebase Projects","operationId":"migrationsListFirebaseProjects","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migrations Firebase Projects List","schema":{"$ref":"#\/definitions\/firebaseProjectList"}}},"x-appwrite":{"method":"listFirebaseProjects","weight":341,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/list-firebase-projects.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/migrations\/firebase\/report":{"get":{"summary":"Generate a report on Firebase Data","operationId":"migrationsGetFirebaseReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getFirebaseReport","weight":337,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-firebase-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"serviceAccount","description":"JSON of the Firebase service account credentials","required":true,"type":"string","x-example":"<SERVICE_ACCOUNT>","in":"query"}]}},"\/migrations\/firebase\/report\/oauth":{"get":{"summary":"Generate a report on Firebase Data using OAuth","operationId":"migrationsGetFirebaseReportOAuth","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getFirebaseReportOAuth","weight":338,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-firebase-report-o-auth.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"projectId","description":"Project ID","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"query"}]}},"\/migrations\/nhost":{"post":{"summary":"Migrate NHost Data","operationId":"migrationsCreateNHostMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createNHostMigration","weight":333,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-n-host-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"subdomain":{"type":"string","description":"Source's Subdomain","default":null,"x-example":"<SUBDOMAIN>"},"region":{"type":"string","description":"Source's Region","default":null,"x-example":"<REGION>"},"adminSecret":{"type":"string","description":"Source's Admin Secret","default":null,"x-example":"<ADMIN_SECRET>"},"database":{"type":"string","description":"Source's Database Name","default":null,"x-example":"<DATABASE>"},"username":{"type":"string","description":"Source's Database Username","default":null,"x-example":"<USERNAME>"},"password":{"type":"string","description":"Source's Database Password","default":null,"x-example":"<PASSWORD>"},"port":{"type":"integer","description":"Source's Database Port","default":5432,"x-example":null}},"required":["resources","subdomain","region","adminSecret","database","username","password"]}}]}},"\/migrations\/nhost\/report":{"get":{"summary":"Generate a report on NHost Data","operationId":"migrationsGetNHostReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getNHostReport","weight":344,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-n-host-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate.","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"subdomain","description":"Source's Subdomain.","required":true,"type":"string","x-example":"<SUBDOMAIN>","in":"query"},{"name":"region","description":"Source's Region.","required":true,"type":"string","x-example":"<REGION>","in":"query"},{"name":"adminSecret","description":"Source's Admin Secret.","required":true,"type":"string","x-example":"<ADMIN_SECRET>","in":"query"},{"name":"database","description":"Source's Database Name.","required":true,"type":"string","x-example":"<DATABASE>","in":"query"},{"name":"username","description":"Source's Database Username.","required":true,"type":"string","x-example":"<USERNAME>","in":"query"},{"name":"password","description":"Source's Database Password.","required":true,"type":"string","x-example":"<PASSWORD>","in":"query"},{"name":"port","description":"Source's Database Port.","required":false,"type":"integer","format":"int32","default":5432,"in":"query"}]}},"\/migrations\/supabase":{"post":{"summary":"Migrate Supabase Data","operationId":"migrationsCreateSupabaseMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createSupabaseMigration","weight":332,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-supabase-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"endpoint":{"type":"string","description":"Source's Supabase Endpoint","default":null,"x-example":"https:\/\/example.com"},"apiKey":{"type":"string","description":"Source's API Key","default":null,"x-example":"<API_KEY>"},"databaseHost":{"type":"string","description":"Source's Database Host","default":null,"x-example":"<DATABASE_HOST>"},"username":{"type":"string","description":"Source's Database Username","default":null,"x-example":"<USERNAME>"},"password":{"type":"string","description":"Source's Database Password","default":null,"x-example":"<PASSWORD>"},"port":{"type":"integer","description":"Source's Database Port","default":5432,"x-example":null}},"required":["resources","endpoint","apiKey","databaseHost","username","password"]}}]}},"\/migrations\/supabase\/report":{"get":{"summary":"Generate a report on Supabase Data","operationId":"migrationsGetSupabaseReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getSupabaseReport","weight":343,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-supabase-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"endpoint","description":"Source's Supabase Endpoint.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"apiKey","description":"Source's API Key.","required":true,"type":"string","x-example":"<API_KEY>","in":"query"},{"name":"databaseHost","description":"Source's Database Host.","required":true,"type":"string","x-example":"<DATABASE_HOST>","in":"query"},{"name":"username","description":"Source's Database Username.","required":true,"type":"string","x-example":"<USERNAME>","in":"query"},{"name":"password","description":"Source's Database Password.","required":true,"type":"string","x-example":"<PASSWORD>","in":"query"},{"name":"port","description":"Source's Database Port.","required":false,"type":"integer","format":"int32","default":5432,"in":"query"}]}},"\/migrations\/{migrationId}":{"get":{"summary":"Get Migration","operationId":"migrationsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"get","weight":335,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/get-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration unique ID.","required":true,"type":"string","x-example":"<MIGRATION_ID>","in":"path"}]},"patch":{"summary":"Retry Migration","operationId":"migrationsRetry","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"retry","weight":345,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/retry.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/retry-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration unique ID.","required":true,"type":"string","x-example":"<MIGRATION_ID>","in":"path"}]},"delete":{"summary":"Delete Migration","operationId":"migrationsDelete","consumes":["application\/json"],"produces":[],"tags":["migrations"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":346,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/delete-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration ID.","required":true,"type":"string","x-example":"<MIGRATION_ID>","in":"path"}]}},"\/project\/usage":{"get":{"summary":"Get project usage stats","operationId":"projectGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"","responses":{"200":{"description":"UsageProject","schema":{"$ref":"#\/definitions\/usageProject"}}},"x-appwrite":{"method":"getUsage","weight":194,"cookies":false,"type":"","deprecated":false,"demo":"project\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"startDate","description":"Starting date for the usage","required":true,"type":"string","in":"query"},{"name":"endDate","description":"End date for the usage","required":true,"type":"string","in":"query"},{"name":"period","description":"Period used","required":false,"type":"string","x-example":"1h","enum":["1h","1d"],"x-enum-name":"ProjectUsageRange","x-enum-keys":["One Hour","One Day"],"default":"1d","in":"query"}]}},"\/project\/variables":{"get":{"summary":"List Variables","operationId":"projectListVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Get a list of all project variables. These variables will be accessible in all Appwrite Functions at runtime.","responses":{"200":{"description":"Variables List","schema":{"$ref":"#\/definitions\/variableList"}}},"x-appwrite":{"method":"listVariables","weight":196,"cookies":false,"type":"","deprecated":false,"demo":"project\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]},"post":{"summary":"Create Variable","operationId":"projectCreateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.","responses":{"201":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"createVariable","weight":195,"cookies":false,"type":"","deprecated":false,"demo":"project\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key","value"]}}]}},"\/project\/variables\/{variableId}":{"get":{"summary":"Get Variable","operationId":"projectGetVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Get a project variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"getVariable","weight":197,"cookies":false,"type":"","deprecated":false,"demo":"project\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]},"put":{"summary":"Update Variable","operationId":"projectUpdateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"updateVariable","weight":198,"cookies":false,"type":"","deprecated":false,"demo":"project\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key"]}}]},"delete":{"summary":"Delete Variable","operationId":"projectDeleteVariable","consumes":["application\/json"],"produces":[],"tags":["project"],"description":"Delete a project variable by its unique ID. ","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":199,"cookies":false,"type":"","deprecated":false,"demo":"project\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]}},"\/projects":{"get":{"summary":"List projects","operationId":"projectsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Projects List","schema":{"$ref":"#\/definitions\/projectList"}}},"x-appwrite":{"method":"list","weight":150,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"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: name, teamId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create project","operationId":"projectsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"create","weight":149,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"projectId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":null},"name":{"type":"string","description":"Project name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"teamId":{"type":"string","description":"Team unique ID.","default":null,"x-example":"<TEAM_ID>"},"region":{"type":"string","description":"Project Region.","default":"default","x-example":"default","enum":["default","fra"],"x-enum-name":null,"x-enum-keys":[]},"description":{"type":"string","description":"Project description. Max length: 256 chars.","default":"","x-example":"<DESCRIPTION>"},"logo":{"type":"string","description":"Project logo.","default":"","x-example":"<LOGO>"},"url":{"type":"string","description":"Project URL.","default":"","x-example":"https:\/\/example.com"},"legalName":{"type":"string","description":"Project legal Name. Max length: 256 chars.","default":"","x-example":"<LEGAL_NAME>"},"legalCountry":{"type":"string","description":"Project legal Country. Max length: 256 chars.","default":"","x-example":"<LEGAL_COUNTRY>"},"legalState":{"type":"string","description":"Project legal State. Max length: 256 chars.","default":"","x-example":"<LEGAL_STATE>"},"legalCity":{"type":"string","description":"Project legal City. Max length: 256 chars.","default":"","x-example":"<LEGAL_CITY>"},"legalAddress":{"type":"string","description":"Project legal Address. Max length: 256 chars.","default":"","x-example":"<LEGAL_ADDRESS>"},"legalTaxId":{"type":"string","description":"Project legal Tax ID. Max length: 256 chars.","default":"","x-example":"<LEGAL_TAX_ID>"}},"required":["projectId","name","teamId"]}}]}},"\/projects\/{projectId}":{"get":{"summary":"Get project","operationId":"projectsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"get","weight":151,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"patch":{"summary":"Update project","operationId":"projectsUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"update","weight":152,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Project name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"description":{"type":"string","description":"Project description. Max length: 256 chars.","default":"","x-example":"<DESCRIPTION>"},"logo":{"type":"string","description":"Project logo.","default":"","x-example":"<LOGO>"},"url":{"type":"string","description":"Project URL.","default":"","x-example":"https:\/\/example.com"},"legalName":{"type":"string","description":"Project legal name. Max length: 256 chars.","default":"","x-example":"<LEGAL_NAME>"},"legalCountry":{"type":"string","description":"Project legal country. Max length: 256 chars.","default":"","x-example":"<LEGAL_COUNTRY>"},"legalState":{"type":"string","description":"Project legal state. Max length: 256 chars.","default":"","x-example":"<LEGAL_STATE>"},"legalCity":{"type":"string","description":"Project legal city. Max length: 256 chars.","default":"","x-example":"<LEGAL_CITY>"},"legalAddress":{"type":"string","description":"Project legal address. Max length: 256 chars.","default":"","x-example":"<LEGAL_ADDRESS>"},"legalTaxId":{"type":"string","description":"Project legal tax ID. Max length: 256 chars.","default":"","x-example":"<LEGAL_TAX_ID>"}},"required":["name"]}}]},"delete":{"summary":"Delete project","operationId":"projectsDelete","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":168,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]}},"\/projects\/{projectId}\/api":{"patch":{"summary":"Update API status","operationId":"projectsUpdateApiStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateApiStatus","weight":156,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-api-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"api":{"type":"string","description":"API name.","default":null,"x-example":"rest","enum":["rest","graphql","realtime"],"x-enum-name":null,"x-enum-keys":[]},"status":{"type":"boolean","description":"API status.","default":null,"x-example":false}},"required":["api","status"]}}]}},"\/projects\/{projectId}\/api\/all":{"patch":{"summary":"Update all API status","operationId":"projectsUpdateApiStatusAll","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateApiStatusAll","weight":157,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-api-status-all.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"API status.","default":null,"x-example":false}},"required":["status"]}}]}},"\/projects\/{projectId}\/auth\/duration":{"patch":{"summary":"Update project authentication duration","operationId":"projectsUpdateAuthDuration","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthDuration","weight":161,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-duration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"duration":{"type":"integer","description":"Project session length in seconds. Max length: 31536000 seconds.","default":null,"x-example":0}},"required":["duration"]}}]}},"\/projects\/{projectId}\/auth\/limit":{"patch":{"summary":"Update project users limit","operationId":"projectsUpdateAuthLimit","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthLimit","weight":160,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-limit.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of users allowed in this project. Use 0 for unlimited.","default":null,"x-example":0}},"required":["limit"]}}]}},"\/projects\/{projectId}\/auth\/max-sessions":{"patch":{"summary":"Update project user sessions limit","operationId":"projectsUpdateAuthSessionsLimit","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthSessionsLimit","weight":166,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-sessions-limit.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10","default":null,"x-example":1}},"required":["limit"]}}]}},"\/projects\/{projectId}\/auth\/mock-numbers":{"patch":{"summary":"Update the mock numbers for the project","operationId":"projectsUpdateMockNumbers","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateMockNumbers","weight":167,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-mock-numbers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"numbers":{"type":"array","description":"An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.","default":null,"x-example":null,"items":{"type":"object"}}},"required":["numbers"]}}]}},"\/projects\/{projectId}\/auth\/password-dictionary":{"patch":{"summary":"Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password","operationId":"projectsUpdateAuthPasswordDictionary","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthPasswordDictionary","weight":164,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-password-dictionary.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Set whether or not to enable checking user's password against most commonly used passwords. Default is false.","default":null,"x-example":false}},"required":["enabled"]}}]}},"\/projects\/{projectId}\/auth\/password-history":{"patch":{"summary":"Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.","operationId":"projectsUpdateAuthPasswordHistory","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthPasswordHistory","weight":163,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-password-history.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0","default":null,"x-example":0}},"required":["limit"]}}]}},"\/projects\/{projectId}\/auth\/personal-data":{"patch":{"summary":"Enable or disable checking user passwords for similarity with their personal data.","operationId":"projectsUpdatePersonalDataCheck","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updatePersonalDataCheck","weight":165,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-personal-data-check.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Set whether or not to check a password for similarity with personal data. Default is false.","default":null,"x-example":false}},"required":["enabled"]}}]}},"\/projects\/{projectId}\/auth\/session-alerts":{"patch":{"summary":"Update project sessions emails","operationId":"projectsUpdateSessionAlerts","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateSessionAlerts","weight":159,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-session-alerts.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"alerts":{"type":"boolean","description":"Set to true to enable session emails.","default":null,"x-example":false}},"required":["alerts"]}}]}},"\/projects\/{projectId}\/auth\/{method}":{"patch":{"summary":"Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.","operationId":"projectsUpdateAuthStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthStatus","weight":162,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"method","description":"Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone","required":true,"type":"string","x-example":"email-password","enum":["email-password","magic-url","email-otp","anonymous","invites","jwt","phone"],"x-enum-name":"AuthMethod","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"Set the status of this auth method.","default":null,"x-example":false}},"required":["status"]}}]}},"\/projects\/{projectId}\/jwts":{"post":{"summary":"Create JWT","operationId":"projectsCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":180,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"scopes":{"type":"array","description":"List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","default":900,"x-example":0}},"required":["scopes"]}}]}},"\/projects\/{projectId}\/keys":{"get":{"summary":"List keys","operationId":"projectsListKeys","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"API Keys List","schema":{"$ref":"#\/definitions\/keyList"}}},"x-appwrite":{"method":"listKeys","weight":176,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-keys.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"post":{"summary":"Create key","operationId":"projectsCreateKey","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Key","schema":{"$ref":"#\/definitions\/key"}}},"x-appwrite":{"method":"createKey","weight":175,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Key name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"scopes":{"type":"array","description":"Key scopes list. Maximum of 100 scopes are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"expire":{"type":"string","description":"Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.","default":null,"x-example":null}},"required":["name","scopes"]}}]}},"\/projects\/{projectId}\/keys\/{keyId}":{"get":{"summary":"Get key","operationId":"projectsGetKey","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Key","schema":{"$ref":"#\/definitions\/key"}}},"x-appwrite":{"method":"getKey","weight":177,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"type":"string","x-example":"<KEY_ID>","in":"path"}]},"put":{"summary":"Update key","operationId":"projectsUpdateKey","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Key","schema":{"$ref":"#\/definitions\/key"}}},"x-appwrite":{"method":"updateKey","weight":178,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"type":"string","x-example":"<KEY_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Key name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"scopes":{"type":"array","description":"Key scopes list. Maximum of 100 events are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"expire":{"type":"string","description":"Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.","default":null,"x-example":null}},"required":["name","scopes"]}}]},"delete":{"summary":"Delete key","operationId":"projectsDeleteKey","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteKey","weight":179,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"type":"string","x-example":"<KEY_ID>","in":"path"}]}},"\/projects\/{projectId}\/oauth2":{"patch":{"summary":"Update project OAuth2","operationId":"projectsUpdateOAuth2","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateOAuth2","weight":158,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-o-auth2.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"provider":{"type":"string","description":"Provider Name","default":null,"x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"appId":{"type":"string","description":"Provider app ID. Max length: 256 chars.","default":null,"x-example":"<APP_ID>"},"secret":{"type":"string","description":"Provider secret key. Max length: 512 chars.","default":null,"x-example":"<SECRET>"},"enabled":{"type":"boolean","description":"Provider status. Set to 'false' to disable new session creation.","default":null,"x-example":false}},"required":["provider"]}}]}},"\/projects\/{projectId}\/platforms":{"get":{"summary":"List platforms","operationId":"projectsListPlatforms","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Platforms List","schema":{"$ref":"#\/definitions\/platformList"}}},"x-appwrite":{"method":"listPlatforms","weight":182,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-platforms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"post":{"summary":"Create platform","operationId":"projectsCreatePlatform","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Platform","schema":{"$ref":"#\/definitions\/platform"}}},"x-appwrite":{"method":"createPlatform","weight":181,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"type":{"type":"string","description":"Platform type.","default":null,"x-example":"web","enum":["web","flutter-web","flutter-ios","flutter-android","flutter-linux","flutter-macos","flutter-windows","apple-ios","apple-macos","apple-watchos","apple-tvos","android","unity"],"x-enum-name":"PlatformType","x-enum-keys":[]},"name":{"type":"string","description":"Platform name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"key":{"type":"string","description":"Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.","default":"","x-example":"<KEY>"},"store":{"type":"string","description":"App store or Google Play store ID. Max length: 256 chars.","default":"","x-example":"<STORE>"},"hostname":{"type":"string","description":"Platform client hostname. Max length: 256 chars.","default":"","x-example":null}},"required":["type","name"]}}]}},"\/projects\/{projectId}\/platforms\/{platformId}":{"get":{"summary":"Get platform","operationId":"projectsGetPlatform","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Platform","schema":{"$ref":"#\/definitions\/platform"}}},"x-appwrite":{"method":"getPlatform","weight":183,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"type":"string","x-example":"<PLATFORM_ID>","in":"path"}]},"put":{"summary":"Update platform","operationId":"projectsUpdatePlatform","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Platform","schema":{"$ref":"#\/definitions\/platform"}}},"x-appwrite":{"method":"updatePlatform","weight":184,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"type":"string","x-example":"<PLATFORM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Platform name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"key":{"type":"string","description":"Package name for android or bundle ID for iOS. Max length: 256 chars.","default":"","x-example":"<KEY>"},"store":{"type":"string","description":"App store or Google Play store ID. Max length: 256 chars.","default":"","x-example":"<STORE>"},"hostname":{"type":"string","description":"Platform client URL. Max length: 256 chars.","default":"","x-example":null}},"required":["name"]}}]},"delete":{"summary":"Delete platform","operationId":"projectsDeletePlatform","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deletePlatform","weight":185,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"type":"string","x-example":"<PLATFORM_ID>","in":"path"}]}},"\/projects\/{projectId}\/service":{"patch":{"summary":"Update service status","operationId":"projectsUpdateServiceStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateServiceStatus","weight":154,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-service-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"service":{"type":"string","description":"Service name.","default":null,"x-example":"account","enum":["account","avatars","databases","locale","health","storage","teams","users","functions","graphql","messaging"],"x-enum-name":"ApiService","x-enum-keys":[]},"status":{"type":"boolean","description":"Service status.","default":null,"x-example":false}},"required":["service","status"]}}]}},"\/projects\/{projectId}\/service\/all":{"patch":{"summary":"Update all service status","operationId":"projectsUpdateServiceStatusAll","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateServiceStatusAll","weight":155,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-service-status-all.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"Service status.","default":null,"x-example":false}},"required":["status"]}}]}},"\/projects\/{projectId}\/smtp":{"patch":{"summary":"Update SMTP","operationId":"projectsUpdateSmtp","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateSmtp","weight":186,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-smtp.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable custom SMTP service","default":null,"x-example":false},"senderName":{"type":"string","description":"Name of the email sender","default":"","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","default":"","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","default":"","x-example":"email@example.com"},"host":{"type":"string","description":"SMTP server host name","default":"","x-example":null},"port":{"type":"integer","description":"SMTP server port","default":587,"x-example":null},"username":{"type":"string","description":"SMTP server username","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"SMTP server password","default":"","x-example":"<PASSWORD>"},"secure":{"type":"string","description":"Does SMTP server use secure connection","default":"","x-example":"tls","enum":["tls","ssl"],"x-enum-name":"SMTPSecure","x-enum-keys":[]}},"required":["enabled"]}}]}},"\/projects\/{projectId}\/smtp\/tests":{"post":{"summary":"Create SMTP test","operationId":"projectsCreateSmtpTest","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createSmtpTest","weight":187,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-smtp-test.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"emails":{"type":"array","description":"Array of emails to send test email to. Maximum of 10 emails are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"senderName":{"type":"string","description":"Name of the email sender","default":null,"x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","default":null,"x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","default":"","x-example":"email@example.com"},"host":{"type":"string","description":"SMTP server host name","default":null,"x-example":null},"port":{"type":"integer","description":"SMTP server port","default":587,"x-example":null},"username":{"type":"string","description":"SMTP server username","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"SMTP server password","default":"","x-example":"<PASSWORD>"},"secure":{"type":"string","description":"Does SMTP server use secure connection","default":"","x-example":"tls","enum":["tls"],"x-enum-name":"SMTPSecure","x-enum-keys":[]}},"required":["emails","senderName","senderEmail","host"]}}]}},"\/projects\/{projectId}\/team":{"patch":{"summary":"Update project team","operationId":"projectsUpdateTeam","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateTeam","weight":153,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-team.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID of the team to transfer project to.","default":null,"x-example":"<TEAM_ID>"}},"required":["teamId"]}}]}},"\/projects\/{projectId}\/templates\/email\/{type}\/{locale}":{"get":{"summary":"Get custom email template","operationId":"projectsGetEmailTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"EmailTemplate","schema":{"$ref":"#\/definitions\/emailTemplate"}}},"x-appwrite":{"method":"getEmailTemplate","weight":189,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[],"in":"path"}]},"patch":{"summary":"Update custom email templates","operationId":"projectsUpdateEmailTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateEmailTemplate","weight":191,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subject":{"type":"string","description":"Email Subject","default":null,"x-example":"<SUBJECT>"},"message":{"type":"string","description":"Template message","default":null,"x-example":"<MESSAGE>"},"senderName":{"type":"string","description":"Name of the email sender","default":"","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","default":"","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","default":"","x-example":"email@example.com"}},"required":["subject","message"]}}]},"delete":{"summary":"Reset custom email template","operationId":"projectsDeleteEmailTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"EmailTemplate","schema":{"$ref":"#\/definitions\/emailTemplate"}}},"x-appwrite":{"method":"deleteEmailTemplate","weight":193,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[],"in":"path"}]}},"\/projects\/{projectId}\/templates\/sms\/{type}\/{locale}":{"get":{"summary":"Get custom SMS template","operationId":"projectsGetSmsTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","schema":{"$ref":"#\/definitions\/smsTemplate"}}},"x-appwrite":{"method":"getSmsTemplate","weight":188,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[],"in":"path"}]},"patch":{"summary":"Update custom SMS template","operationId":"projectsUpdateSmsTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","schema":{"$ref":"#\/definitions\/smsTemplate"}}},"x-appwrite":{"method":"updateSmsTemplate","weight":190,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"message":{"type":"string","description":"Template message","default":null,"x-example":"<MESSAGE>"}},"required":["message"]}}]},"delete":{"summary":"Reset custom SMS template","operationId":"projectsDeleteSmsTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","schema":{"$ref":"#\/definitions\/smsTemplate"}}},"x-appwrite":{"method":"deleteSmsTemplate","weight":192,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[],"in":"path"}]}},"\/projects\/{projectId}\/webhooks":{"get":{"summary":"List webhooks","operationId":"projectsListWebhooks","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhooks List","schema":{"$ref":"#\/definitions\/webhookList"}}},"x-appwrite":{"method":"listWebhooks","weight":170,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"post":{"summary":"Create webhook","operationId":"projectsCreateWebhook","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"createWebhook","weight":169,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Webhook name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Enable or disable a webhook.","default":true,"x-example":false},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"Webhook URL.","default":null,"x-example":null},"security":{"type":"boolean","description":"Certificate verification, false for disabled or true for enabled.","default":null,"x-example":false},"httpUser":{"type":"string","description":"Webhook HTTP user. Max length: 256 chars.","default":"","x-example":"<HTTP_USER>"},"httpPass":{"type":"string","description":"Webhook HTTP password. Max length: 256 chars.","default":"","x-example":"<HTTP_PASS>"}},"required":["name","events","url","security"]}}]}},"\/projects\/{projectId}\/webhooks\/{webhookId}":{"get":{"summary":"Get webhook","operationId":"projectsGetWebhook","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"getWebhook","weight":171,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"}]},"put":{"summary":"Update webhook","operationId":"projectsUpdateWebhook","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"updateWebhook","weight":172,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Webhook name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Enable or disable a webhook.","default":true,"x-example":false},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"Webhook URL.","default":null,"x-example":null},"security":{"type":"boolean","description":"Certificate verification, false for disabled or true for enabled.","default":null,"x-example":false},"httpUser":{"type":"string","description":"Webhook HTTP user. Max length: 256 chars.","default":"","x-example":"<HTTP_USER>"},"httpPass":{"type":"string","description":"Webhook HTTP password. Max length: 256 chars.","default":"","x-example":"<HTTP_PASS>"}},"required":["name","events","url","security"]}}]},"delete":{"summary":"Delete webhook","operationId":"projectsDeleteWebhook","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteWebhook","weight":174,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"}]}},"\/projects\/{projectId}\/webhooks\/{webhookId}\/signature":{"patch":{"summary":"Update webhook signature key","operationId":"projectsUpdateWebhookSignature","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"updateWebhookSignature","weight":173,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-webhook-signature.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"}]}},"\/proxy\/rules":{"get":{"summary":"List Rules","operationId":"proxyListRules","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"Get a list of all the proxy rules. You can use the query params to filter your results.","responses":{"200":{"description":"Rule List","schema":{"$ref":"#\/definitions\/proxyRuleList"}}},"x-appwrite":{"method":"listRules","weight":312,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/list-rules.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/list-rules.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, resourceType, resourceId, url","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create Rule","operationId":"proxyCreateRule","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"Create a new proxy rule.","responses":{"201":{"description":"Rule","schema":{"$ref":"#\/definitions\/proxyRule"}}},"x-appwrite":{"method":"createRule","weight":311,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/create-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/create-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"domain":{"type":"string","description":"Domain name.","default":null,"x-example":null},"resourceType":{"type":"string","description":"Action definition for the rule. Possible values are \"api\", \"function\"","default":null,"x-example":"api","enum":["api","function"],"x-enum-name":null,"x-enum-keys":[]},"resourceId":{"type":"string","description":"ID of resource for the action type. If resourceType is \"api\", leave empty. If resourceType is \"function\", provide ID of the function.","default":"","x-example":"<RESOURCE_ID>"}},"required":["domain","resourceType"]}}]}},"\/proxy\/rules\/{ruleId}":{"get":{"summary":"Get Rule","operationId":"proxyGetRule","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"Get a proxy rule by its unique ID.","responses":{"200":{"description":"Rule","schema":{"$ref":"#\/definitions\/proxyRule"}}},"x-appwrite":{"method":"getRule","weight":313,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/get-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/get-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"type":"string","x-example":"<RULE_ID>","in":"path"}]},"delete":{"summary":"Delete Rule","operationId":"proxyDeleteRule","consumes":["application\/json"],"produces":[],"tags":["proxy"],"description":"Delete a proxy rule by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteRule","weight":314,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/delete-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/delete-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"type":"string","x-example":"<RULE_ID>","in":"path"}]}},"\/proxy\/rules\/{ruleId}\/verification":{"patch":{"summary":"Update Rule Verification Status","operationId":"proxyUpdateRuleVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"","responses":{"200":{"description":"Rule","schema":{"$ref":"#\/definitions\/proxyRule"}}},"x-appwrite":{"method":"updateRuleVerification","weight":315,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/update-rule-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"type":"string","x-example":"<RULE_ID>","in":"path"}]}},"\/storage\/buckets":{"get":{"summary":"List buckets","operationId":"storageListBuckets","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the storage buckets. You can use the query params to filter your results.","responses":{"200":{"description":"Buckets List","schema":{"$ref":"#\/definitions\/bucketList"}}},"x-appwrite":{"method":"listBuckets","weight":201,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-buckets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create bucket","operationId":"storageCreateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new storage bucket.","responses":{"201":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"createBucket","weight":200,"cookies":false,"type":"","deprecated":false,"demo":"storage\/create-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"bucketId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<BUCKET_ID>"},"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["bucketId","name"]}}]}},"\/storage\/buckets\/{bucketId}":{"get":{"summary":"Get bucket","operationId":"storageGetBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"getBucket","weight":202,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]},"put":{"summary":"Update bucket","operationId":"storageUpdateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a storage bucket by its unique ID.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"updateBucket","weight":203,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete bucket","operationId":"storageDeleteBucket","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a storage bucket by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteBucket","weight":204,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","schema":{"$ref":"#\/definitions\/fileList"}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"x-upload-id":true,"type":"string","x-example":"<FILE_ID>","in":"formData"},{"name":"file","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","required":true,"type":"file","in":"formData"},{"name":"permissions","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"x-example":"[\"read(\"any\")\"]","in":"formData"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","consumes":["application\/json"],"produces":["image\/*"],"tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center","in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"type":"number","format":"float","x-example":0,"default":1,"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"type":"integer","format":"int32","x-example":-360,"default":0,"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":"","in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/usage":{"get":{"summary":"Get storage usage stats","operationId":"storageGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"","responses":{"200":{"description":"StorageUsage","schema":{"$ref":"#\/definitions\/usageStorage"}}},"x-appwrite":{"method":"getUsage","weight":214,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"StorageUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/storage\/{bucketId}\/usage":{"get":{"summary":"Get bucket usage stats","operationId":"storageGetBucketUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"","responses":{"200":{"description":"UsageBuckets","schema":{"$ref":"#\/definitions\/usageBuckets"}}},"x-appwrite":{"method":"getBucketUsage","weight":215,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"bucketId","description":"Bucket ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"StorageUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","schema":{"$ref":"#\/definitions\/teamList"}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":["owner"],"x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}]}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]},"delete":{"summary":"Delete team","operationId":"teamsDelete","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]}},"\/teams\/{teamId}\/logs":{"get":{"summary":"List team logs","operationId":"teamsListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":229,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","default":"","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","default":"","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","default":"","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["roles"]}}]}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["roles"]}}]},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users":{"get":{"summary":"List users","operationId":"usersList","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a list of all the project's users. You can use the query params to filter your results.","responses":{"200":{"description":"Users List","schema":{"$ref":"#\/definitions\/userList"}}},"x-appwrite":{"method":"list","weight":239,"cookies":false,"type":"","deprecated":false,"demo":"users\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create user","operationId":"usersCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":230,"cookies":false,"type":"","deprecated":false,"demo":"users\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"Plain text user password. Must be at least 8 chars.","default":"","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId"]}}]}},"\/users\/argon2":{"post":{"summary":"Create user with Argon2 password","operationId":"usersCreateArgon2User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createArgon2User","weight":233,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-argon2user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Argon2.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/bcrypt":{"post":{"summary":"Create user with bcrypt password","operationId":"usersCreateBcryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createBcryptUser","weight":231,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-bcrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Bcrypt.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/identities":{"get":{"summary":"List Identities","operationId":"usersListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get identities for all users.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":247,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/users\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"usersDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":270,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/users\/md5":{"post":{"summary":"Create user with MD5 password","operationId":"usersCreateMD5User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createMD5User","weight":232,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-m-d5user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using MD5.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/phpass":{"post":{"summary":"Create user with PHPass password","operationId":"usersCreatePHPassUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createPHPassUser","weight":235,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-p-h-pass-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using PHPass.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/scrypt":{"post":{"summary":"Create user with Scrypt password","operationId":"usersCreateScryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptUser","weight":236,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Optional salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordCpu":{"type":"integer","description":"Optional CPU cost used to hash password.","default":null,"x-example":null},"passwordMemory":{"type":"integer","description":"Optional memory cost used to hash password.","default":null,"x-example":null},"passwordParallel":{"type":"integer","description":"Optional parallelization cost used to hash password.","default":null,"x-example":null},"passwordLength":{"type":"integer","description":"Optional hash length used to hash password.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordCpu","passwordMemory","passwordParallel","passwordLength"]}}]}},"\/users\/scrypt-modified":{"post":{"summary":"Create user with Scrypt modified password","operationId":"usersCreateScryptModifiedUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptModifiedUser","weight":237,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-modified-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt Modified.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordSaltSeparator":{"type":"string","description":"Salt separator used to hash password.","default":null,"x-example":"<PASSWORD_SALT_SEPARATOR>"},"passwordSignerKey":{"type":"string","description":"Signer key used to hash password.","default":null,"x-example":"<PASSWORD_SIGNER_KEY>"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordSaltSeparator","passwordSignerKey"]}}]}},"\/users\/sha":{"post":{"summary":"Create user with SHA password","operationId":"usersCreateSHAUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createSHAUser","weight":234,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-s-h-a-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using SHA.","default":null,"x-example":"password"},"passwordVersion":{"type":"string","description":"Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'","default":"","x-example":"sha1","enum":["sha1","sha224","sha256","sha384","sha512\/224","sha512\/256","sha512","sha3-224","sha3-256","sha3-384","sha3-512"],"x-enum-name":"PasswordHash","x-enum-keys":[]},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/usage":{"get":{"summary":"Get users usage stats","operationId":"usersGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"","responses":{"200":{"description":"UsageUsers","schema":{"$ref":"#\/definitions\/usageUsers"}}},"x-appwrite":{"method":"getUsage","weight":272,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"UserUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/users\/{userId}":{"get":{"summary":"Get user","operationId":"usersGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":240,"cookies":false,"type":"","deprecated":false,"demo":"users\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user","operationId":"usersDelete","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":268,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/email":{"patch":{"summary":"Update email","operationId":"usersUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":253,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"}},"required":["email"]}}]}},"\/users\/{userId}\/jwts":{"post":{"summary":"Create user JWT","operationId":"usersCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":271,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.","default":"recent","x-example":"<SESSION_ID>"},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","default":900,"x-example":0}}}}]}},"\/users\/{userId}\/labels":{"put":{"summary":"Update user labels","operationId":"usersUpdateLabels","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateLabels","weight":249,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-labels.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"labels":{"type":"array","description":"Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["labels"]}}]}},"\/users\/{userId}\/logs":{"get":{"summary":"List user logs","operationId":"usersListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":245,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/users\/{userId}\/memberships":{"get":{"summary":"List user memberships","operationId":"usersListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user membership list by its unique ID.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":244,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa":{"patch":{"summary":"Update MFA","operationId":"usersUpdateMfa","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Enable or disable MFA on a user account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfa","weight":258,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/users\/{userId}\/mfa\/authenticators\/{type}":{"delete":{"summary":"Delete Authenticator","operationId":"usersDeleteMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete an authenticator app.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":263,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/users\/{userId}\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"usersListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":259,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"usersGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":260,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"put":{"summary":"Regenerate MFA Recovery Codes","operationId":"usersUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":262,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Create MFA Recovery Codes","operationId":"usersCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":261,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/name":{"patch":{"summary":"Update name","operationId":"usersUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user name by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":251,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/users\/{userId}\/password":{"patch":{"summary":"Update password","operationId":"usersUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user password by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":252,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null}},"required":["password"]}}]}},"\/users\/{userId}\/phone":{"patch":{"summary":"Update phone","operationId":"usersUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":254,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"number":{"type":"string","description":"User phone number.","default":null,"x-example":"+12065550100"}},"required":["number"]}}]}},"\/users\/{userId}\/prefs":{"get":{"summary":"Get user preferences","operationId":"usersGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user preferences by its unique ID.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":241,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Update user preferences","operationId":"usersUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user preferences by its unique ID. 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.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":256,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users\/{userId}\/sessions":{"get":{"summary":"List user sessions","operationId":"usersListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user sessions list by its unique ID.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":243,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"post":{"summary":"Create session","operationId":"usersCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":264,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user sessions","operationId":"usersDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete all user's sessions by using the user's unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":267,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/sessions\/{sessionId}":{"delete":{"summary":"Delete user session","operationId":"usersDeleteSession","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user sessions by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":266,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"sessionId","description":"Session ID.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/users\/{userId}\/status":{"patch":{"summary":"Update user status","operationId":"usersUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":248,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"User Status. To activate the user pass `true` and to block the user pass `false`.","default":null,"x-example":false}},"required":["status"]}}]}},"\/users\/{userId}\/targets":{"get":{"summary":"List User Targets","operationId":"usersListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the messaging targets that are associated with a user.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":246,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create User Target","operationId":"usersCreateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a messaging target.","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createTarget","weight":238,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","default":null,"x-example":"email","enum":["email","sms","push"],"x-enum-name":"MessagingProviderType","x-enum-keys":[]},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}},"required":["targetId","providerType","identifier"]}}]}},"\/users\/{userId}\/targets\/{targetId}":{"get":{"summary":"Get User Target","operationId":"usersGetTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user's push notification target by ID.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"getTarget","weight":242,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]},"patch":{"summary":"Update User target","operationId":"usersUpdateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update a messaging target.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updateTarget","weight":257,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":"","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}}}}]},"delete":{"summary":"Delete user target","operationId":"usersDeleteTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete a messaging target.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTarget","weight":269,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/users\/{userId}\/tokens":{"post":{"summary":"Create token","operationId":"usersCreateToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createToken","weight":265,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"length":{"type":"integer","description":"Token length in characters. The default length is 6 characters","default":6,"x-example":4},"expire":{"type":"integer","description":"Token expiration period in seconds. The default expiration is 15 minutes.","default":900,"x-example":60}}}}]}},"\/users\/{userId}\/verification":{"patch":{"summary":"Update email verification","operationId":"usersUpdateEmailVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmailVerification","weight":255,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"emailVerification":{"type":"boolean","description":"User email verification status.","default":null,"x-example":false}},"required":["emailVerification"]}}]}},"\/users\/{userId}\/verification\/phone":{"patch":{"summary":"Update phone verification","operationId":"usersUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":250,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"phoneVerification":{"type":"boolean","description":"User phone verification status.","default":null,"x-example":false}},"required":["phoneVerification"]}}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories":{"get":{"summary":"List Repositories","operationId":"vcsListRepositories","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Provider Repositories List","schema":{"$ref":"#\/definitions\/providerRepositoryList"}}},"x-appwrite":{"method":"listRepositories","weight":277,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-repositories.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create repository","operationId":"vcsCreateRepository","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"ProviderRepository","schema":{"$ref":"#\/definitions\/providerRepository"}}},"x-appwrite":{"method":"createRepository","weight":278,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/create-repository.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Repository name (slug)","default":null,"x-example":"<NAME>"},"private":{"type":"boolean","description":"Mark repository public or private","default":null,"x-example":false}},"required":["name","private"]}}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}":{"get":{"summary":"Get repository","operationId":"vcsGetRepository","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"ProviderRepository","schema":{"$ref":"#\/definitions\/providerRepository"}}},"x-appwrite":{"method":"getRepository","weight":279,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-repository.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/branches":{"get":{"summary":"List Repository Branches","operationId":"vcsListRepositoryBranches","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Branches List","schema":{"$ref":"#\/definitions\/branchList"}}},"x-appwrite":{"method":"listRepositoryBranches","weight":280,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-repository-branches.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/contents":{"get":{"summary":"Get files and directories of a VCS repository","operationId":"vcsGetRepositoryContents","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"VCS Content List","schema":{"$ref":"#\/definitions\/vcsContentList"}}},"x-appwrite":{"method":"getRepositoryContents","weight":275,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-repository-contents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"},{"name":"providerRootDirectory","description":"Path to get contents of nested directory","required":false,"type":"string","x-example":"<PROVIDER_ROOT_DIRECTORY>","default":"","in":"query"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/detection":{"post":{"summary":"Detect runtime settings from source code","operationId":"vcsCreateRepositoryDetection","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Detection","schema":{"$ref":"#\/definitions\/detection"}}},"x-appwrite":{"method":"createRepositoryDetection","weight":276,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/create-repository-detection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerRootDirectory":{"type":"string","description":"Path to Root Directory","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"}}}}]}},"\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}":{"patch":{"summary":"Authorize external deployment","operationId":"vcsUpdateExternalDeployments","consumes":["application\/json"],"produces":[],"tags":["vcs"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateExternalDeployments","weight":285,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/update-external-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"repositoryId","description":"VCS Repository Id","required":true,"type":"string","x-example":"<REPOSITORY_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerPullRequestId":{"type":"string","description":"GitHub Pull Request Id","default":null,"x-example":"<PROVIDER_PULL_REQUEST_ID>"}},"required":["providerPullRequestId"]}}]}},"\/vcs\/installations":{"get":{"summary":"List installations","operationId":"vcsListInstallations","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Installations List","schema":{"$ref":"#\/definitions\/installationList"}}},"x-appwrite":{"method":"listInstallations","weight":282,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-installations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-installations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"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: provider, organization","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/vcs\/installations\/{installationId}":{"get":{"summary":"Get installation","operationId":"vcsGetInstallation","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Installation","schema":{"$ref":"#\/definitions\/installation"}}},"x-appwrite":{"method":"getInstallation","weight":283,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-installation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-installation.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"}]},"delete":{"summary":"Delete Installation","operationId":"vcsDeleteInstallation","consumes":["application\/json"],"produces":[],"tags":["vcs"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteInstallation","weight":284,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/delete-installation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/delete-installation.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"}]}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"definitions":{"any":{"description":"Any","type":"object","additionalProperties":true},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"type":"object","$ref":"#\/definitions\/document"},"x-example":""}},"required":["total","documents"]},"collectionList":{"description":"Collections List","type":"object","properties":{"total":{"type":"integer","description":"Total number of collections documents that matched your query.","x-example":5,"format":"int32"},"collections":{"type":"array","description":"List of collections.","items":{"type":"object","$ref":"#\/definitions\/collection"},"x-example":""}},"required":["total","collections"]},"databaseList":{"description":"Databases List","type":"object","properties":{"total":{"type":"integer","description":"Total number of databases documents that matched your query.","x-example":5,"format":"int32"},"databases":{"type":"array","description":"List of databases.","items":{"type":"object","$ref":"#\/definitions\/database"},"x-example":""}},"required":["total","databases"]},"indexList":{"description":"Indexes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of indexes documents that matched your query.","x-example":5,"format":"int32"},"indexes":{"type":"array","description":"List of indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":""}},"required":["total","indexes"]},"userList":{"description":"Users List","type":"object","properties":{"total":{"type":"integer","description":"Total number of users documents that matched your query.","x-example":5,"format":"int32"},"users":{"type":"array","description":"List of users.","items":{"type":"object","$ref":"#\/definitions\/user"},"x-example":""}},"required":["total","users"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"type":"object","$ref":"#\/definitions\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"type":"object","$ref":"#\/definitions\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"type":"object","$ref":"#\/definitions\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"type":"object","$ref":"#\/definitions\/file"},"x-example":""}},"required":["total","files"]},"bucketList":{"description":"Buckets List","type":"object","properties":{"total":{"type":"integer","description":"Total number of buckets documents that matched your query.","x-example":5,"format":"int32"},"buckets":{"type":"array","description":"List of buckets.","items":{"type":"object","$ref":"#\/definitions\/bucket"},"x-example":""}},"required":["total","buckets"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"type":"object","$ref":"#\/definitions\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"type":"object","$ref":"#\/definitions\/membership"},"x-example":""}},"required":["total","memberships"]},"functionList":{"description":"Functions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of functions documents that matched your query.","x-example":5,"format":"int32"},"functions":{"type":"array","description":"List of functions.","items":{"type":"object","$ref":"#\/definitions\/function"},"x-example":""}},"required":["total","functions"]},"installationList":{"description":"Installations List","type":"object","properties":{"total":{"type":"integer","description":"Total number of installations documents that matched your query.","x-example":5,"format":"int32"},"installations":{"type":"array","description":"List of installations.","items":{"type":"object","$ref":"#\/definitions\/installation"},"x-example":""}},"required":["total","installations"]},"providerRepositoryList":{"description":"Provider Repositories List","type":"object","properties":{"total":{"type":"integer","description":"Total number of providerRepositories documents that matched your query.","x-example":5,"format":"int32"},"providerRepositories":{"type":"array","description":"List of providerRepositories.","items":{"type":"object","$ref":"#\/definitions\/providerRepository"},"x-example":""}},"required":["total","providerRepositories"]},"branchList":{"description":"Branches List","type":"object","properties":{"total":{"type":"integer","description":"Total number of branches documents that matched your query.","x-example":5,"format":"int32"},"branches":{"type":"array","description":"List of branches.","items":{"type":"object","$ref":"#\/definitions\/branch"},"x-example":""}},"required":["total","branches"]},"runtimeList":{"description":"Runtimes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of runtimes documents that matched your query.","x-example":5,"format":"int32"},"runtimes":{"type":"array","description":"List of runtimes.","items":{"type":"object","$ref":"#\/definitions\/runtime"},"x-example":""}},"required":["total","runtimes"]},"deploymentList":{"description":"Deployments List","type":"object","properties":{"total":{"type":"integer","description":"Total number of deployments documents that matched your query.","x-example":5,"format":"int32"},"deployments":{"type":"array","description":"List of deployments.","items":{"type":"object","$ref":"#\/definitions\/deployment"},"x-example":""}},"required":["total","deployments"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"type":"object","$ref":"#\/definitions\/execution"},"x-example":""}},"required":["total","executions"]},"projectList":{"description":"Projects List","type":"object","properties":{"total":{"type":"integer","description":"Total number of projects documents that matched your query.","x-example":5,"format":"int32"},"projects":{"type":"array","description":"List of projects.","items":{"type":"object","$ref":"#\/definitions\/project"},"x-example":""}},"required":["total","projects"]},"webhookList":{"description":"Webhooks List","type":"object","properties":{"total":{"type":"integer","description":"Total number of webhooks documents that matched your query.","x-example":5,"format":"int32"},"webhooks":{"type":"array","description":"List of webhooks.","items":{"type":"object","$ref":"#\/definitions\/webhook"},"x-example":""}},"required":["total","webhooks"]},"keyList":{"description":"API Keys List","type":"object","properties":{"total":{"type":"integer","description":"Total number of keys documents that matched your query.","x-example":5,"format":"int32"},"keys":{"type":"array","description":"List of keys.","items":{"type":"object","$ref":"#\/definitions\/key"},"x-example":""}},"required":["total","keys"]},"platformList":{"description":"Platforms List","type":"object","properties":{"total":{"type":"integer","description":"Total number of platforms documents that matched your query.","x-example":5,"format":"int32"},"platforms":{"type":"array","description":"List of platforms.","items":{"type":"object","$ref":"#\/definitions\/platform"},"x-example":""}},"required":["total","platforms"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"type":"object","$ref":"#\/definitions\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"type":"object","$ref":"#\/definitions\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"type":"object","$ref":"#\/definitions\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"type":"object","$ref":"#\/definitions\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"type":"object","$ref":"#\/definitions\/phone"},"x-example":""}},"required":["total","phones"]},"variableList":{"description":"Variables List","type":"object","properties":{"total":{"type":"integer","description":"Total number of variables documents that matched your query.","x-example":5,"format":"int32"},"variables":{"type":"array","description":"List of variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":""}},"required":["total","variables"]},"proxyRuleList":{"description":"Rule List","type":"object","properties":{"total":{"type":"integer","description":"Total number of rules documents that matched your query.","x-example":5,"format":"int32"},"rules":{"type":"array","description":"List of rules.","items":{"type":"object","$ref":"#\/definitions\/proxyRule"},"x-example":""}},"required":["total","rules"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"type":"object","$ref":"#\/definitions\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"providerList":{"description":"Provider list","type":"object","properties":{"total":{"type":"integer","description":"Total number of providers documents that matched your query.","x-example":5,"format":"int32"},"providers":{"type":"array","description":"List of providers.","items":{"type":"object","$ref":"#\/definitions\/provider"},"x-example":""}},"required":["total","providers"]},"messageList":{"description":"Message list","type":"object","properties":{"total":{"type":"integer","description":"Total number of messages documents that matched your query.","x-example":5,"format":"int32"},"messages":{"type":"array","description":"List of messages.","items":{"type":"object","$ref":"#\/definitions\/message"},"x-example":""}},"required":["total","messages"]},"topicList":{"description":"Topic list","type":"object","properties":{"total":{"type":"integer","description":"Total number of topics documents that matched your query.","x-example":5,"format":"int32"},"topics":{"type":"array","description":"List of topics.","items":{"type":"object","$ref":"#\/definitions\/topic"},"x-example":""}},"required":["total","topics"]},"subscriberList":{"description":"Subscriber list","type":"object","properties":{"total":{"type":"integer","description":"Total number of subscribers documents that matched your query.","x-example":5,"format":"int32"},"subscribers":{"type":"array","description":"List of subscribers.","items":{"type":"object","$ref":"#\/definitions\/subscriber"},"x-example":""}},"required":["total","subscribers"]},"targetList":{"description":"Target list","type":"object","properties":{"total":{"type":"integer","description":"Total number of targets documents that matched your query.","x-example":5,"format":"int32"},"targets":{"type":"array","description":"List of targets.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":""}},"required":["total","targets"]},"migrationList":{"description":"Migrations List","type":"object","properties":{"total":{"type":"integer","description":"Total number of migrations documents that matched your query.","x-example":5,"format":"int32"},"migrations":{"type":"array","description":"List of migrations.","items":{"type":"object","$ref":"#\/definitions\/migration"},"x-example":""}},"required":["total","migrations"]},"firebaseProjectList":{"description":"Migrations Firebase Projects List","type":"object","properties":{"total":{"type":"integer","description":"Total number of projects documents that matched your query.","x-example":5,"format":"int32"},"projects":{"type":"array","description":"List of projects.","items":{"type":"object","$ref":"#\/definitions\/firebaseProject"},"x-example":""}},"required":["total","projects"]},"vcsContentList":{"description":"VCS Content List","type":"object","properties":{"total":{"type":"integer","description":"Total number of contents documents that matched your query.","x-example":5,"format":"int32"},"contents":{"type":"array","description":"List of contents.","items":{"type":"object","$ref":"#\/definitions\/vcsContent"},"x-example":""}},"required":["total","contents"]},"database":{"description":"Database","type":"object","properties":{"$id":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Database name.","x-example":"My Database"},"$createdAt":{"type":"string","description":"Database creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Database update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"enabled":{"type":"boolean","description":"If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false}},"required":["$id","name","$createdAt","$updatedAt","enabled"]},"collection":{"description":"Collection","type":"object","properties":{"$id":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Collection creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Collection update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Collection name.","x-example":"My Collection"},"enabled":{"type":"boolean","description":"Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false},"documentSecurity":{"type":"boolean","description":"Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"attributes":{"type":"array","description":"Collection attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":{}},"indexes":{"type":"array","description":"Collection indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":{}}},"required":["$id","$createdAt","$updatedAt","$permissions","databaseId","name","enabled","documentSecurity","attributes","indexes"]},"attributeList":{"description":"Attributes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of attributes in the given collection.","x-example":5,"format":"int32"},"attributes":{"type":"array","description":"List of attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":""}},"required":["total","attributes"]},"attributeString":{"description":"AttributeString","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"size":{"type":"integer","description":"Attribute size.","x-example":128,"format":"int32"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default","x-nullable":true}},"required":["key","type","status","error","required","size"]},"attributeInteger":{"description":"AttributeInteger","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"count"},"type":{"type":"string","description":"Attribute type.","x-example":"integer"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"integer","description":"Minimum value to enforce for new documents.","x-example":1,"format":"int32","x-nullable":true},"max":{"type":"integer","description":"Maximum value to enforce for new documents.","x-example":10,"format":"int32","x-nullable":true},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":10,"format":"int32","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeFloat":{"description":"AttributeFloat","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"percentageCompleted"},"type":{"type":"string","description":"Attribute type.","x-example":"double"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"number","description":"Minimum value to enforce for new documents.","x-example":1.5,"format":"double","x-nullable":true},"max":{"type":"number","description":"Maximum value to enforce for new documents.","x-example":10.5,"format":"double","x-nullable":true},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":2.5,"format":"double","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeBoolean":{"description":"AttributeBoolean","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"isEnabled"},"type":{"type":"string","description":"Attribute type.","x-example":"boolean"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"x-nullable":true}},"required":["key","type","status","error","required"]},"attributeEmail":{"description":"AttributeEmail","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"userEmail"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"email"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default@example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeEnum":{"description":"AttributeEnum","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"status"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"elements":{"type":"array","description":"Array of elements in enumerated type.","items":{"type":"string"},"x-example":"element"},"format":{"type":"string","description":"String format.","x-example":"enum"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"element","x-nullable":true}},"required":["key","type","status","error","required","elements","format"]},"attributeIp":{"description":"AttributeIP","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"ipAddress"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"ip"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"192.0.2.0","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeUrl":{"description":"AttributeURL","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"githubUrl"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"url"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"http:\/\/example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeDatetime":{"description":"AttributeDatetime","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"birthDay"},"type":{"type":"string","description":"Attribute type.","x-example":"datetime"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"ISO 8601 format.","x-example":"datetime"},"default":{"type":"string","description":"Default value for attribute when not provided. Only null is optional","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeRelationship":{"description":"AttributeRelationship","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"relatedCollection":{"type":"string","description":"The ID of the related collection.","x-example":"collection"},"relationType":{"type":"string","description":"The type of the relationship.","x-example":"oneToOne|oneToMany|manyToOne|manyToMany"},"twoWay":{"type":"boolean","description":"Is the relationship two-way?","x-example":false},"twoWayKey":{"type":"string","description":"The key of the two-way relationship.","x-example":"string"},"onDelete":{"type":"string","description":"How deleting the parent document will propagate to child documents.","x-example":"restrict|cascade|setNull"},"side":{"type":"string","description":"Whether this is the parent or child side of the relationship","x-example":"parent|child"}},"required":["key","type","status","error","required","relatedCollection","relationType","twoWay","twoWayKey","onDelete","side"]},"index":{"description":"Index","type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":"index1"},"type":{"type":"string","description":"Index type.","x-example":"primary"},"status":{"type":"string","description":"Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an index.","x-example":"string"},"attributes":{"type":"array","description":"Index attributes.","items":{"type":"string"},"x-example":[]},"orders":{"type":"array","description":"Index orders.","items":{"type":"string"},"x-example":[],"x-nullable":true}},"required":["key","type","status","error","attributes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","x-nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","x-nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"x-oneOf":[{"$ref":"#\/definitions\/algoArgon2"},{"$ref":"#\/definitions\/algoScrypt"},{"$ref":"#\/definitions\/algoScryptModified"},{"$ref":"#\/definitions\/algoBcrypt"},{"$ref":"#\/definitions\/algoPhpass"},{"$ref":"#\/definitions\/algoSha"},{"$ref":"#\/definitions\/algoMd5"}]},"x-nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"bucket":{"description":"Bucket","type":"object","properties":{"$id":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Bucket creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Bucket update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"fileSecurity":{"type":"boolean","description":"Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"name":{"type":"string","description":"Bucket name.","x-example":"Documents"},"enabled":{"type":"boolean","description":"Bucket enabled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size supported.","x-example":100,"format":"int32"},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions.","items":{"type":"string"},"x-example":["jpg","png"]},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).","x-example":"gzip"},"encryption":{"type":"boolean","description":"Bucket is encrypted.","x-example":false},"antivirus":{"type":"boolean","description":"Virus scanning is enabled.","x-example":false}},"required":["$id","$createdAt","$updatedAt","$permissions","fileSecurity","name","enabled","maximumFileSize","allowedFileExtensions","compression","encryption","antivirus"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"function":{"description":"Function","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"execute":{"type":"array","description":"Execution permissions.","items":{"type":"string"},"x-example":"users"},"name":{"type":"string","description":"Function name.","x-example":"My Function"},"enabled":{"type":"boolean","description":"Function enabled.","x-example":false},"live":{"type":"boolean","description":"Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"runtime":{"type":"string","description":"Function execution runtime.","x-example":"python-3.8"},"deployment":{"type":"string","description":"Function's active deployment ID.","x-example":"5e5ea5c16897e"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"vars":{"type":"array","description":"Function variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":[]},"events":{"type":"array","description":"Function trigger events.","items":{"type":"string"},"x-example":"account.create"},"schedule":{"type":"string","description":"Function execution schedult in CRON format.","x-example":"5 4 * * *"},"timeout":{"type":"integer","description":"Function execution timeout in seconds.","x-example":300,"format":"int32"},"entrypoint":{"type":"string","description":"The entrypoint file used to execute the deployment.","x-example":"index.js"},"commands":{"type":"string","description":"The build command used to build the deployment.","x-example":"npm install"},"version":{"type":"string","description":"Version of Open Runtimes used for the function.","x-example":"v2"},"installationId":{"type":"string","description":"Function VCS (Version Control System) installation id.","x-example":"6m40at4ejk5h2u9s1hboo"},"providerRepositoryId":{"type":"string","description":"VCS (Version Control System) Repository ID","x-example":"appwrite"},"providerBranch":{"type":"string","description":"VCS (Version Control System) branch name","x-example":"main"},"providerRootDirectory":{"type":"string","description":"Path to function in VCS (Version Control System) repository","x-example":"functions\/helloWorld"},"providerSilentMode":{"type":"boolean","description":"Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests","x-example":false}},"required":["$id","$createdAt","$updatedAt","execute","name","enabled","live","logging","runtime","deployment","scopes","vars","events","schedule","timeout","entrypoint","commands","version","installationId","providerRepositoryId","providerBranch","providerRootDirectory","providerSilentMode"]},"installation":{"description":"Installation","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"VCS (Version Control System) provider name.","x-example":"github"},"organization":{"type":"string","description":"VCS (Version Control System) organization name.","x-example":"appwrite"},"providerInstallationId":{"type":"string","description":"VCS (Version Control System) installation ID.","x-example":"5322"}},"required":["$id","$createdAt","$updatedAt","provider","organization","providerInstallationId"]},"providerRepository":{"description":"ProviderRepository","type":"object","properties":{"id":{"type":"string","description":"VCS (Version Control System) repository ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"VCS (Version Control System) repository name.","x-example":"appwrite"},"organization":{"type":"string","description":"VCS (Version Control System) organization name","x-example":"appwrite"},"provider":{"type":"string","description":"VCS (Version Control System) provider name.","x-example":"github"},"private":{"type":"boolean","description":"Is VCS (Version Control System) repository private?","x-example":true},"runtime":{"type":"string","description":"Auto-detected runtime suggestion. Empty if getting response of getRuntime().","x-example":"node"},"pushedAt":{"type":"string","description":"Last commit date in ISO 8601 format.","x-example":"datetime"}},"required":["id","name","organization","provider","private","runtime","pushedAt"]},"detection":{"description":"Detection","type":"object","properties":{"runtime":{"type":"string","description":"Runtime","x-example":"node"}},"required":["runtime"]},"vcsContent":{"description":"VcsContents","type":"object","properties":{"size":{"type":"integer","description":"Content size in bytes. Only files have size, and for directories, 0 is returned.","x-example":1523,"format":"int32","x-nullable":true},"isDirectory":{"type":"boolean","description":"If a content is a directory. Directories can be used to check nested contents.","x-example":true,"x-nullable":true},"name":{"type":"string","description":"Name of directory or file.","x-example":"Main.java"}},"required":["name"]},"branch":{"description":"Branch","type":"object","properties":{"name":{"type":"string","description":"Branch Name.","x-example":"main"}},"required":["name"]},"runtime":{"description":"Runtime","type":"object","properties":{"$id":{"type":"string","description":"Runtime ID.","x-example":"python-3.8"},"name":{"type":"string","description":"Runtime Name.","x-example":"Python"},"version":{"type":"string","description":"Runtime version.","x-example":"3.8"},"base":{"type":"string","description":"Base Docker image used to build the runtime.","x-example":"python:3.8-alpine"},"image":{"type":"string","description":"Image name of Docker Hub.","x-example":"appwrite\\\/runtime-for-python:3.8"},"logo":{"type":"string","description":"Name of the logo image.","x-example":"python.png"},"supports":{"type":"array","description":"List of supported architectures.","items":{"type":"string"},"x-example":"amd64"}},"required":["$id","name","version","base","image","logo","supports"]},"deployment":{"description":"Deployment","type":"object","properties":{"$id":{"type":"string","description":"Deployment ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Deployment update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"type":{"type":"string","description":"Type of deployment.","x-example":"vcs"},"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea6g16897e"},"resourceType":{"type":"string","description":"Resource type.","x-example":"functions"},"entrypoint":{"type":"string","description":"The entrypoint file to use to execute the deployment code.","x-example":"index.js"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"},"buildId":{"type":"string","description":"The current build ID.","x-example":"5e5ea5c16897e"},"activate":{"type":"boolean","description":"Whether the deployment should be automatically activated.","x-example":true},"status":{"type":"string","description":"The deployment status. Possible values are \"processing\", \"building\", \"waiting\", \"ready\", and \"failed\".","x-example":"ready"},"buildLogs":{"type":"string","description":"The build logs.","x-example":"Compiling source files..."},"buildTime":{"type":"integer","description":"The current build time in seconds.","x-example":128,"format":"int32"},"providerRepositoryName":{"type":"string","description":"The name of the vcs provider repository","x-example":"database"},"providerRepositoryOwner":{"type":"string","description":"The name of the vcs provider repository owner","x-example":"utopia"},"providerRepositoryUrl":{"type":"string","description":"The url of the vcs provider repository","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function"},"providerBranch":{"type":"string","description":"The branch of the vcs repository","x-example":"0.7.x"},"providerCommitHash":{"type":"string","description":"The commit hash of the vcs commit","x-example":"7c3f25d"},"providerCommitAuthorUrl":{"type":"string","description":"The url of vcs commit author","x-example":"https:\/\/github.com\/vermakhushboo"},"providerCommitAuthor":{"type":"string","description":"The name of vcs commit author","x-example":"Khushboo Verma"},"providerCommitMessage":{"type":"string","description":"The commit message","x-example":"Update index.js"},"providerCommitUrl":{"type":"string","description":"The url of the vcs commit","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"},"providerBranchUrl":{"type":"string","description":"The branch of the vcs repository","x-example":"https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"}},"required":["$id","$createdAt","$updatedAt","type","resourceId","resourceType","entrypoint","size","buildId","activate","status","buildLogs","buildTime","providerRepositoryName","providerRepositoryOwner","providerRepositoryUrl","providerBranch","providerCommitHash","providerCommitAuthorUrl","providerCommitAuthor","providerCommitMessage","providerCommitUrl","providerBranchUrl"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"build":{"description":"Build","type":"object","properties":{"$id":{"type":"string","description":"Build ID.","x-example":"5e5ea5c16897e"},"deploymentId":{"type":"string","description":"The deployment that created this build.","x-example":"5e5ea5c16897e"},"status":{"type":"string","description":"The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built","x-example":"ready"},"stdout":{"type":"string","description":"The stdout of the build.","x-example":""},"stderr":{"type":"string","description":"The stderr of the build.","x-example":""},"startTime":{"type":"string","description":"The deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"endTime":{"type":"string","description":"The time the build was finished in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"duration":{"type":"integer","description":"The build duration in seconds.","x-example":0,"format":"int32"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"}},"required":["$id","deploymentId","status","stdout","stderr","startTime","endTime","duration","size"]},"project":{"description":"Project","type":"object","properties":{"$id":{"type":"string","description":"Project ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Project creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Project update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Project name.","x-example":"New Project"},"description":{"type":"string","description":"Project description.","x-example":"This is a new project."},"teamId":{"type":"string","description":"Project team ID.","x-example":"1592981250"},"logo":{"type":"string","description":"Project logo file ID.","x-example":"5f5c451b403cb"},"url":{"type":"string","description":"Project website URL.","x-example":"5f5c451b403cb"},"legalName":{"type":"string","description":"Company legal name.","x-example":"Company LTD."},"legalCountry":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.","x-example":"US"},"legalState":{"type":"string","description":"State name.","x-example":"New York"},"legalCity":{"type":"string","description":"City name.","x-example":"New York City."},"legalAddress":{"type":"string","description":"Company Address.","x-example":"620 Eighth Avenue, New York, NY 10018"},"legalTaxId":{"type":"string","description":"Company Tax ID.","x-example":"131102020"},"authDuration":{"type":"integer","description":"Session duration in seconds.","x-example":60,"format":"int32"},"authLimit":{"type":"integer","description":"Max users allowed. 0 is unlimited.","x-example":100,"format":"int32"},"authSessionsLimit":{"type":"integer","description":"Max sessions allowed per user. 100 maximum.","x-example":10,"format":"int32"},"authPasswordHistory":{"type":"integer","description":"Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.","x-example":5,"format":"int32"},"authPasswordDictionary":{"type":"boolean","description":"Whether or not to check user's password against most commonly used passwords.","x-example":true},"authPersonalDataCheck":{"type":"boolean","description":"Whether or not to check the user password for similarity with their personal data.","x-example":true},"authMockNumbers":{"type":"array","description":"An array of mock numbers and their corresponding verification codes (OTPs).","items":{"type":"object","$ref":"#\/definitions\/mockNumber"},"x-example":[{}]},"authSessionAlerts":{"type":"boolean","description":"Whether or not to send session alert emails to users.","x-example":true},"oAuthProviders":{"type":"array","description":"List of Auth Providers.","items":{"type":"object","$ref":"#\/definitions\/authProvider"},"x-example":[{}]},"platforms":{"type":"array","description":"List of Platforms.","items":{"type":"object","$ref":"#\/definitions\/platform"},"x-example":{}},"webhooks":{"type":"array","description":"List of Webhooks.","items":{"type":"object","$ref":"#\/definitions\/webhook"},"x-example":{}},"keys":{"type":"array","description":"List of API Keys.","items":{"type":"object","$ref":"#\/definitions\/key"},"x-example":{}},"smtpEnabled":{"type":"boolean","description":"Status for custom SMTP","x-example":false},"smtpSenderName":{"type":"string","description":"SMTP sender name","x-example":"John Appwrite"},"smtpSenderEmail":{"type":"string","description":"SMTP sender email","x-example":"john@appwrite.io"},"smtpReplyTo":{"type":"string","description":"SMTP reply to email","x-example":"support@appwrite.io"},"smtpHost":{"type":"string","description":"SMTP server host name","x-example":"mail.appwrite.io"},"smtpPort":{"type":"integer","description":"SMTP server port","x-example":25,"format":"int32"},"smtpUsername":{"type":"string","description":"SMTP server username","x-example":"emailuser"},"smtpPassword":{"type":"string","description":"SMTP server password","x-example":"securepassword"},"smtpSecure":{"type":"string","description":"SMTP server secure protocol","x-example":"tls"},"authEmailPassword":{"type":"boolean","description":"Email\/Password auth method status","x-example":true},"authUsersAuthMagicURL":{"type":"boolean","description":"Magic URL auth method status","x-example":true},"authEmailOtp":{"type":"boolean","description":"Email (OTP) auth method status","x-example":true},"authAnonymous":{"type":"boolean","description":"Anonymous auth method status","x-example":true},"authInvites":{"type":"boolean","description":"Invites auth method status","x-example":true},"authJWT":{"type":"boolean","description":"JWT auth method status","x-example":true},"authPhone":{"type":"boolean","description":"Phone auth method status","x-example":true},"serviceStatusForAccount":{"type":"boolean","description":"Account service status","x-example":true},"serviceStatusForAvatars":{"type":"boolean","description":"Avatars service status","x-example":true},"serviceStatusForDatabases":{"type":"boolean","description":"Databases service status","x-example":true},"serviceStatusForLocale":{"type":"boolean","description":"Locale service status","x-example":true},"serviceStatusForHealth":{"type":"boolean","description":"Health service status","x-example":true},"serviceStatusForStorage":{"type":"boolean","description":"Storage service status","x-example":true},"serviceStatusForTeams":{"type":"boolean","description":"Teams service status","x-example":true},"serviceStatusForUsers":{"type":"boolean","description":"Users service status","x-example":true},"serviceStatusForFunctions":{"type":"boolean","description":"Functions service status","x-example":true},"serviceStatusForGraphql":{"type":"boolean","description":"GraphQL service status","x-example":true},"serviceStatusForMessaging":{"type":"boolean","description":"Messaging service status","x-example":true}},"required":["$id","$createdAt","$updatedAt","name","description","teamId","logo","url","legalName","legalCountry","legalState","legalCity","legalAddress","legalTaxId","authDuration","authLimit","authSessionsLimit","authPasswordHistory","authPasswordDictionary","authPersonalDataCheck","authMockNumbers","authSessionAlerts","oAuthProviders","platforms","webhooks","keys","smtpEnabled","smtpSenderName","smtpSenderEmail","smtpReplyTo","smtpHost","smtpPort","smtpUsername","smtpPassword","smtpSecure","authEmailPassword","authUsersAuthMagicURL","authEmailOtp","authAnonymous","authInvites","authJWT","authPhone","serviceStatusForAccount","serviceStatusForAvatars","serviceStatusForDatabases","serviceStatusForLocale","serviceStatusForHealth","serviceStatusForStorage","serviceStatusForTeams","serviceStatusForUsers","serviceStatusForFunctions","serviceStatusForGraphql","serviceStatusForMessaging"]},"webhook":{"description":"Webhook","type":"object","properties":{"$id":{"type":"string","description":"Webhook ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Webhook creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Webhook update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Webhook name.","x-example":"My Webhook"},"url":{"type":"string","description":"Webhook URL endpoint.","x-example":"https:\/\/example.com\/webhook"},"events":{"type":"array","description":"Webhook trigger events.","items":{"type":"string"},"x-example":"database.collections.update"},"security":{"type":"boolean","description":"Indicated if SSL \/ TLS Certificate verification is enabled.","x-example":true},"httpUser":{"type":"string","description":"HTTP basic authentication username.","x-example":"username"},"httpPass":{"type":"string","description":"HTTP basic authentication password.","x-example":"password"},"signatureKey":{"type":"string","description":"Signature key which can be used to validated incoming","x-example":"ad3d581ca230e2b7059c545e5a"},"enabled":{"type":"boolean","description":"Indicates if this webhook is enabled.","x-example":true},"logs":{"type":"string","description":"Webhook error logs from the most recent failure.","x-example":"Failed to connect to remote server."},"attempts":{"type":"integer","description":"Number of consecutive failed webhook attempts.","x-example":10,"format":"int32"}},"required":["$id","$createdAt","$updatedAt","name","url","events","security","httpUser","httpPass","signatureKey","enabled","logs","attempts"]},"key":{"description":"Key","type":"object","properties":{"$id":{"type":"string","description":"Key ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Key creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Key update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Key name.","x-example":"My API Key"},"expire":{"type":"string","description":"Key expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"secret":{"type":"string","description":"Secret key.","x-example":"919c2d18fb5d4...a2ae413da83346ad2"},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"},"sdks":{"type":"array","description":"List of SDK user agents that used this key.","items":{"type":"string"},"x-example":"appwrite:flutter"}},"required":["$id","$createdAt","$updatedAt","name","expire","scopes","secret","accessedAt","sdks"]},"mockNumber":{"description":"Mock Number","type":"object","properties":{"phone":{"type":"string","description":"Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.","x-example":"+1612842323"},"otp":{"type":"string","description":"Mock OTP for the number. ","x-example":"123456"}},"required":["phone","otp"]},"authProvider":{"description":"AuthProvider","type":"object","properties":{"key":{"type":"string","description":"Auth Provider.","x-example":"github"},"name":{"type":"string","description":"Auth Provider name.","x-example":"GitHub"},"appId":{"type":"string","description":"OAuth 2.0 application ID.","x-example":"259125845563242502"},"secret":{"type":"string","description":"OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.","x-example":"Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ"},"enabled":{"type":"boolean","description":"Auth Provider is active and can be used to create session.","x-example":""}},"required":["key","name","appId","secret","enabled"]},"platform":{"description":"Platform","type":"object","properties":{"$id":{"type":"string","description":"Platform ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Platform creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Platform update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Platform name.","x-example":"My Web App"},"type":{"type":"string","description":"Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, ios, android, and unity.","x-example":"web"},"key":{"type":"string","description":"Platform Key. iOS bundle ID or Android package name. Empty string for other platforms.","x-example":"com.company.appname"},"store":{"type":"string","description":"App store or Google Play store ID.","x-example":""},"hostname":{"type":"string","description":"Web app hostname. Empty string for other platforms.","x-example":true},"httpUser":{"type":"string","description":"HTTP basic authentication username.","x-example":"username"},"httpPass":{"type":"string","description":"HTTP basic authentication password.","x-example":"password"}},"required":["$id","$createdAt","$updatedAt","name","type","key","store","hostname","httpUser","httpPass"]},"variable":{"description":"Variable","type":"object","properties":{"$id":{"type":"string","description":"Variable ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"key":{"type":"string","description":"Variable key.","x-example":"API_KEY"},"value":{"type":"string","description":"Variable value.","x-example":"myPa$$word1"},"resourceType":{"type":"string","description":"Service to which the variable belongs. Possible values are \"project\", \"function\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"}},"required":["$id","$createdAt","$updatedAt","key","value","resourceType","resourceId"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"healthAntivirus":{"description":"Health Antivirus","type":"object","properties":{"version":{"type":"string","description":"Antivirus version.","x-example":"1.0.0"},"status":{"type":"string","description":"Antivirus status. Possible values can are: `disabled`, `offline`, `online`","x-example":"online"}},"required":["version","status"]},"healthQueue":{"description":"Health Queue","type":"object","properties":{"size":{"type":"integer","description":"Amount of actions in the queue.","x-example":8,"format":"int32"}},"required":["size"]},"healthStatus":{"description":"Health Status","type":"object","properties":{"name":{"type":"string","description":"Name of the service.","x-example":"database"},"ping":{"type":"integer","description":"Duration in milliseconds how long the health check took.","x-example":128,"format":"int32"},"status":{"type":"string","description":"Service status. Possible values can are: `pass`, `fail`","x-example":"pass"}},"required":["name","ping","status"]},"healthCertificate":{"description":"Health Certificate","type":"object","properties":{"name":{"type":"string","description":"Certificate name","x-example":"\/CN=www.google.com"},"subjectSN":{"type":"string","description":"Subject SN","x-example":""},"issuerOrganisation":{"type":"string","description":"Issuer organisation","x-example":""},"validFrom":{"type":"string","description":"Valid from","x-example":"1704200998"},"validTo":{"type":"string","description":"Valid to","x-example":"1711458597"},"signatureTypeSN":{"type":"string","description":"Signature type SN","x-example":"RSA-SHA256"}},"required":["name","subjectSN","issuerOrganisation","validFrom","validTo","signatureTypeSN"]},"healthTime":{"description":"Health Time","type":"object","properties":{"remoteTime":{"type":"integer","description":"Current unix timestamp on trustful remote server.","x-example":1639490751,"format":"int32"},"localTime":{"type":"integer","description":"Current unix timestamp of local server where Appwrite runs.","x-example":1639490844,"format":"int32"},"diff":{"type":"integer","description":"Difference of unix remote and local timestamps in milliseconds.","x-example":93,"format":"int32"}},"required":["remoteTime","localTime","diff"]},"metric":{"description":"Metric","type":"object","properties":{"value":{"type":"integer","description":"The value of this metric at the timestamp.","x-example":1,"format":"int32"},"date":{"type":"string","description":"The date at which this metric was aggregated in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["value","date"]},"metricBreakdown":{"description":"Metric Breakdown","type":"object","properties":{"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Resource name.","x-example":"Documents"},"value":{"type":"integer","description":"The value of this metric at the timestamp.","x-example":1,"format":"int32"}},"required":["resourceId","name","value"]},"usageDatabases":{"description":"UsageDatabases","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"databasesTotal":{"type":"integer","description":"Total aggregated number of databases.","x-example":0,"format":"int32"},"collectionsTotal":{"type":"integer","description":"Total aggregated number of collections.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"databases":{"type":"array","description":"Aggregated number of databases per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"collections":{"type":"array","description":"Aggregated number of collections per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","databasesTotal","collectionsTotal","documentsTotal","databases","collections","documents"]},"usageDatabase":{"description":"UsageDatabase","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"collectionsTotal":{"type":"integer","description":"Total aggregated number of collections.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"collections":{"type":"array","description":"Aggregated number of collections per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","collectionsTotal","documentsTotal","collections","documents"]},"usageCollection":{"description":"UsageCollection","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"documentsTotal":{"type":"integer","description":"Total aggregated number of of documents.","x-example":0,"format":"int32"},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","documentsTotal","documents"]},"usageUsers":{"description":"UsageUsers","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"usersTotal":{"type":"integer","description":"Total aggregated number of statistics of users.","x-example":0,"format":"int32"},"sessionsTotal":{"type":"integer","description":"Total aggregated number of active sessions.","x-example":0,"format":"int32"},"users":{"type":"array","description":"Aggregated number of users per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"sessions":{"type":"array","description":"Aggregated number of active sessions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","usersTotal","sessionsTotal","users","sessions"]},"usageStorage":{"description":"StorageUsage","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"bucketsTotal":{"type":"integer","description":"Total aggregated number of buckets","x-example":0,"format":"int32"},"filesTotal":{"type":"integer","description":"Total aggregated number of files.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated number of files storage (in bytes).","x-example":0,"format":"int32"},"buckets":{"type":"array","description":"Aggregated number of buckets per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"files":{"type":"array","description":"Aggregated number of files per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"storage":{"type":"array","description":"Aggregated number of files storage (in bytes) per period .","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","bucketsTotal","filesTotal","filesStorageTotal","buckets","files","storage"]},"usageBuckets":{"description":"UsageBuckets","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"filesTotal":{"type":"integer","description":"Total aggregated number of bucket files.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated number of bucket files storage (in bytes).","x-example":0,"format":"int32"},"files":{"type":"array","description":"Aggregated number of bucket files per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"storage":{"type":"array","description":"Aggregated number of bucket storage files (in bytes) per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","filesTotal","filesStorageTotal","files","storage"]},"usageFunctions":{"description":"UsageFunctions","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"functionsTotal":{"type":"integer","description":"Total aggregated number of functions.","x-example":0,"format":"int32"},"deploymentsTotal":{"type":"integer","description":"Total aggregated number of functions deployments.","x-example":0,"format":"int32"},"deploymentsStorageTotal":{"type":"integer","description":"Total aggregated sum of functions deployment storage.","x-example":0,"format":"int32"},"buildsTotal":{"type":"integer","description":"Total aggregated number of functions build.","x-example":0,"format":"int32"},"buildsStorageTotal":{"type":"integer","description":"total aggregated sum of functions build storage.","x-example":0,"format":"int32"},"buildsTimeTotal":{"type":"integer","description":"Total aggregated sum of functions build compute time.","x-example":0,"format":"int32"},"executionsTotal":{"type":"integer","description":"Total aggregated number of functions execution.","x-example":0,"format":"int32"},"executionsTimeTotal":{"type":"integer","description":"Total aggregated sum of functions execution compute time.","x-example":0,"format":"int32"},"functions":{"type":"array","description":"Aggregated number of functions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":0},"deployments":{"type":"array","description":"Aggregated number of functions deployment per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"deploymentsStorage":{"type":"array","description":"Aggregated number of functions deployment storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"builds":{"type":"array","description":"Aggregated number of functions build per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsStorage":{"type":"array","description":"Aggregated sum of functions build storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsTime":{"type":"array","description":"Aggregated sum of functions build compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of functions execution per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executionsTime":{"type":"array","description":"Aggregated number of functions execution compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","functionsTotal","deploymentsTotal","deploymentsStorageTotal","buildsTotal","buildsStorageTotal","buildsTimeTotal","executionsTotal","executionsTimeTotal","functions","deployments","deploymentsStorage","builds","buildsStorage","buildsTime","executions","executionsTime"]},"usageFunction":{"description":"UsageFunction","type":"object","properties":{"range":{"type":"string","description":"The time range of the usage stats.","x-example":"30d"},"deploymentsTotal":{"type":"integer","description":"Total aggregated number of function deployments.","x-example":0,"format":"int32"},"deploymentsStorageTotal":{"type":"integer","description":"Total aggregated sum of function deployments storage.","x-example":0,"format":"int32"},"buildsTotal":{"type":"integer","description":"Total aggregated number of function builds.","x-example":0,"format":"int32"},"buildsStorageTotal":{"type":"integer","description":"total aggregated sum of function builds storage.","x-example":0,"format":"int32"},"buildsTimeTotal":{"type":"integer","description":"Total aggregated sum of function builds compute time.","x-example":0,"format":"int32"},"executionsTotal":{"type":"integer","description":"Total aggregated number of function executions.","x-example":0,"format":"int32"},"executionsTimeTotal":{"type":"integer","description":"Total aggregated sum of function executions compute time.","x-example":0,"format":"int32"},"deployments":{"type":"array","description":"Aggregated number of function deployments per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"deploymentsStorage":{"type":"array","description":"Aggregated number of function deployments storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"builds":{"type":"array","description":"Aggregated number of function builds per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsStorage":{"type":"array","description":"Aggregated sum of function builds storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsTime":{"type":"array","description":"Aggregated sum of function builds compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of function executions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executionsTime":{"type":"array","description":"Aggregated number of function executions compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","deploymentsTotal","deploymentsStorageTotal","buildsTotal","buildsStorageTotal","buildsTimeTotal","executionsTotal","executionsTimeTotal","deployments","deploymentsStorage","builds","buildsStorage","buildsTime","executions","executionsTime"]},"usageProject":{"description":"UsageProject","type":"object","properties":{"executionsTotal":{"type":"integer","description":"Total aggregated number of function executions.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"databasesTotal":{"type":"integer","description":"Total aggregated number of databases.","x-example":0,"format":"int32"},"usersTotal":{"type":"integer","description":"Total aggregated number of users.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated sum of files storage size (in bytes).","x-example":0,"format":"int32"},"bucketsTotal":{"type":"integer","description":"Total aggregated number of buckets.","x-example":0,"format":"int32"},"requests":{"type":"array","description":"Aggregated number of requests per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"network":{"type":"array","description":"Aggregated number of consumed bandwidth per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"users":{"type":"array","description":"Aggregated number of users per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of executions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executionsBreakdown":{"type":"array","description":"Aggregated breakdown in totals of executions by functions.","items":{"type":"object","$ref":"#\/definitions\/metricBreakdown"},"x-example":[]},"bucketsBreakdown":{"type":"array","description":"Aggregated breakdown in totals of usage by buckets.","items":{"type":"object","$ref":"#\/definitions\/metricBreakdown"},"x-example":[]}},"required":["executionsTotal","documentsTotal","databasesTotal","usersTotal","filesStorageTotal","bucketsTotal","requests","network","users","executions","executionsBreakdown","bucketsBreakdown"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"proxyRule":{"description":"Rule","type":"object","properties":{"$id":{"type":"string","description":"Rule ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Rule creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Rule update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"domain":{"type":"string","description":"Domain name.","x-example":"appwrite.company.com"},"resourceType":{"type":"string","description":"Action definition for the rule. Possible values are \"api\", \"function\", or \"redirect\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource for the action type. If resourceType is \"api\" or \"url\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"},"status":{"type":"string","description":"Domain verification status. Possible values are \"created\", \"verifying\", \"verified\" and \"unverified\"","x-example":"verified"},"logs":{"type":"string","description":"Certificate generation logs. This will return an empty string if generation did not run, or succeeded.","x-example":"HTTP challegne failed."},"renewAt":{"type":"string","description":"Certificate auto-renewal date in ISO 8601 format.","x-example":"datetime"}},"required":["$id","$createdAt","$updatedAt","domain","resourceType","resourceId","status","logs","renewAt"]},"smsTemplate":{"description":"SmsTemplate","type":"object","properties":{"type":{"type":"string","description":"Template type","x-example":"verification"},"locale":{"type":"string","description":"Template locale","x-example":"en_us"},"message":{"type":"string","description":"Template message","x-example":"Click on the link to verify your account."}},"required":["type","locale","message"]},"emailTemplate":{"description":"EmailTemplate","type":"object","properties":{"type":{"type":"string","description":"Template type","x-example":"verification"},"locale":{"type":"string","description":"Template locale","x-example":"en_us"},"message":{"type":"string","description":"Template message","x-example":"Click on the link to verify your account."},"senderName":{"type":"string","description":"Name of the sender","x-example":"My User"},"senderEmail":{"type":"string","description":"Email of the sender","x-example":"mail@appwrite.io"},"replyTo":{"type":"string","description":"Reply to email address","x-example":"emails@appwrite.io"},"subject":{"type":"string","description":"Email subject","x-example":"Please verify your email address"}},"required":["type","locale","message","senderName","senderEmail","replyTo","subject"]},"consoleVariables":{"description":"Console Variables","type":"object","properties":{"_APP_DOMAIN_TARGET":{"type":"string","description":"CNAME target for your Appwrite custom domains.","x-example":"appwrite.io"},"_APP_STORAGE_LIMIT":{"type":"integer","description":"Maximum file size allowed for file upload in bytes.","x-example":"30000000","format":"int32"},"_APP_FUNCTIONS_SIZE_LIMIT":{"type":"integer","description":"Maximum file size allowed for deployment in bytes.","x-example":"30000000","format":"int32"},"_APP_USAGE_STATS":{"type":"string","description":"Defines if usage stats are enabled. This value is set to 'enabled' by default, to disable the usage stats set the value to 'disabled'.","x-example":"enabled"},"_APP_VCS_ENABLED":{"type":"boolean","description":"Defines if VCS (Version Control System) is enabled.","x-example":true},"_APP_DOMAIN_ENABLED":{"type":"boolean","description":"Defines if main domain is configured. If so, custom domains can be created.","x-example":true},"_APP_ASSISTANT_ENABLED":{"type":"boolean","description":"Defines if AI assistant is enabled.","x-example":true}},"required":["_APP_DOMAIN_TARGET","_APP_STORAGE_LIMIT","_APP_FUNCTIONS_SIZE_LIMIT","_APP_USAGE_STATS","_APP_VCS_ENABLED","_APP_DOMAIN_ENABLED","_APP_ASSISTANT_ENABLED"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"provider":{"description":"Provider","type":"object","properties":{"$id":{"type":"string","description":"Provider ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Provider creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Provider update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name for the provider instance.","x-example":"Mailgun"},"provider":{"type":"string","description":"The name of the provider service.","x-example":"mailgun"},"enabled":{"type":"boolean","description":"Is provider enabled?","x-example":true},"type":{"type":"string","description":"Type of provider.","x-example":"sms"},"credentials":{"type":"object","additionalProperties":true,"description":"Provider credentials.","x-example":{"key":"123456789"}},"options":{"type":"object","additionalProperties":true,"description":"Provider options.","x-example":{"from":"sender-email@mydomain"}}},"required":["$id","$createdAt","$updatedAt","name","provider","enabled","type","credentials"]},"message":{"description":"Message","type":"object","properties":{"$id":{"type":"string","description":"Message ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Message creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Message update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerType":{"type":"string","description":"Message provider type.","x-example":"email"},"topics":{"type":"array","description":"Topic IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"users":{"type":"array","description":"User IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"targets":{"type":"array","description":"Target IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"scheduledAt":{"type":"string","description":"The scheduled time for message.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveredAt":{"type":"string","description":"The time when the message was delivered.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveryErrors":{"type":"array","description":"Delivery errors if any.","items":{"type":"string"},"x-example":["Failed to send message to target 5e5ea5c16897e: Credentials not valid."],"x-nullable":true},"deliveredTotal":{"type":"integer","description":"Number of recipients the message was delivered to.","x-example":1,"format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Data of the message.","x-example":{"subject":"Welcome to Appwrite","content":"Hi there, welcome to Appwrite family."}},"status":{"type":"string","description":"Status of delivery.","x-example":"Message status can be one of the following: draft, processing, scheduled, sent, or failed."}},"required":["$id","$createdAt","$updatedAt","providerType","topics","users","targets","deliveredTotal","data","status"]},"topic":{"description":"Topic","type":"object","properties":{"$id":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Topic creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Topic update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name of the topic.","x-example":"events"},"emailTotal":{"type":"integer","description":"Total count of email subscribers subscribed to the topic.","x-example":100,"format":"int32"},"smsTotal":{"type":"integer","description":"Total count of SMS subscribers subscribed to the topic.","x-example":100,"format":"int32"},"pushTotal":{"type":"integer","description":"Total count of push subscribers subscribed to the topic.","x-example":100,"format":"int32"},"subscribe":{"type":"array","description":"Subscribe permissions.","items":{"type":"string"},"x-example":"users"}},"required":["$id","$createdAt","$updatedAt","name","emailTotal","smsTotal","pushTotal","subscribe"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"type":"object","$ref":"#\/definitions\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","x-nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]},"migration":{"description":"Migration","type":"object","properties":{"$id":{"type":"string","description":"Migration ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"string","description":"Migration status ( pending, processing, failed, completed ) ","x-example":"pending"},"stage":{"type":"string","description":"Migration stage ( init, processing, source-check, destination-check, migrating, finished )","x-example":"init"},"source":{"type":"string","description":"A string containing the type of source of the migration.","x-example":"Appwrite"},"resources":{"type":"array","description":"Resources to migration.","items":{"type":"string"},"x-example":["user"]},"statusCounters":{"type":"object","additionalProperties":true,"description":"A group of counters that represent the total progress of the migration.","x-example":"{\"Database\": {\"PENDING\": 0, \"SUCCESS\": 1, \"ERROR\": 0, \"SKIP\": 0, \"PROCESSING\": 0, \"WARNING\": 0}}"},"resourceData":{"type":"object","additionalProperties":true,"description":"An array of objects containing the report data of the resources that were migrated.","x-example":"[{\"resource\":\"Database\",\"id\":\"public\",\"status\":\"SUCCESS\",\"message\":\"\"}]"},"errors":{"type":"array","description":"All errors that occurred during the migration process.","items":{"type":"string"},"x-example":[]}},"required":["$id","$createdAt","$updatedAt","status","stage","source","resources","statusCounters","resourceData","errors"]},"migrationReport":{"description":"Migration Report","type":"object","properties":{"user":{"type":"integer","description":"Number of users to be migrated.","x-example":20,"format":"int32"},"team":{"type":"integer","description":"Number of teams to be migrated.","x-example":20,"format":"int32"},"database":{"type":"integer","description":"Number of databases to be migrated.","x-example":20,"format":"int32"},"document":{"type":"integer","description":"Number of documents to be migrated.","x-example":20,"format":"int32"},"file":{"type":"integer","description":"Number of files to be migrated.","x-example":20,"format":"int32"},"bucket":{"type":"integer","description":"Number of buckets to be migrated.","x-example":20,"format":"int32"},"function":{"type":"integer","description":"Number of functions to be migrated.","x-example":20,"format":"int32"},"size":{"type":"integer","description":"Size of files to be migrated in mb.","x-example":30000,"format":"int32"},"version":{"type":"string","description":"Version of the Appwrite instance to be migrated.","x-example":"1.4.0"}},"required":["user","team","database","document","file","bucket","function","size","version"]},"firebaseProject":{"description":"MigrationFirebaseProject","type":"object","properties":{"projectId":{"type":"string","description":"Project ID.","x-example":"my-project"},"displayName":{"type":"string","description":"Project display name.","x-example":"My Project"}},"required":["projectId","displayName"]}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file diff --git a/app/config/specs/swagger2-latest-server.json b/app/config/specs/swagger2-latest-server.json index 5e8f9fdae7..0faea4151e 100644 --- a/app/config/specs/swagger2-latest-server.json +++ b/app/config/specs/swagger2-latest-server.json @@ -1 +1 @@ -{"swagger":"2.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"host":"cloud.appwrite.io","basePath":"\/v1","schemes":["https"],"consumes":["application\/json","multipart\/form-data"],"produces":["application\/json"],"securityDefinitions":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"Key":{"type":"apiKey","name":"X-Appwrite-Key","description":"Your secret API key","in":"header","x-appwrite":{"demo":"<YOUR_API_KEY>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header","x-appwrite":{"demo":"<YOUR_JWT>"}},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Session":{"type":"apiKey","name":"X-Appwrite-Session","description":"The user session to authenticate with","in":"header"},"ForwardedUserAgent":{"type":"apiKey","name":"X-Forwarded-User-Agent","description":"The user agent string of the client that made the request","in":"header"}},"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","schema":{"$ref":"#\/definitions\/mfaType"}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","schema":{"$ref":"#\/definitions\/mfaChallenge"}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","default":null,"x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}]},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","default":null,"x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["challengeId","otp"]}}]}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","default":"","x-example":"password"}},"required":["password"]}}]}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["phone","password"]}}]}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["email","url"]}}]},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","default":null,"x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null}},"required":["userId","secret","password"]}}]}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","default":"","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"}},"required":["userId","phone"]}}]}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["url"]}}]},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"type":"string","x-example":"<NAME>","default":"","in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"type":"string","default":"","in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"type":"string","x-example":"<TEXT>","in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":1,"default":400,"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"type":"integer","format":"int32","x-example":0,"default":1,"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"type":"boolean","x-example":false,"default":false,"in":"query"}]}},"\/databases":{"get":{"summary":"List databases","operationId":"databasesList","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.","responses":{"200":{"description":"Databases List","schema":{"$ref":"#\/definitions\/databaseList"}}},"x-appwrite":{"method":"list","weight":69,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create database","operationId":"databasesCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Database.\n","responses":{"201":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"create","weight":68,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"databaseId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DATABASE_ID>"},"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["databaseId","name"]}}]}},"\/databases\/{databaseId}":{"get":{"summary":"Get database","operationId":"databasesGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"get","weight":70,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]},"put":{"summary":"Update database","operationId":"databasesUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a database by its unique ID.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"update","weight":72,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete database","operationId":"databasesDelete","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":73,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections":{"get":{"summary":"List collections","operationId":"databasesListCollections","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.","responses":{"200":{"description":"Collections List","schema":{"$ref":"#\/definitions\/collectionList"}}},"x-appwrite":{"method":"listCollections","weight":75,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collections.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"queries","description":"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: name, enabled, documentSecurity","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create collection","operationId":"databasesCreateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"createCollection","weight":74,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"collectionId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<COLLECTION_ID>"},"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["collectionId","name"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}":{"get":{"summary":"Get collection","operationId":"databasesGetCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"getCollection","weight":76,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]},"put":{"summary":"Update collection","operationId":"databasesUpdateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a collection by its unique ID.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"updateCollection","weight":78,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete collection","operationId":"databasesDeleteCollection","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteCollection","weight":79,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes":{"get":{"summary":"List attributes","operationId":"databasesListAttributes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List attributes in the collection.","responses":{"200":{"description":"Attributes List","schema":{"$ref":"#\/definitions\/attributeList"}}},"x-appwrite":{"method":"listAttributes","weight":90,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-attributes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, size, required, array, status, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean":{"post":{"summary":"Create boolean attribute","operationId":"databasesCreateBooleanAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a boolean attribute.\n","responses":{"202":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"createBooleanAttribute","weight":87,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}":{"patch":{"summary":"Update boolean attribute","operationId":"databasesUpdateBooleanAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a boolean attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"updateBooleanAttribute","weight":99,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime":{"post":{"summary":"Create datetime attribute","operationId":"databasesCreateDatetimeAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a date time attribute according to the ISO 8601 standard.","responses":{"202":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"createDatetimeAttribute","weight":88,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}":{"patch":{"summary":"Update dateTime attribute","operationId":"databasesUpdateDatetimeAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a date time attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"updateDatetimeAttribute","weight":100,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email":{"post":{"summary":"Create email attribute","operationId":"databasesCreateEmailAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an email attribute.\n","responses":{"202":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"createEmailAttribute","weight":81,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}":{"patch":{"summary":"Update email attribute","operationId":"databasesUpdateEmailAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an email attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"updateEmailAttribute","weight":93,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum":{"post":{"summary":"Create enum attribute","operationId":"databasesCreateEnumAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n","responses":{"202":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"createEnumAttribute","weight":82,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","elements","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}":{"patch":{"summary":"Update enum attribute","operationId":"databasesUpdateEnumAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an enum attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"updateEnumAttribute","weight":94,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["elements","required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float":{"post":{"summary":"Create float attribute","operationId":"databasesCreateFloatAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a float attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"createFloatAttribute","weight":86,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float\/{key}":{"patch":{"summary":"Update float attribute","operationId":"databasesUpdateFloatAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a float attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"updateFloatAttribute","weight":98,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer":{"post":{"summary":"Create integer attribute","operationId":"databasesCreateIntegerAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an integer attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"createIntegerAttribute","weight":85,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer\/{key}":{"patch":{"summary":"Update integer attribute","operationId":"databasesUpdateIntegerAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an integer attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"updateIntegerAttribute","weight":97,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip":{"post":{"summary":"Create IP address attribute","operationId":"databasesCreateIpAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create IP address attribute.\n","responses":{"202":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"createIpAttribute","weight":83,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}":{"patch":{"summary":"Update IP address attribute","operationId":"databasesUpdateIpAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an ip attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"updateIpAttribute","weight":95,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship":{"post":{"summary":"Create relationship attribute","operationId":"databasesCreateRelationshipAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"202":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"createRelationshipAttribute","weight":89,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"relatedCollectionId":{"type":"string","description":"Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","default":null,"x-example":"<RELATED_COLLECTION_ID>"},"type":{"type":"string","description":"Relation type","default":null,"x-example":"oneToOne","enum":["oneToOne","manyToOne","manyToMany","oneToMany"],"x-enum-name":"RelationshipType","x-enum-keys":[]},"twoWay":{"type":"boolean","description":"Is Two Way?","default":false,"x-example":false},"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"twoWayKey":{"type":"string","description":"Two Way Attribute Key.","default":null,"x-example":null},"onDelete":{"type":"string","description":"Constraints option","default":"restrict","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}},"required":["relatedCollectionId","type"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string":{"post":{"summary":"Create string attribute","operationId":"databasesCreateStringAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a string attribute.\n","responses":{"202":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"createStringAttribute","weight":80,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"size":{"type":"integer","description":"Attribute size for text attributes, in number of characters.","default":null,"x-example":1},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false},"encrypt":{"type":"boolean","description":"Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.","default":false,"x-example":false}},"required":["key","size","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}":{"patch":{"summary":"Update string attribute","operationId":"databasesUpdateStringAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a string attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"updateStringAttribute","weight":92,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url":{"post":{"summary":"Create URL attribute","operationId":"databasesCreateUrlAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a URL attribute.\n","responses":{"202":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"createUrlAttribute","weight":84,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}":{"patch":{"summary":"Update URL attribute","operationId":"databasesUpdateUrlAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an url attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"updateUrlAttribute","weight":96,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}":{"get":{"summary":"Get attribute","operationId":"databasesGetAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get attribute by ID.","responses":{"200":{"description":"AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString","schema":{"x-oneOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]}}},"x-appwrite":{"method":"getAttribute","weight":91,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete attribute","operationId":"databasesDeleteAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Deletes an attribute.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteAttribute","weight":102,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship":{"patch":{"summary":"Update relationship attribute","operationId":"databasesUpdateRelationshipAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"200":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"updateRelationshipAttribute","weight":101,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"onDelete":{"type":"string","description":"Constraints option","default":null,"x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}}}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","schema":{"$ref":"#\/definitions\/documentList"}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","default":{},"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","default":[],"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes":{"get":{"summary":"List indexes","operationId":"databasesListIndexes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List indexes in the collection.","responses":{"200":{"description":"Indexes List","schema":{"$ref":"#\/definitions\/indexList"}}},"x-appwrite":{"method":"listIndexes","weight":104,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-indexes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, status, attributes, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create index","operationId":"databasesCreateIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.","responses":{"202":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"createIndex","weight":103,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Index Key.","default":null,"x-example":null},"type":{"type":"string","description":"Index type.","default":null,"x-example":"key","enum":["key","fulltext","unique"],"x-enum-name":"IndexType","x-enum-keys":[]},"attributes":{"type":"array","description":"Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"orders":{"type":"array","description":"Array of index orders. Maximum of 100 orders are allowed.","default":[],"x-example":null,"items":{"type":"string"}}},"required":["key","type","attributes"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}":{"get":{"summary":"Get index","operationId":"databasesGetIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get index by ID.","responses":{"200":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"getIndex","weight":105,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete index","operationId":"databasesDeleteIndex","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete an index.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIndex","weight":106,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]}},"\/functions":{"get":{"summary":"List functions","operationId":"functionsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's functions. You can use the query params to filter your results.","responses":{"200":{"description":"Functions List","schema":{"$ref":"#\/definitions\/functionList"}}},"x-appwrite":{"method":"list","weight":287,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create function","operationId":"functionsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.","responses":{"201":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"create","weight":286,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"functionId":{"type":"string","description":"Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<FUNCTION_ID>"},"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":null,"x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.21","deno-1.24","deno-1.35","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Function maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Control System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function.","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function.","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"},"templateRepository":{"type":"string","description":"Repository name of the template.","default":"","x-example":"<TEMPLATE_REPOSITORY>"},"templateOwner":{"type":"string","description":"The name of the owner of the template.","default":"","x-example":"<TEMPLATE_OWNER>"},"templateRootDirectory":{"type":"string","description":"Path to function code in the template repo.","default":"","x-example":"<TEMPLATE_ROOT_DIRECTORY>"},"templateBranch":{"type":"string","description":"Production branch for the repo linked to the function template.","default":"","x-example":"<TEMPLATE_BRANCH>"}},"required":["functionId","name","runtime"]}}]}},"\/functions\/runtimes":{"get":{"summary":"List runtimes","operationId":"functionsListRuntimes","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all runtimes that are currently active on your instance.","responses":{"200":{"description":"Runtimes List","schema":{"$ref":"#\/definitions\/runtimeList"}}},"x-appwrite":{"method":"listRuntimes","weight":288,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-runtimes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-runtimes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/functions\/{functionId}":{"get":{"summary":"Get function","operationId":"functionsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"get","weight":289,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"put":{"summary":"Update function","operationId":"functionsUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"update","weight":292,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":"","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.21","deno-1.24","deno-1.35","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Controle System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"}},"required":["name"]}}]},"delete":{"summary":"Delete function","operationId":"functionsDelete","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":295,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments":{"get":{"summary":"List deployments","operationId":"functionsListDeployments","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's code deployments. You can use the query params to filter your results.","responses":{"200":{"description":"Deployments List","schema":{"$ref":"#\/definitions\/deploymentList"}}},"x-appwrite":{"method":"listDeployments","weight":297,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: size, buildId, activate, entrypoint, commands","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create deployment","operationId":"functionsCreateDeployment","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.","responses":{"202":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"createDeployment","weight":296,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":true,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"entrypoint","description":"Entrypoint File.","required":false,"type":"string","x-example":"<ENTRYPOINT>","in":"formData"},{"name":"commands","description":"Build Commands.","required":false,"type":"string","x-example":"<COMMANDS>","in":"formData"},{"name":"code","description":"Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.","required":true,"type":"file","in":"formData"},{"name":"activate","description":"Automatically activate the deployment when it is finished building.","required":true,"type":"boolean","x-example":false,"in":"formData"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}":{"get":{"summary":"Get deployment","operationId":"functionsGetDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a code deployment by its unique ID.","responses":{"200":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"getDeployment","weight":298,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"patch":{"summary":"Update function deployment","operationId":"functionsUpdateDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"updateDeployment","weight":294,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"delete":{"summary":"Delete deployment","operationId":"functionsDeleteDeployment","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a code deployment by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDeployment","weight":299,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/build":{"post":{"summary":"Rebuild deployment","operationId":"functionsCreateBuild","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createBuild","weight":300,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"buildId":{"type":"string","description":"Build unique ID.","default":"","x-example":"<BUILD_ID>"}}}}]},"patch":{"summary":"Cancel deployment","operationId":"functionsUpdateDeploymentBuild","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"Build","schema":{"$ref":"#\/definitions\/build"}}},"x-appwrite":{"method":"updateDeploymentBuild","weight":301,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/download":{"get":{"summary":"Download Deployment","operationId":"functionsDownloadDeployment","consumes":["application\/json"],"produces":["*\/*"],"tags":["functions"],"description":"Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"downloadDeployment","weight":293,"cookies":false,"type":"location","deprecated":false,"demo":"functions\/download-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/download-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","schema":{"$ref":"#\/definitions\/executionList"}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","default":"","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","default":false,"x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","default":"\/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","default":"POST","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","default":[],"x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]},"delete":{"summary":"Delete execution","operationId":"functionsDeleteExecution","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function execution by its unique ID.\n","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteExecution","weight":305,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/variables":{"get":{"summary":"List variables","operationId":"functionsListVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all variables of a specific function.","responses":{"200":{"description":"Variables List","schema":{"$ref":"#\/definitions\/variableList"}}},"x-appwrite":{"method":"listVariables","weight":307,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"post":{"summary":"Create variable","operationId":"functionsCreateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.","responses":{"201":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"createVariable","weight":306,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key","value"]}}]}},"\/functions\/{functionId}\/variables\/{variableId}":{"get":{"summary":"Get variable","operationId":"functionsGetVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"getVariable","weight":308,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]},"put":{"summary":"Update variable","operationId":"functionsUpdateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"updateVariable","weight":309,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key"]}}]},"delete":{"summary":"Delete variable","operationId":"functionsDeleteVariable","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a variable by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":310,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/health":{"get":{"summary":"Get HTTP","operationId":"healthGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite HTTP server is up and responsive.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"get","weight":124,"cookies":false,"type":"","deprecated":false,"demo":"health\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/anti-virus":{"get":{"summary":"Get antivirus","operationId":"healthGetAntivirus","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite Antivirus server is up and connection is successful.","responses":{"200":{"description":"Health Antivirus","schema":{"$ref":"#\/definitions\/healthAntivirus"}}},"x-appwrite":{"method":"getAntivirus","weight":146,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-antivirus.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/cache":{"get":{"summary":"Get cache","operationId":"healthGetCache","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite in-memory cache servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getCache","weight":127,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-cache.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/certificate":{"get":{"summary":"Get the SSL certificate for a domain","operationId":"healthGetCertificate","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the SSL certificate for a domain","responses":{"200":{"description":"Health Certificate","schema":{"$ref":"#\/definitions\/healthCertificate"}}},"x-appwrite":{"method":"getCertificate","weight":133,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-certificate.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"domain","description":"string","required":false,"type":"string","in":"query"}]}},"\/health\/db":{"get":{"summary":"Get DB","operationId":"healthGetDB","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite database servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getDB","weight":126,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-d-b.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/pubsub":{"get":{"summary":"Get pubsub","operationId":"healthGetPubSub","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite pub-sub servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getPubSub","weight":129,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-pub-sub.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue":{"get":{"summary":"Get queue","operationId":"healthGetQueue","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite queue messaging servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getQueue","weight":128,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue\/builds":{"get":{"summary":"Get builds queue","operationId":"healthGetQueueBuilds","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of builds that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueBuilds","weight":135,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-builds.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/certificates":{"get":{"summary":"Get certificates queue","operationId":"healthGetQueueCertificates","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of certificates that are waiting to be issued against [Letsencrypt](https:\/\/letsencrypt.org\/) in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueCertificates","weight":134,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-certificates.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/databases":{"get":{"summary":"Get databases queue","operationId":"healthGetQueueDatabases","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDatabases","weight":136,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-databases.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"Queue name for which to check the queue size","required":false,"type":"string","x-example":"<NAME>","default":"database_db_main","in":"query"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/deletes":{"get":{"summary":"Get deletes queue","operationId":"healthGetQueueDeletes","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDeletes","weight":137,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-deletes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/failed\/{name}":{"get":{"summary":"Get number of failed queue jobs","operationId":"healthGetFailedJobs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Returns the amount of failed jobs in a given queue.\n","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getFailedJobs","weight":147,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-failed-jobs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"The name of the queue","required":true,"type":"string","x-example":"v1-database","enum":["v1-database","v1-deletes","v1-audits","v1-mails","v1-functions","v1-usage","v1-usage-dump","v1-webhooks","v1-certificates","v1-builds","v1-messaging","v1-migrations"],"x-enum-name":null,"x-enum-keys":[],"in":"path"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/functions":{"get":{"summary":"Get functions queue","operationId":"healthGetQueueFunctions","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueFunctions","weight":141,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-functions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/logs":{"get":{"summary":"Get logs queue","operationId":"healthGetQueueLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of logs that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueLogs","weight":132,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/mails":{"get":{"summary":"Get mails queue","operationId":"healthGetQueueMails","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of mails that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMails","weight":138,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-mails.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/messaging":{"get":{"summary":"Get messaging queue","operationId":"healthGetQueueMessaging","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of messages that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMessaging","weight":139,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-messaging.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/migrations":{"get":{"summary":"Get migrations queue","operationId":"healthGetQueueMigrations","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMigrations","weight":140,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-migrations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage":{"get":{"summary":"Get usage queue","operationId":"healthGetQueueUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsage","weight":142,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage-dump":{"get":{"summary":"Get usage dump queue","operationId":"healthGetQueueUsageDump","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsageDump","weight":143,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage-dump.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage-dump.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/webhooks":{"get":{"summary":"Get webhooks queue","operationId":"healthGetQueueWebhooks","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueWebhooks","weight":131,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/storage":{"get":{"summary":"Get storage","operationId":"healthGetStorage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorage","weight":145,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/storage\/local":{"get":{"summary":"Get local storage","operationId":"healthGetStorageLocal","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite local storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorageLocal","weight":144,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage-local.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/time":{"get":{"summary":"Get time","operationId":"healthGetTime","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https:\/\/en.wikipedia.org\/wiki\/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.","responses":{"200":{"description":"Health Time","schema":{"$ref":"#\/definitions\/healthTime"}}},"x-appwrite":{"method":"getTime","weight":130,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-time.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","schema":{"$ref":"#\/definitions\/locale"}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","schema":{"$ref":"#\/definitions\/localeCodeList"}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","schema":{"$ref":"#\/definitions\/continentList"}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","schema":{"$ref":"#\/definitions\/phoneList"}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","schema":{"$ref":"#\/definitions\/currencyList"}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","schema":{"$ref":"#\/definitions\/languageList"}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/messaging\/messages":{"get":{"summary":"List messages","operationId":"messagingListMessages","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all messages from the current Appwrite project.","responses":{"200":{"description":"Message list","schema":{"$ref":"#\/definitions\/messageList"}}},"x-appwrite":{"method":"listMessages","weight":385,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-messages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/messages\/email":{"post":{"summary":"Create email","operationId":"messagingCreateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new email message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createEmail","weight":382,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":[],"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":[],"x-example":null,"items":{"type":"string"}},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","subject","content"]}}]}},"\/messaging\/messages\/email\/{messageId}":{"patch":{"summary":"Update email","operationId":"messagingUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateEmail","weight":389,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":null,"x-example":false},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":null,"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":null,"x-example":null,"items":{"type":"string"}},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":null,"items":{"type":"string"}}}}}]}},"\/messaging\/messages\/push":{"post":{"summary":"Create push notification","operationId":"messagingCreatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new push notification.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createPush","weight":384,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":"","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":"","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web Platform.","default":"","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and IOS Platform.","default":"","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android Platform.","default":"","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android Platform.","default":"","x-example":"<TAG>"},"badge":{"type":"string","description":"Badge for push notification. Available only for IOS Platform.","default":"","x-example":"<BADGE>"},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","title","body"]}}]}},"\/messaging\/messages\/push\/{messageId}":{"patch":{"summary":"Update push notification","operationId":"messagingUpdatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a push notification by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updatePush","weight":391,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":null,"x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web platforms.","default":null,"x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and iOS platforms.","default":null,"x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android platforms.","default":null,"x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android platforms.","default":null,"x-example":"<TAG>"},"badge":{"type":"integer","description":"Badge for push notification. Available only for iOS platforms.","default":null,"x-example":null},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/sms":{"post":{"summary":"Create SMS","operationId":"messagingCreateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMS message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createSms","weight":383,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"content":{"type":"string","description":"SMS Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","content"]}}]}},"\/messaging\/messages\/sms\/{messageId}":{"patch":{"summary":"Update SMS","operationId":"messagingUpdateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateSms","weight":390,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/{messageId}":{"get":{"summary":"Get message","operationId":"messagingGetMessage","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"getMessage","weight":388,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-message.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]},"delete":{"summary":"Delete message","operationId":"messagingDelete","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":392,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]}},"\/messaging\/messages\/{messageId}\/logs":{"get":{"summary":"List message logs","operationId":"messagingListMessageLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the message activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listMessageLogs","weight":386,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-message-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/messages\/{messageId}\/targets":{"get":{"summary":"List message targets","operationId":"messagingListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of the targets associated with a message.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":387,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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, providerId, identifier, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/providers":{"get":{"summary":"List providers","operationId":"messagingListProviders","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all providers from the current Appwrite project.","responses":{"200":{"description":"Provider list","schema":{"$ref":"#\/definitions\/providerList"}}},"x-appwrite":{"method":"listProviders","weight":357,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-providers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/providers\/apns":{"post":{"summary":"Create APNS provider","operationId":"messagingCreateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Apple Push Notification service provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createApnsProvider","weight":356,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/apns\/{providerId}":{"patch":{"summary":"Update APNS provider","operationId":"messagingUpdateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Apple Push Notification service provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateApnsProvider","weight":369,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/fcm":{"post":{"summary":"Create FCM provider","operationId":"messagingCreateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Firebase Cloud Messaging provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createFcmProvider","weight":355,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/fcm\/{providerId}":{"patch":{"summary":"Update FCM provider","operationId":"messagingUpdateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Firebase Cloud Messaging provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateFcmProvider","weight":368,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"}}}}]}},"\/messaging\/providers\/mailgun":{"post":{"summary":"Create Mailgun provider","operationId":"messagingCreateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Mailgun provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMailgunProvider","weight":347,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/mailgun\/{providerId}":{"patch":{"summary":"Update Mailgun provider","operationId":"messagingUpdateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Mailgun provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMailgunProvider","weight":360,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/msg91":{"post":{"summary":"Create Msg91 provider","operationId":"messagingCreateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new MSG91 provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMsg91Provider","weight":350,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"templateId":{"type":"string","description":"Msg91 template ID","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/msg91\/{providerId}":{"patch":{"summary":"Update Msg91 provider","operationId":"messagingUpdateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a MSG91 provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMsg91Provider","weight":363,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"templateId":{"type":"string","description":"Msg91 template ID.","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"}}}}]}},"\/messaging\/providers\/sendgrid":{"post":{"summary":"Create Sendgrid provider","operationId":"messagingCreateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Sendgrid provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSendgridProvider","weight":348,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/sendgrid\/{providerId}":{"patch":{"summary":"Update Sendgrid provider","operationId":"messagingUpdateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Sendgrid provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSendgridProvider","weight":361,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/smtp":{"post":{"summary":"Create SMTP provider","operationId":"messagingCreateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMTP provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSmtpProvider","weight":349,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":null,"x-example":"<HOST>"},"port":{"type":"integer","description":"The default SMTP server port.","default":587,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be omitted, 'ssl', or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":true,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name","host"]}}]}},"\/messaging\/providers\/smtp\/{providerId}":{"patch":{"summary":"Update SMTP provider","operationId":"messagingUpdateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a SMTP provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSmtpProvider","weight":362,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":"","x-example":"<HOST>"},"port":{"type":"integer","description":"SMTP port.","default":null,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be 'ssl' or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":null,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/telesign":{"post":{"summary":"Create Telesign provider","operationId":"messagingCreateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Telesign provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTelesignProvider","weight":351,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/telesign\/{providerId}":{"patch":{"summary":"Update Telesign provider","operationId":"messagingUpdateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Telesign provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTelesignProvider","weight":364,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/textmagic":{"post":{"summary":"Create Textmagic provider","operationId":"messagingCreateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Textmagic provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTextmagicProvider","weight":352,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/textmagic\/{providerId}":{"patch":{"summary":"Update Textmagic provider","operationId":"messagingUpdateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Textmagic provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTextmagicProvider","weight":365,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/twilio":{"post":{"summary":"Create Twilio provider","operationId":"messagingCreateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Twilio provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTwilioProvider","weight":353,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/twilio\/{providerId}":{"patch":{"summary":"Update Twilio provider","operationId":"messagingUpdateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Twilio provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTwilioProvider","weight":366,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/vonage":{"post":{"summary":"Create Vonage provider","operationId":"messagingCreateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Vonage provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createVonageProvider","weight":354,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/vonage\/{providerId}":{"patch":{"summary":"Update Vonage provider","operationId":"messagingUpdateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Vonage provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateVonageProvider","weight":367,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/{providerId}":{"get":{"summary":"Get provider","operationId":"messagingGetProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a provider by its unique ID.\n","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"getProvider","weight":359,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]},"delete":{"summary":"Delete provider","operationId":"messagingDeleteProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a provider by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteProvider","weight":370,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]}},"\/messaging\/providers\/{providerId}\/logs":{"get":{"summary":"List provider logs","operationId":"messagingListProviderLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the provider activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listProviderLogs","weight":358,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-provider-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/subscribers\/{subscriberId}\/logs":{"get":{"summary":"List subscriber logs","operationId":"messagingListSubscriberLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the subscriber activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listSubscriberLogs","weight":379,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscriber-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics":{"get":{"summary":"List topics","operationId":"messagingListTopics","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all topics from the current Appwrite project.","responses":{"200":{"description":"Topic list","schema":{"$ref":"#\/definitions\/topicList"}}},"x-appwrite":{"method":"listTopics","weight":372,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topics.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, description, emailTotal, smsTotal, pushTotal","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create topic","operationId":"messagingCreateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new topic.","responses":{"201":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"createTopic","weight":371,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"topicId":{"type":"string","description":"Topic ID. Choose a custom Topic ID or a new Topic ID.","default":null,"x-example":"<TOPIC_ID>"},"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":["users"],"x-example":"[\"any\"]","items":{"type":"string"}}},"required":["topicId","name"]}}]}},"\/messaging\/topics\/{topicId}":{"get":{"summary":"Get topic","operationId":"messagingGetTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"getTopic","weight":374,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]},"patch":{"summary":"Update topic","operationId":"messagingUpdateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"updateTopic","weight":375,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":null,"x-example":"[\"any\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete topic","operationId":"messagingDeleteTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a topic by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTopic","weight":376,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]}},"\/messaging\/topics\/{topicId}\/logs":{"get":{"summary":"List topic logs","operationId":"messagingListTopicLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the topic activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listTopicLogs","weight":373,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topic-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"get":{"summary":"List subscribers","operationId":"messagingListSubscribers","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all subscribers from the current Appwrite project.","responses":{"200":{"description":"Subscriber list","schema":{"$ref":"#\/definitions\/subscriberList"}}},"x-appwrite":{"method":"listSubscribers","weight":378,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscribers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"JWT":[]}},"security":[{"Project":[],"JWT":[],"Session":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","default":null,"x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","default":null,"x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}]}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"get":{"summary":"Get subscriber","operationId":"messagingGetSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a subscriber by its unique ID.\n","responses":{"200":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"getSubscriber","weight":380,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]},"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"JWT":[]}},"security":[{"Project":[],"JWT":[],"Session":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]}},"\/storage\/buckets":{"get":{"summary":"List buckets","operationId":"storageListBuckets","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the storage buckets. You can use the query params to filter your results.","responses":{"200":{"description":"Buckets List","schema":{"$ref":"#\/definitions\/bucketList"}}},"x-appwrite":{"method":"listBuckets","weight":201,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-buckets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create bucket","operationId":"storageCreateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new storage bucket.","responses":{"201":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"createBucket","weight":200,"cookies":false,"type":"","deprecated":false,"demo":"storage\/create-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"bucketId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<BUCKET_ID>"},"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["bucketId","name"]}}]}},"\/storage\/buckets\/{bucketId}":{"get":{"summary":"Get bucket","operationId":"storageGetBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"getBucket","weight":202,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]},"put":{"summary":"Update bucket","operationId":"storageUpdateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a storage bucket by its unique ID.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"updateBucket","weight":203,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete bucket","operationId":"storageDeleteBucket","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a storage bucket by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteBucket","weight":204,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","schema":{"$ref":"#\/definitions\/fileList"}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"x-upload-id":true,"type":"string","x-example":"<FILE_ID>","in":"formData"},{"name":"file","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","required":true,"type":"file","in":"formData"},{"name":"permissions","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"x-example":"[\"read(\"any\")\"]","in":"formData"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","consumes":["application\/json"],"produces":["image\/*"],"tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center","in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"type":"number","format":"float","x-example":0,"default":1,"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"type":"integer","format":"int32","x-example":-360,"default":0,"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":"","in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","schema":{"$ref":"#\/definitions\/teamList"}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":["owner"],"x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}]}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]},"delete":{"summary":"Delete team","operationId":"teamsDelete","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","default":"","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","default":"","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","default":"","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["roles"]}}]}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["roles"]}}]},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users":{"get":{"summary":"List users","operationId":"usersList","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a list of all the project's users. You can use the query params to filter your results.","responses":{"200":{"description":"Users List","schema":{"$ref":"#\/definitions\/userList"}}},"x-appwrite":{"method":"list","weight":239,"cookies":false,"type":"","deprecated":false,"demo":"users\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create user","operationId":"usersCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":230,"cookies":false,"type":"","deprecated":false,"demo":"users\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"Plain text user password. Must be at least 8 chars.","default":"","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId"]}}]}},"\/users\/argon2":{"post":{"summary":"Create user with Argon2 password","operationId":"usersCreateArgon2User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createArgon2User","weight":233,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-argon2user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Argon2.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/bcrypt":{"post":{"summary":"Create user with bcrypt password","operationId":"usersCreateBcryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createBcryptUser","weight":231,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-bcrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Bcrypt.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/identities":{"get":{"summary":"List Identities","operationId":"usersListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get identities for all users.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":247,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/users\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"usersDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":270,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/users\/md5":{"post":{"summary":"Create user with MD5 password","operationId":"usersCreateMD5User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createMD5User","weight":232,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-m-d5user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using MD5.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/phpass":{"post":{"summary":"Create user with PHPass password","operationId":"usersCreatePHPassUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createPHPassUser","weight":235,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-p-h-pass-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using PHPass.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/scrypt":{"post":{"summary":"Create user with Scrypt password","operationId":"usersCreateScryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptUser","weight":236,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Optional salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordCpu":{"type":"integer","description":"Optional CPU cost used to hash password.","default":null,"x-example":null},"passwordMemory":{"type":"integer","description":"Optional memory cost used to hash password.","default":null,"x-example":null},"passwordParallel":{"type":"integer","description":"Optional parallelization cost used to hash password.","default":null,"x-example":null},"passwordLength":{"type":"integer","description":"Optional hash length used to hash password.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordCpu","passwordMemory","passwordParallel","passwordLength"]}}]}},"\/users\/scrypt-modified":{"post":{"summary":"Create user with Scrypt modified password","operationId":"usersCreateScryptModifiedUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptModifiedUser","weight":237,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-modified-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt Modified.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordSaltSeparator":{"type":"string","description":"Salt separator used to hash password.","default":null,"x-example":"<PASSWORD_SALT_SEPARATOR>"},"passwordSignerKey":{"type":"string","description":"Signer key used to hash password.","default":null,"x-example":"<PASSWORD_SIGNER_KEY>"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordSaltSeparator","passwordSignerKey"]}}]}},"\/users\/sha":{"post":{"summary":"Create user with SHA password","operationId":"usersCreateSHAUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createSHAUser","weight":234,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-s-h-a-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using SHA.","default":null,"x-example":"password"},"passwordVersion":{"type":"string","description":"Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'","default":"","x-example":"sha1","enum":["sha1","sha224","sha256","sha384","sha512\/224","sha512\/256","sha512","sha3-224","sha3-256","sha3-384","sha3-512"],"x-enum-name":"PasswordHash","x-enum-keys":[]},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/{userId}":{"get":{"summary":"Get user","operationId":"usersGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":240,"cookies":false,"type":"","deprecated":false,"demo":"users\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user","operationId":"usersDelete","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":268,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/email":{"patch":{"summary":"Update email","operationId":"usersUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":253,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"}},"required":["email"]}}]}},"\/users\/{userId}\/jwts":{"post":{"summary":"Create user JWT","operationId":"usersCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":271,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.","default":"recent","x-example":"<SESSION_ID>"},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","default":900,"x-example":0}}}}]}},"\/users\/{userId}\/labels":{"put":{"summary":"Update user labels","operationId":"usersUpdateLabels","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateLabels","weight":249,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-labels.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"labels":{"type":"array","description":"Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["labels"]}}]}},"\/users\/{userId}\/logs":{"get":{"summary":"List user logs","operationId":"usersListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":245,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/users\/{userId}\/memberships":{"get":{"summary":"List user memberships","operationId":"usersListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user membership list by its unique ID.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":244,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa":{"patch":{"summary":"Update MFA","operationId":"usersUpdateMfa","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Enable or disable MFA on a user account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfa","weight":258,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/users\/{userId}\/mfa\/authenticators\/{type}":{"delete":{"summary":"Delete Authenticator","operationId":"usersDeleteMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete an authenticator app.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":263,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/users\/{userId}\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"usersListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":259,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"usersGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":260,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"put":{"summary":"Regenerate MFA Recovery Codes","operationId":"usersUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":262,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Create MFA Recovery Codes","operationId":"usersCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":261,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/name":{"patch":{"summary":"Update name","operationId":"usersUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user name by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":251,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/users\/{userId}\/password":{"patch":{"summary":"Update password","operationId":"usersUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user password by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":252,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null}},"required":["password"]}}]}},"\/users\/{userId}\/phone":{"patch":{"summary":"Update phone","operationId":"usersUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":254,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"number":{"type":"string","description":"User phone number.","default":null,"x-example":"+12065550100"}},"required":["number"]}}]}},"\/users\/{userId}\/prefs":{"get":{"summary":"Get user preferences","operationId":"usersGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user preferences by its unique ID.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":241,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Update user preferences","operationId":"usersUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user preferences by its unique ID. 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.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":256,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users\/{userId}\/sessions":{"get":{"summary":"List user sessions","operationId":"usersListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user sessions list by its unique ID.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":243,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"post":{"summary":"Create session","operationId":"usersCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":264,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user sessions","operationId":"usersDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete all user's sessions by using the user's unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":267,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/sessions\/{sessionId}":{"delete":{"summary":"Delete user session","operationId":"usersDeleteSession","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user sessions by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":266,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"sessionId","description":"Session ID.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/users\/{userId}\/status":{"patch":{"summary":"Update user status","operationId":"usersUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":248,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"User Status. To activate the user pass `true` and to block the user pass `false`.","default":null,"x-example":false}},"required":["status"]}}]}},"\/users\/{userId}\/targets":{"get":{"summary":"List User Targets","operationId":"usersListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the messaging targets that are associated with a user.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":246,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create User Target","operationId":"usersCreateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a messaging target.","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createTarget","weight":238,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","default":null,"x-example":"email","enum":["email","sms","push"],"x-enum-name":"MessagingProviderType","x-enum-keys":[]},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}},"required":["targetId","providerType","identifier"]}}]}},"\/users\/{userId}\/targets\/{targetId}":{"get":{"summary":"Get User Target","operationId":"usersGetTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user's push notification target by ID.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"getTarget","weight":242,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]},"patch":{"summary":"Update User target","operationId":"usersUpdateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update a messaging target.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updateTarget","weight":257,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":"","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}}}}]},"delete":{"summary":"Delete user target","operationId":"usersDeleteTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete a messaging target.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTarget","weight":269,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/users\/{userId}\/tokens":{"post":{"summary":"Create token","operationId":"usersCreateToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createToken","weight":265,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"length":{"type":"integer","description":"Token length in characters. The default length is 6 characters","default":6,"x-example":4},"expire":{"type":"integer","description":"Token expiration period in seconds. The default expiration is 15 minutes.","default":900,"x-example":60}}}}]}},"\/users\/{userId}\/verification":{"patch":{"summary":"Update email verification","operationId":"usersUpdateEmailVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmailVerification","weight":255,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"emailVerification":{"type":"boolean","description":"User email verification status.","default":null,"x-example":false}},"required":["emailVerification"]}}]}},"\/users\/{userId}\/verification\/phone":{"patch":{"summary":"Update phone verification","operationId":"usersUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":250,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"phoneVerification":{"type":"boolean","description":"User phone verification status.","default":null,"x-example":false}},"required":["phoneVerification"]}}]}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"definitions":{"any":{"description":"Any","type":"object","additionalProperties":true},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"type":"object","$ref":"#\/definitions\/document"},"x-example":""}},"required":["total","documents"]},"collectionList":{"description":"Collections List","type":"object","properties":{"total":{"type":"integer","description":"Total number of collections documents that matched your query.","x-example":5,"format":"int32"},"collections":{"type":"array","description":"List of collections.","items":{"type":"object","$ref":"#\/definitions\/collection"},"x-example":""}},"required":["total","collections"]},"databaseList":{"description":"Databases List","type":"object","properties":{"total":{"type":"integer","description":"Total number of databases documents that matched your query.","x-example":5,"format":"int32"},"databases":{"type":"array","description":"List of databases.","items":{"type":"object","$ref":"#\/definitions\/database"},"x-example":""}},"required":["total","databases"]},"indexList":{"description":"Indexes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of indexes documents that matched your query.","x-example":5,"format":"int32"},"indexes":{"type":"array","description":"List of indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":""}},"required":["total","indexes"]},"userList":{"description":"Users List","type":"object","properties":{"total":{"type":"integer","description":"Total number of users documents that matched your query.","x-example":5,"format":"int32"},"users":{"type":"array","description":"List of users.","items":{"type":"object","$ref":"#\/definitions\/user"},"x-example":""}},"required":["total","users"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"type":"object","$ref":"#\/definitions\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"type":"object","$ref":"#\/definitions\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"type":"object","$ref":"#\/definitions\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"type":"object","$ref":"#\/definitions\/file"},"x-example":""}},"required":["total","files"]},"bucketList":{"description":"Buckets List","type":"object","properties":{"total":{"type":"integer","description":"Total number of buckets documents that matched your query.","x-example":5,"format":"int32"},"buckets":{"type":"array","description":"List of buckets.","items":{"type":"object","$ref":"#\/definitions\/bucket"},"x-example":""}},"required":["total","buckets"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"type":"object","$ref":"#\/definitions\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"type":"object","$ref":"#\/definitions\/membership"},"x-example":""}},"required":["total","memberships"]},"functionList":{"description":"Functions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of functions documents that matched your query.","x-example":5,"format":"int32"},"functions":{"type":"array","description":"List of functions.","items":{"type":"object","$ref":"#\/definitions\/function"},"x-example":""}},"required":["total","functions"]},"runtimeList":{"description":"Runtimes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of runtimes documents that matched your query.","x-example":5,"format":"int32"},"runtimes":{"type":"array","description":"List of runtimes.","items":{"type":"object","$ref":"#\/definitions\/runtime"},"x-example":""}},"required":["total","runtimes"]},"deploymentList":{"description":"Deployments List","type":"object","properties":{"total":{"type":"integer","description":"Total number of deployments documents that matched your query.","x-example":5,"format":"int32"},"deployments":{"type":"array","description":"List of deployments.","items":{"type":"object","$ref":"#\/definitions\/deployment"},"x-example":""}},"required":["total","deployments"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"type":"object","$ref":"#\/definitions\/execution"},"x-example":""}},"required":["total","executions"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"type":"object","$ref":"#\/definitions\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"type":"object","$ref":"#\/definitions\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"type":"object","$ref":"#\/definitions\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"type":"object","$ref":"#\/definitions\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"type":"object","$ref":"#\/definitions\/phone"},"x-example":""}},"required":["total","phones"]},"variableList":{"description":"Variables List","type":"object","properties":{"total":{"type":"integer","description":"Total number of variables documents that matched your query.","x-example":5,"format":"int32"},"variables":{"type":"array","description":"List of variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":""}},"required":["total","variables"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"type":"object","$ref":"#\/definitions\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"providerList":{"description":"Provider list","type":"object","properties":{"total":{"type":"integer","description":"Total number of providers documents that matched your query.","x-example":5,"format":"int32"},"providers":{"type":"array","description":"List of providers.","items":{"type":"object","$ref":"#\/definitions\/provider"},"x-example":""}},"required":["total","providers"]},"messageList":{"description":"Message list","type":"object","properties":{"total":{"type":"integer","description":"Total number of messages documents that matched your query.","x-example":5,"format":"int32"},"messages":{"type":"array","description":"List of messages.","items":{"type":"object","$ref":"#\/definitions\/message"},"x-example":""}},"required":["total","messages"]},"topicList":{"description":"Topic list","type":"object","properties":{"total":{"type":"integer","description":"Total number of topics documents that matched your query.","x-example":5,"format":"int32"},"topics":{"type":"array","description":"List of topics.","items":{"type":"object","$ref":"#\/definitions\/topic"},"x-example":""}},"required":["total","topics"]},"subscriberList":{"description":"Subscriber list","type":"object","properties":{"total":{"type":"integer","description":"Total number of subscribers documents that matched your query.","x-example":5,"format":"int32"},"subscribers":{"type":"array","description":"List of subscribers.","items":{"type":"object","$ref":"#\/definitions\/subscriber"},"x-example":""}},"required":["total","subscribers"]},"targetList":{"description":"Target list","type":"object","properties":{"total":{"type":"integer","description":"Total number of targets documents that matched your query.","x-example":5,"format":"int32"},"targets":{"type":"array","description":"List of targets.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":""}},"required":["total","targets"]},"database":{"description":"Database","type":"object","properties":{"$id":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Database name.","x-example":"My Database"},"$createdAt":{"type":"string","description":"Database creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Database update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"enabled":{"type":"boolean","description":"If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false}},"required":["$id","name","$createdAt","$updatedAt","enabled"]},"collection":{"description":"Collection","type":"object","properties":{"$id":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Collection creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Collection update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Collection name.","x-example":"My Collection"},"enabled":{"type":"boolean","description":"Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false},"documentSecurity":{"type":"boolean","description":"Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"attributes":{"type":"array","description":"Collection attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":{}},"indexes":{"type":"array","description":"Collection indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":{}}},"required":["$id","$createdAt","$updatedAt","$permissions","databaseId","name","enabled","documentSecurity","attributes","indexes"]},"attributeList":{"description":"Attributes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of attributes in the given collection.","x-example":5,"format":"int32"},"attributes":{"type":"array","description":"List of attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":""}},"required":["total","attributes"]},"attributeString":{"description":"AttributeString","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"size":{"type":"integer","description":"Attribute size.","x-example":128,"format":"int32"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default","x-nullable":true}},"required":["key","type","status","error","required","size"]},"attributeInteger":{"description":"AttributeInteger","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"count"},"type":{"type":"string","description":"Attribute type.","x-example":"integer"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"integer","description":"Minimum value to enforce for new documents.","x-example":1,"format":"int32","x-nullable":true},"max":{"type":"integer","description":"Maximum value to enforce for new documents.","x-example":10,"format":"int32","x-nullable":true},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":10,"format":"int32","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeFloat":{"description":"AttributeFloat","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"percentageCompleted"},"type":{"type":"string","description":"Attribute type.","x-example":"double"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"number","description":"Minimum value to enforce for new documents.","x-example":1.5,"format":"double","x-nullable":true},"max":{"type":"number","description":"Maximum value to enforce for new documents.","x-example":10.5,"format":"double","x-nullable":true},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":2.5,"format":"double","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeBoolean":{"description":"AttributeBoolean","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"isEnabled"},"type":{"type":"string","description":"Attribute type.","x-example":"boolean"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"x-nullable":true}},"required":["key","type","status","error","required"]},"attributeEmail":{"description":"AttributeEmail","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"userEmail"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"email"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default@example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeEnum":{"description":"AttributeEnum","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"status"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"elements":{"type":"array","description":"Array of elements in enumerated type.","items":{"type":"string"},"x-example":"element"},"format":{"type":"string","description":"String format.","x-example":"enum"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"element","x-nullable":true}},"required":["key","type","status","error","required","elements","format"]},"attributeIp":{"description":"AttributeIP","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"ipAddress"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"ip"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"192.0.2.0","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeUrl":{"description":"AttributeURL","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"githubUrl"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"url"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"http:\/\/example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeDatetime":{"description":"AttributeDatetime","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"birthDay"},"type":{"type":"string","description":"Attribute type.","x-example":"datetime"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"ISO 8601 format.","x-example":"datetime"},"default":{"type":"string","description":"Default value for attribute when not provided. Only null is optional","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeRelationship":{"description":"AttributeRelationship","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"relatedCollection":{"type":"string","description":"The ID of the related collection.","x-example":"collection"},"relationType":{"type":"string","description":"The type of the relationship.","x-example":"oneToOne|oneToMany|manyToOne|manyToMany"},"twoWay":{"type":"boolean","description":"Is the relationship two-way?","x-example":false},"twoWayKey":{"type":"string","description":"The key of the two-way relationship.","x-example":"string"},"onDelete":{"type":"string","description":"How deleting the parent document will propagate to child documents.","x-example":"restrict|cascade|setNull"},"side":{"type":"string","description":"Whether this is the parent or child side of the relationship","x-example":"parent|child"}},"required":["key","type","status","error","required","relatedCollection","relationType","twoWay","twoWayKey","onDelete","side"]},"index":{"description":"Index","type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":"index1"},"type":{"type":"string","description":"Index type.","x-example":"primary"},"status":{"type":"string","description":"Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an index.","x-example":"string"},"attributes":{"type":"array","description":"Index attributes.","items":{"type":"string"},"x-example":[]},"orders":{"type":"array","description":"Index orders.","items":{"type":"string"},"x-example":[],"x-nullable":true}},"required":["key","type","status","error","attributes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","x-nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","x-nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"x-oneOf":[{"$ref":"#\/definitions\/algoArgon2"},{"$ref":"#\/definitions\/algoScrypt"},{"$ref":"#\/definitions\/algoScryptModified"},{"$ref":"#\/definitions\/algoBcrypt"},{"$ref":"#\/definitions\/algoPhpass"},{"$ref":"#\/definitions\/algoSha"},{"$ref":"#\/definitions\/algoMd5"}]},"x-nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"bucket":{"description":"Bucket","type":"object","properties":{"$id":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Bucket creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Bucket update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"fileSecurity":{"type":"boolean","description":"Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"name":{"type":"string","description":"Bucket name.","x-example":"Documents"},"enabled":{"type":"boolean","description":"Bucket enabled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size supported.","x-example":100,"format":"int32"},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions.","items":{"type":"string"},"x-example":["jpg","png"]},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).","x-example":"gzip"},"encryption":{"type":"boolean","description":"Bucket is encrypted.","x-example":false},"antivirus":{"type":"boolean","description":"Virus scanning is enabled.","x-example":false}},"required":["$id","$createdAt","$updatedAt","$permissions","fileSecurity","name","enabled","maximumFileSize","allowedFileExtensions","compression","encryption","antivirus"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"function":{"description":"Function","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"execute":{"type":"array","description":"Execution permissions.","items":{"type":"string"},"x-example":"users"},"name":{"type":"string","description":"Function name.","x-example":"My Function"},"enabled":{"type":"boolean","description":"Function enabled.","x-example":false},"live":{"type":"boolean","description":"Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"runtime":{"type":"string","description":"Function execution runtime.","x-example":"python-3.8"},"deployment":{"type":"string","description":"Function's active deployment ID.","x-example":"5e5ea5c16897e"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"vars":{"type":"array","description":"Function variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":[]},"events":{"type":"array","description":"Function trigger events.","items":{"type":"string"},"x-example":"account.create"},"schedule":{"type":"string","description":"Function execution schedult in CRON format.","x-example":"5 4 * * *"},"timeout":{"type":"integer","description":"Function execution timeout in seconds.","x-example":300,"format":"int32"},"entrypoint":{"type":"string","description":"The entrypoint file used to execute the deployment.","x-example":"index.js"},"commands":{"type":"string","description":"The build command used to build the deployment.","x-example":"npm install"},"version":{"type":"string","description":"Version of Open Runtimes used for the function.","x-example":"v2"},"installationId":{"type":"string","description":"Function VCS (Version Control System) installation id.","x-example":"6m40at4ejk5h2u9s1hboo"},"providerRepositoryId":{"type":"string","description":"VCS (Version Control System) Repository ID","x-example":"appwrite"},"providerBranch":{"type":"string","description":"VCS (Version Control System) branch name","x-example":"main"},"providerRootDirectory":{"type":"string","description":"Path to function in VCS (Version Control System) repository","x-example":"functions\/helloWorld"},"providerSilentMode":{"type":"boolean","description":"Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests","x-example":false}},"required":["$id","$createdAt","$updatedAt","execute","name","enabled","live","logging","runtime","deployment","scopes","vars","events","schedule","timeout","entrypoint","commands","version","installationId","providerRepositoryId","providerBranch","providerRootDirectory","providerSilentMode"]},"runtime":{"description":"Runtime","type":"object","properties":{"$id":{"type":"string","description":"Runtime ID.","x-example":"python-3.8"},"name":{"type":"string","description":"Runtime Name.","x-example":"Python"},"version":{"type":"string","description":"Runtime version.","x-example":"3.8"},"base":{"type":"string","description":"Base Docker image used to build the runtime.","x-example":"python:3.8-alpine"},"image":{"type":"string","description":"Image name of Docker Hub.","x-example":"appwrite\\\/runtime-for-python:3.8"},"logo":{"type":"string","description":"Name of the logo image.","x-example":"python.png"},"supports":{"type":"array","description":"List of supported architectures.","items":{"type":"string"},"x-example":"amd64"}},"required":["$id","name","version","base","image","logo","supports"]},"deployment":{"description":"Deployment","type":"object","properties":{"$id":{"type":"string","description":"Deployment ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Deployment update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"type":{"type":"string","description":"Type of deployment.","x-example":"vcs"},"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea6g16897e"},"resourceType":{"type":"string","description":"Resource type.","x-example":"functions"},"entrypoint":{"type":"string","description":"The entrypoint file to use to execute the deployment code.","x-example":"index.js"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"},"buildId":{"type":"string","description":"The current build ID.","x-example":"5e5ea5c16897e"},"activate":{"type":"boolean","description":"Whether the deployment should be automatically activated.","x-example":true},"status":{"type":"string","description":"The deployment status. Possible values are \"processing\", \"building\", \"waiting\", \"ready\", and \"failed\".","x-example":"ready"},"buildLogs":{"type":"string","description":"The build logs.","x-example":"Compiling source files..."},"buildTime":{"type":"integer","description":"The current build time in seconds.","x-example":128,"format":"int32"},"providerRepositoryName":{"type":"string","description":"The name of the vcs provider repository","x-example":"database"},"providerRepositoryOwner":{"type":"string","description":"The name of the vcs provider repository owner","x-example":"utopia"},"providerRepositoryUrl":{"type":"string","description":"The url of the vcs provider repository","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function"},"providerBranch":{"type":"string","description":"The branch of the vcs repository","x-example":"0.7.x"},"providerCommitHash":{"type":"string","description":"The commit hash of the vcs commit","x-example":"7c3f25d"},"providerCommitAuthorUrl":{"type":"string","description":"The url of vcs commit author","x-example":"https:\/\/github.com\/vermakhushboo"},"providerCommitAuthor":{"type":"string","description":"The name of vcs commit author","x-example":"Khushboo Verma"},"providerCommitMessage":{"type":"string","description":"The commit message","x-example":"Update index.js"},"providerCommitUrl":{"type":"string","description":"The url of the vcs commit","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"},"providerBranchUrl":{"type":"string","description":"The branch of the vcs repository","x-example":"https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"}},"required":["$id","$createdAt","$updatedAt","type","resourceId","resourceType","entrypoint","size","buildId","activate","status","buildLogs","buildTime","providerRepositoryName","providerRepositoryOwner","providerRepositoryUrl","providerBranch","providerCommitHash","providerCommitAuthorUrl","providerCommitAuthor","providerCommitMessage","providerCommitUrl","providerBranchUrl"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"build":{"description":"Build","type":"object","properties":{"$id":{"type":"string","description":"Build ID.","x-example":"5e5ea5c16897e"},"deploymentId":{"type":"string","description":"The deployment that created this build.","x-example":"5e5ea5c16897e"},"status":{"type":"string","description":"The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built","x-example":"ready"},"stdout":{"type":"string","description":"The stdout of the build.","x-example":""},"stderr":{"type":"string","description":"The stderr of the build.","x-example":""},"startTime":{"type":"string","description":"The deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"endTime":{"type":"string","description":"The time the build was finished in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"duration":{"type":"integer","description":"The build duration in seconds.","x-example":0,"format":"int32"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"}},"required":["$id","deploymentId","status","stdout","stderr","startTime","endTime","duration","size"]},"variable":{"description":"Variable","type":"object","properties":{"$id":{"type":"string","description":"Variable ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"key":{"type":"string","description":"Variable key.","x-example":"API_KEY"},"value":{"type":"string","description":"Variable value.","x-example":"myPa$$word1"},"resourceType":{"type":"string","description":"Service to which the variable belongs. Possible values are \"project\", \"function\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"}},"required":["$id","$createdAt","$updatedAt","key","value","resourceType","resourceId"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"healthAntivirus":{"description":"Health Antivirus","type":"object","properties":{"version":{"type":"string","description":"Antivirus version.","x-example":"1.0.0"},"status":{"type":"string","description":"Antivirus status. Possible values can are: `disabled`, `offline`, `online`","x-example":"online"}},"required":["version","status"]},"healthQueue":{"description":"Health Queue","type":"object","properties":{"size":{"type":"integer","description":"Amount of actions in the queue.","x-example":8,"format":"int32"}},"required":["size"]},"healthStatus":{"description":"Health Status","type":"object","properties":{"name":{"type":"string","description":"Name of the service.","x-example":"database"},"ping":{"type":"integer","description":"Duration in milliseconds how long the health check took.","x-example":128,"format":"int32"},"status":{"type":"string","description":"Service status. Possible values can are: `pass`, `fail`","x-example":"pass"}},"required":["name","ping","status"]},"healthCertificate":{"description":"Health Certificate","type":"object","properties":{"name":{"type":"string","description":"Certificate name","x-example":"\/CN=www.google.com"},"subjectSN":{"type":"string","description":"Subject SN","x-example":""},"issuerOrganisation":{"type":"string","description":"Issuer organisation","x-example":""},"validFrom":{"type":"string","description":"Valid from","x-example":"1704200998"},"validTo":{"type":"string","description":"Valid to","x-example":"1711458597"},"signatureTypeSN":{"type":"string","description":"Signature type SN","x-example":"RSA-SHA256"}},"required":["name","subjectSN","issuerOrganisation","validFrom","validTo","signatureTypeSN"]},"healthTime":{"description":"Health Time","type":"object","properties":{"remoteTime":{"type":"integer","description":"Current unix timestamp on trustful remote server.","x-example":1639490751,"format":"int32"},"localTime":{"type":"integer","description":"Current unix timestamp of local server where Appwrite runs.","x-example":1639490844,"format":"int32"},"diff":{"type":"integer","description":"Difference of unix remote and local timestamps in milliseconds.","x-example":93,"format":"int32"}},"required":["remoteTime","localTime","diff"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"provider":{"description":"Provider","type":"object","properties":{"$id":{"type":"string","description":"Provider ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Provider creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Provider update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name for the provider instance.","x-example":"Mailgun"},"provider":{"type":"string","description":"The name of the provider service.","x-example":"mailgun"},"enabled":{"type":"boolean","description":"Is provider enabled?","x-example":true},"type":{"type":"string","description":"Type of provider.","x-example":"sms"},"credentials":{"type":"object","additionalProperties":true,"description":"Provider credentials.","x-example":{"key":"123456789"}},"options":{"type":"object","additionalProperties":true,"description":"Provider options.","x-example":{"from":"sender-email@mydomain"}}},"required":["$id","$createdAt","$updatedAt","name","provider","enabled","type","credentials"]},"message":{"description":"Message","type":"object","properties":{"$id":{"type":"string","description":"Message ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Message creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Message update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerType":{"type":"string","description":"Message provider type.","x-example":"email"},"topics":{"type":"array","description":"Topic IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"users":{"type":"array","description":"User IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"targets":{"type":"array","description":"Target IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"scheduledAt":{"type":"string","description":"The scheduled time for message.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveredAt":{"type":"string","description":"The time when the message was delivered.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveryErrors":{"type":"array","description":"Delivery errors if any.","items":{"type":"string"},"x-example":["Failed to send message to target 5e5ea5c16897e: Credentials not valid."],"x-nullable":true},"deliveredTotal":{"type":"integer","description":"Number of recipients the message was delivered to.","x-example":1,"format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Data of the message.","x-example":{"subject":"Welcome to Appwrite","content":"Hi there, welcome to Appwrite family."}},"status":{"type":"string","description":"Status of delivery.","x-example":"Message status can be one of the following: draft, processing, scheduled, sent, or failed."}},"required":["$id","$createdAt","$updatedAt","providerType","topics","users","targets","deliveredTotal","data","status"]},"topic":{"description":"Topic","type":"object","properties":{"$id":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Topic creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Topic update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name of the topic.","x-example":"events"},"emailTotal":{"type":"integer","description":"Total count of email subscribers subscribed to the topic.","x-example":100,"format":"int32"},"smsTotal":{"type":"integer","description":"Total count of SMS subscribers subscribed to the topic.","x-example":100,"format":"int32"},"pushTotal":{"type":"integer","description":"Total count of push subscribers subscribed to the topic.","x-example":100,"format":"int32"},"subscribe":{"type":"array","description":"Subscribe permissions.","items":{"type":"string"},"x-example":"users"}},"required":["$id","$createdAt","$updatedAt","name","emailTotal","smsTotal","pushTotal","subscribe"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"type":"object","$ref":"#\/definitions\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","x-nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file +{"swagger":"2.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"host":"cloud.appwrite.io","basePath":"\/v1","schemes":["https"],"consumes":["application\/json","multipart\/form-data"],"produces":["application\/json"],"securityDefinitions":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"Key":{"type":"apiKey","name":"X-Appwrite-Key","description":"Your secret API key","in":"header","x-appwrite":{"demo":"<YOUR_API_KEY>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header","x-appwrite":{"demo":"<YOUR_JWT>"}},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Session":{"type":"apiKey","name":"X-Appwrite-Session","description":"The user session to authenticate with","in":"header"},"ForwardedUserAgent":{"type":"apiKey","name":"X-Forwarded-User-Agent","description":"The user agent string of the client that made the request","in":"header"}},"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","schema":{"$ref":"#\/definitions\/mfaType"}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","schema":{"$ref":"#\/definitions\/mfaChallenge"}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","default":null,"x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}]},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","default":null,"x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["challengeId","otp"]}}]}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","default":"","x-example":"password"}},"required":["password"]}}]}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["phone","password"]}}]}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["email","url"]}}]},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","default":null,"x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null}},"required":["userId","secret","password"]}}]}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","default":"","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"}},"required":["userId","phone"]}}]}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["url"]}}]},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"type":"string","x-example":"<NAME>","default":"","in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"type":"string","default":"","in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"type":"string","x-example":"<TEXT>","in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":1,"default":400,"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"type":"integer","format":"int32","x-example":0,"default":1,"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"type":"boolean","x-example":false,"default":false,"in":"query"}]}},"\/databases":{"get":{"summary":"List databases","operationId":"databasesList","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.","responses":{"200":{"description":"Databases List","schema":{"$ref":"#\/definitions\/databaseList"}}},"x-appwrite":{"method":"list","weight":69,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create database","operationId":"databasesCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Database.\n","responses":{"201":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"create","weight":68,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"databaseId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DATABASE_ID>"},"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["databaseId","name"]}}]}},"\/databases\/{databaseId}":{"get":{"summary":"Get database","operationId":"databasesGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"get","weight":70,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]},"put":{"summary":"Update database","operationId":"databasesUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a database by its unique ID.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"update","weight":72,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete database","operationId":"databasesDelete","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":73,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections":{"get":{"summary":"List collections","operationId":"databasesListCollections","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.","responses":{"200":{"description":"Collections List","schema":{"$ref":"#\/definitions\/collectionList"}}},"x-appwrite":{"method":"listCollections","weight":75,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collections.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"queries","description":"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: name, enabled, documentSecurity","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create collection","operationId":"databasesCreateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"createCollection","weight":74,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"collectionId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<COLLECTION_ID>"},"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["collectionId","name"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}":{"get":{"summary":"Get collection","operationId":"databasesGetCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"getCollection","weight":76,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]},"put":{"summary":"Update collection","operationId":"databasesUpdateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a collection by its unique ID.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"updateCollection","weight":78,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete collection","operationId":"databasesDeleteCollection","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteCollection","weight":79,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes":{"get":{"summary":"List attributes","operationId":"databasesListAttributes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List attributes in the collection.","responses":{"200":{"description":"Attributes List","schema":{"$ref":"#\/definitions\/attributeList"}}},"x-appwrite":{"method":"listAttributes","weight":90,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-attributes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, size, required, array, status, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean":{"post":{"summary":"Create boolean attribute","operationId":"databasesCreateBooleanAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a boolean attribute.\n","responses":{"202":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"createBooleanAttribute","weight":87,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}":{"patch":{"summary":"Update boolean attribute","operationId":"databasesUpdateBooleanAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a boolean attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"updateBooleanAttribute","weight":99,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime":{"post":{"summary":"Create datetime attribute","operationId":"databasesCreateDatetimeAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a date time attribute according to the ISO 8601 standard.","responses":{"202":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"createDatetimeAttribute","weight":88,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}":{"patch":{"summary":"Update dateTime attribute","operationId":"databasesUpdateDatetimeAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a date time attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"updateDatetimeAttribute","weight":100,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email":{"post":{"summary":"Create email attribute","operationId":"databasesCreateEmailAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an email attribute.\n","responses":{"202":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"createEmailAttribute","weight":81,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}":{"patch":{"summary":"Update email attribute","operationId":"databasesUpdateEmailAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an email attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"updateEmailAttribute","weight":93,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum":{"post":{"summary":"Create enum attribute","operationId":"databasesCreateEnumAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n","responses":{"202":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"createEnumAttribute","weight":82,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","elements","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}":{"patch":{"summary":"Update enum attribute","operationId":"databasesUpdateEnumAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an enum attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"updateEnumAttribute","weight":94,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["elements","required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float":{"post":{"summary":"Create float attribute","operationId":"databasesCreateFloatAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a float attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"createFloatAttribute","weight":86,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float\/{key}":{"patch":{"summary":"Update float attribute","operationId":"databasesUpdateFloatAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a float attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"updateFloatAttribute","weight":98,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer":{"post":{"summary":"Create integer attribute","operationId":"databasesCreateIntegerAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an integer attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"createIntegerAttribute","weight":85,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer\/{key}":{"patch":{"summary":"Update integer attribute","operationId":"databasesUpdateIntegerAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an integer attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"updateIntegerAttribute","weight":97,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip":{"post":{"summary":"Create IP address attribute","operationId":"databasesCreateIpAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create IP address attribute.\n","responses":{"202":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"createIpAttribute","weight":83,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}":{"patch":{"summary":"Update IP address attribute","operationId":"databasesUpdateIpAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an ip attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"updateIpAttribute","weight":95,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship":{"post":{"summary":"Create relationship attribute","operationId":"databasesCreateRelationshipAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"202":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"createRelationshipAttribute","weight":89,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"relatedCollectionId":{"type":"string","description":"Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","default":null,"x-example":"<RELATED_COLLECTION_ID>"},"type":{"type":"string","description":"Relation type","default":null,"x-example":"oneToOne","enum":["oneToOne","manyToOne","manyToMany","oneToMany"],"x-enum-name":"RelationshipType","x-enum-keys":[]},"twoWay":{"type":"boolean","description":"Is Two Way?","default":false,"x-example":false},"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"twoWayKey":{"type":"string","description":"Two Way Attribute Key.","default":null,"x-example":null},"onDelete":{"type":"string","description":"Constraints option","default":"restrict","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}},"required":["relatedCollectionId","type"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string":{"post":{"summary":"Create string attribute","operationId":"databasesCreateStringAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a string attribute.\n","responses":{"202":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"createStringAttribute","weight":80,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"size":{"type":"integer","description":"Attribute size for text attributes, in number of characters.","default":null,"x-example":1},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false},"encrypt":{"type":"boolean","description":"Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.","default":false,"x-example":false}},"required":["key","size","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}":{"patch":{"summary":"Update string attribute","operationId":"databasesUpdateStringAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a string attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"updateStringAttribute","weight":92,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url":{"post":{"summary":"Create URL attribute","operationId":"databasesCreateUrlAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a URL attribute.\n","responses":{"202":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"createUrlAttribute","weight":84,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}":{"patch":{"summary":"Update URL attribute","operationId":"databasesUpdateUrlAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an url attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"updateUrlAttribute","weight":96,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}":{"get":{"summary":"Get attribute","operationId":"databasesGetAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get attribute by ID.","responses":{"200":{"description":"AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString","schema":{"x-oneOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]}}},"x-appwrite":{"method":"getAttribute","weight":91,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete attribute","operationId":"databasesDeleteAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Deletes an attribute.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteAttribute","weight":102,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship":{"patch":{"summary":"Update relationship attribute","operationId":"databasesUpdateRelationshipAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"200":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"updateRelationshipAttribute","weight":101,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"onDelete":{"type":"string","description":"Constraints option","default":null,"x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}}}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","schema":{"$ref":"#\/definitions\/documentList"}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","default":{},"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","default":[],"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes":{"get":{"summary":"List indexes","operationId":"databasesListIndexes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List indexes in the collection.","responses":{"200":{"description":"Indexes List","schema":{"$ref":"#\/definitions\/indexList"}}},"x-appwrite":{"method":"listIndexes","weight":104,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-indexes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, status, attributes, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create index","operationId":"databasesCreateIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.","responses":{"202":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"createIndex","weight":103,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Index Key.","default":null,"x-example":null},"type":{"type":"string","description":"Index type.","default":null,"x-example":"key","enum":["key","fulltext","unique"],"x-enum-name":"IndexType","x-enum-keys":[]},"attributes":{"type":"array","description":"Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"orders":{"type":"array","description":"Array of index orders. Maximum of 100 orders are allowed.","default":[],"x-example":null,"items":{"type":"string"}}},"required":["key","type","attributes"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}":{"get":{"summary":"Get index","operationId":"databasesGetIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get index by ID.","responses":{"200":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"getIndex","weight":105,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete index","operationId":"databasesDeleteIndex","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete an index.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIndex","weight":106,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]}},"\/functions":{"get":{"summary":"List functions","operationId":"functionsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's functions. You can use the query params to filter your results.","responses":{"200":{"description":"Functions List","schema":{"$ref":"#\/definitions\/functionList"}}},"x-appwrite":{"method":"list","weight":287,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create function","operationId":"functionsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.","responses":{"201":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"create","weight":286,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"functionId":{"type":"string","description":"Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<FUNCTION_ID>"},"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":null,"x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Function maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Control System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function.","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function.","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"},"templateRepository":{"type":"string","description":"Repository name of the template.","default":"","x-example":"<TEMPLATE_REPOSITORY>"},"templateOwner":{"type":"string","description":"The name of the owner of the template.","default":"","x-example":"<TEMPLATE_OWNER>"},"templateRootDirectory":{"type":"string","description":"Path to function code in the template repo.","default":"","x-example":"<TEMPLATE_ROOT_DIRECTORY>"},"templateBranch":{"type":"string","description":"Production branch for the repo linked to the function template.","default":"","x-example":"<TEMPLATE_BRANCH>"}},"required":["functionId","name","runtime"]}}]}},"\/functions\/runtimes":{"get":{"summary":"List runtimes","operationId":"functionsListRuntimes","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all runtimes that are currently active on your instance.","responses":{"200":{"description":"Runtimes List","schema":{"$ref":"#\/definitions\/runtimeList"}}},"x-appwrite":{"method":"listRuntimes","weight":288,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-runtimes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-runtimes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/functions\/{functionId}":{"get":{"summary":"Get function","operationId":"functionsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"get","weight":289,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"put":{"summary":"Update function","operationId":"functionsUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"update","weight":292,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":"","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Controle System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"}},"required":["name"]}}]},"delete":{"summary":"Delete function","operationId":"functionsDelete","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":295,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments":{"get":{"summary":"List deployments","operationId":"functionsListDeployments","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's code deployments. You can use the query params to filter your results.","responses":{"200":{"description":"Deployments List","schema":{"$ref":"#\/definitions\/deploymentList"}}},"x-appwrite":{"method":"listDeployments","weight":297,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: size, buildId, activate, entrypoint, commands","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create deployment","operationId":"functionsCreateDeployment","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.","responses":{"202":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"createDeployment","weight":296,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":true,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"entrypoint","description":"Entrypoint File.","required":false,"type":"string","x-example":"<ENTRYPOINT>","in":"formData"},{"name":"commands","description":"Build Commands.","required":false,"type":"string","x-example":"<COMMANDS>","in":"formData"},{"name":"code","description":"Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.","required":true,"type":"file","in":"formData"},{"name":"activate","description":"Automatically activate the deployment when it is finished building.","required":true,"type":"boolean","x-example":false,"in":"formData"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}":{"get":{"summary":"Get deployment","operationId":"functionsGetDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a code deployment by its unique ID.","responses":{"200":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"getDeployment","weight":298,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"patch":{"summary":"Update function deployment","operationId":"functionsUpdateDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"updateDeployment","weight":294,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"delete":{"summary":"Delete deployment","operationId":"functionsDeleteDeployment","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a code deployment by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDeployment","weight":299,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/build":{"post":{"summary":"Rebuild deployment","operationId":"functionsCreateBuild","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createBuild","weight":300,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"buildId":{"type":"string","description":"Build unique ID.","default":"","x-example":"<BUILD_ID>"}}}}]},"patch":{"summary":"Cancel deployment","operationId":"functionsUpdateDeploymentBuild","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"Build","schema":{"$ref":"#\/definitions\/build"}}},"x-appwrite":{"method":"updateDeploymentBuild","weight":301,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/download":{"get":{"summary":"Download Deployment","operationId":"functionsDownloadDeployment","consumes":["application\/json"],"produces":["*\/*"],"tags":["functions"],"description":"Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"downloadDeployment","weight":293,"cookies":false,"type":"location","deprecated":false,"demo":"functions\/download-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/download-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","schema":{"$ref":"#\/definitions\/executionList"}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","default":"","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","default":false,"x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","default":"\/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","default":"POST","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","default":[],"x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]},"delete":{"summary":"Delete execution","operationId":"functionsDeleteExecution","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function execution by its unique ID.\n","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteExecution","weight":305,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/variables":{"get":{"summary":"List variables","operationId":"functionsListVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all variables of a specific function.","responses":{"200":{"description":"Variables List","schema":{"$ref":"#\/definitions\/variableList"}}},"x-appwrite":{"method":"listVariables","weight":307,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"post":{"summary":"Create variable","operationId":"functionsCreateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.","responses":{"201":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"createVariable","weight":306,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key","value"]}}]}},"\/functions\/{functionId}\/variables\/{variableId}":{"get":{"summary":"Get variable","operationId":"functionsGetVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"getVariable","weight":308,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]},"put":{"summary":"Update variable","operationId":"functionsUpdateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"updateVariable","weight":309,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key"]}}]},"delete":{"summary":"Delete variable","operationId":"functionsDeleteVariable","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a variable by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":310,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/health":{"get":{"summary":"Get HTTP","operationId":"healthGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite HTTP server is up and responsive.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"get","weight":124,"cookies":false,"type":"","deprecated":false,"demo":"health\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/anti-virus":{"get":{"summary":"Get antivirus","operationId":"healthGetAntivirus","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite Antivirus server is up and connection is successful.","responses":{"200":{"description":"Health Antivirus","schema":{"$ref":"#\/definitions\/healthAntivirus"}}},"x-appwrite":{"method":"getAntivirus","weight":146,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-antivirus.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/cache":{"get":{"summary":"Get cache","operationId":"healthGetCache","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite in-memory cache servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getCache","weight":127,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-cache.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/certificate":{"get":{"summary":"Get the SSL certificate for a domain","operationId":"healthGetCertificate","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the SSL certificate for a domain","responses":{"200":{"description":"Health Certificate","schema":{"$ref":"#\/definitions\/healthCertificate"}}},"x-appwrite":{"method":"getCertificate","weight":133,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-certificate.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"domain","description":"string","required":false,"type":"string","in":"query"}]}},"\/health\/db":{"get":{"summary":"Get DB","operationId":"healthGetDB","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite database servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getDB","weight":126,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-d-b.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/pubsub":{"get":{"summary":"Get pubsub","operationId":"healthGetPubSub","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite pub-sub servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getPubSub","weight":129,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-pub-sub.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue":{"get":{"summary":"Get queue","operationId":"healthGetQueue","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite queue messaging servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getQueue","weight":128,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue\/builds":{"get":{"summary":"Get builds queue","operationId":"healthGetQueueBuilds","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of builds that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueBuilds","weight":135,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-builds.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/certificates":{"get":{"summary":"Get certificates queue","operationId":"healthGetQueueCertificates","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of certificates that are waiting to be issued against [Letsencrypt](https:\/\/letsencrypt.org\/) in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueCertificates","weight":134,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-certificates.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/databases":{"get":{"summary":"Get databases queue","operationId":"healthGetQueueDatabases","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDatabases","weight":136,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-databases.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"Queue name for which to check the queue size","required":false,"type":"string","x-example":"<NAME>","default":"database_db_main","in":"query"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/deletes":{"get":{"summary":"Get deletes queue","operationId":"healthGetQueueDeletes","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDeletes","weight":137,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-deletes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/failed\/{name}":{"get":{"summary":"Get number of failed queue jobs","operationId":"healthGetFailedJobs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Returns the amount of failed jobs in a given queue.\n","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getFailedJobs","weight":147,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-failed-jobs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"The name of the queue","required":true,"type":"string","x-example":"v1-database","enum":["v1-database","v1-deletes","v1-audits","v1-mails","v1-functions","v1-usage","v1-usage-dump","v1-webhooks","v1-certificates","v1-builds","v1-messaging","v1-migrations"],"x-enum-name":null,"x-enum-keys":[],"in":"path"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/functions":{"get":{"summary":"Get functions queue","operationId":"healthGetQueueFunctions","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueFunctions","weight":141,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-functions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/logs":{"get":{"summary":"Get logs queue","operationId":"healthGetQueueLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of logs that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueLogs","weight":132,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/mails":{"get":{"summary":"Get mails queue","operationId":"healthGetQueueMails","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of mails that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMails","weight":138,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-mails.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/messaging":{"get":{"summary":"Get messaging queue","operationId":"healthGetQueueMessaging","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of messages that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMessaging","weight":139,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-messaging.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/migrations":{"get":{"summary":"Get migrations queue","operationId":"healthGetQueueMigrations","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMigrations","weight":140,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-migrations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage":{"get":{"summary":"Get usage queue","operationId":"healthGetQueueUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsage","weight":142,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage-dump":{"get":{"summary":"Get usage dump queue","operationId":"healthGetQueueUsageDump","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsageDump","weight":143,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage-dump.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage-dump.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/webhooks":{"get":{"summary":"Get webhooks queue","operationId":"healthGetQueueWebhooks","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueWebhooks","weight":131,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/storage":{"get":{"summary":"Get storage","operationId":"healthGetStorage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorage","weight":145,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/storage\/local":{"get":{"summary":"Get local storage","operationId":"healthGetStorageLocal","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite local storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorageLocal","weight":144,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage-local.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/time":{"get":{"summary":"Get time","operationId":"healthGetTime","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https:\/\/en.wikipedia.org\/wiki\/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.","responses":{"200":{"description":"Health Time","schema":{"$ref":"#\/definitions\/healthTime"}}},"x-appwrite":{"method":"getTime","weight":130,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-time.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","schema":{"$ref":"#\/definitions\/locale"}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","schema":{"$ref":"#\/definitions\/localeCodeList"}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","schema":{"$ref":"#\/definitions\/continentList"}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","schema":{"$ref":"#\/definitions\/phoneList"}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","schema":{"$ref":"#\/definitions\/currencyList"}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","schema":{"$ref":"#\/definitions\/languageList"}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/messaging\/messages":{"get":{"summary":"List messages","operationId":"messagingListMessages","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all messages from the current Appwrite project.","responses":{"200":{"description":"Message list","schema":{"$ref":"#\/definitions\/messageList"}}},"x-appwrite":{"method":"listMessages","weight":385,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-messages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/messages\/email":{"post":{"summary":"Create email","operationId":"messagingCreateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new email message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createEmail","weight":382,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":[],"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":[],"x-example":null,"items":{"type":"string"}},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","subject","content"]}}]}},"\/messaging\/messages\/email\/{messageId}":{"patch":{"summary":"Update email","operationId":"messagingUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateEmail","weight":389,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":null,"x-example":false},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":null,"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":null,"x-example":null,"items":{"type":"string"}},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":null,"items":{"type":"string"}}}}}]}},"\/messaging\/messages\/push":{"post":{"summary":"Create push notification","operationId":"messagingCreatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new push notification.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createPush","weight":384,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":"","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":"","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web Platform.","default":"","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and IOS Platform.","default":"","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android Platform.","default":"","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android Platform.","default":"","x-example":"<TAG>"},"badge":{"type":"string","description":"Badge for push notification. Available only for IOS Platform.","default":"","x-example":"<BADGE>"},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","title","body"]}}]}},"\/messaging\/messages\/push\/{messageId}":{"patch":{"summary":"Update push notification","operationId":"messagingUpdatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a push notification by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updatePush","weight":391,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":null,"x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web platforms.","default":null,"x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and iOS platforms.","default":null,"x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android platforms.","default":null,"x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android platforms.","default":null,"x-example":"<TAG>"},"badge":{"type":"integer","description":"Badge for push notification. Available only for iOS platforms.","default":null,"x-example":null},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/sms":{"post":{"summary":"Create SMS","operationId":"messagingCreateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMS message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createSms","weight":383,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"content":{"type":"string","description":"SMS Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","content"]}}]}},"\/messaging\/messages\/sms\/{messageId}":{"patch":{"summary":"Update SMS","operationId":"messagingUpdateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateSms","weight":390,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/{messageId}":{"get":{"summary":"Get message","operationId":"messagingGetMessage","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"getMessage","weight":388,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-message.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]},"delete":{"summary":"Delete message","operationId":"messagingDelete","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":392,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]}},"\/messaging\/messages\/{messageId}\/logs":{"get":{"summary":"List message logs","operationId":"messagingListMessageLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the message activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listMessageLogs","weight":386,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-message-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/messages\/{messageId}\/targets":{"get":{"summary":"List message targets","operationId":"messagingListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of the targets associated with a message.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":387,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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, providerId, identifier, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/providers":{"get":{"summary":"List providers","operationId":"messagingListProviders","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all providers from the current Appwrite project.","responses":{"200":{"description":"Provider list","schema":{"$ref":"#\/definitions\/providerList"}}},"x-appwrite":{"method":"listProviders","weight":357,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-providers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/providers\/apns":{"post":{"summary":"Create APNS provider","operationId":"messagingCreateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Apple Push Notification service provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createApnsProvider","weight":356,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/apns\/{providerId}":{"patch":{"summary":"Update APNS provider","operationId":"messagingUpdateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Apple Push Notification service provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateApnsProvider","weight":369,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/fcm":{"post":{"summary":"Create FCM provider","operationId":"messagingCreateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Firebase Cloud Messaging provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createFcmProvider","weight":355,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/fcm\/{providerId}":{"patch":{"summary":"Update FCM provider","operationId":"messagingUpdateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Firebase Cloud Messaging provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateFcmProvider","weight":368,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"}}}}]}},"\/messaging\/providers\/mailgun":{"post":{"summary":"Create Mailgun provider","operationId":"messagingCreateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Mailgun provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMailgunProvider","weight":347,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/mailgun\/{providerId}":{"patch":{"summary":"Update Mailgun provider","operationId":"messagingUpdateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Mailgun provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMailgunProvider","weight":360,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/msg91":{"post":{"summary":"Create Msg91 provider","operationId":"messagingCreateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new MSG91 provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMsg91Provider","weight":350,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"templateId":{"type":"string","description":"Msg91 template ID","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/msg91\/{providerId}":{"patch":{"summary":"Update Msg91 provider","operationId":"messagingUpdateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a MSG91 provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMsg91Provider","weight":363,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"templateId":{"type":"string","description":"Msg91 template ID.","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"}}}}]}},"\/messaging\/providers\/sendgrid":{"post":{"summary":"Create Sendgrid provider","operationId":"messagingCreateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Sendgrid provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSendgridProvider","weight":348,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/sendgrid\/{providerId}":{"patch":{"summary":"Update Sendgrid provider","operationId":"messagingUpdateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Sendgrid provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSendgridProvider","weight":361,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/smtp":{"post":{"summary":"Create SMTP provider","operationId":"messagingCreateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMTP provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSmtpProvider","weight":349,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":null,"x-example":"<HOST>"},"port":{"type":"integer","description":"The default SMTP server port.","default":587,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be omitted, 'ssl', or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":true,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name","host"]}}]}},"\/messaging\/providers\/smtp\/{providerId}":{"patch":{"summary":"Update SMTP provider","operationId":"messagingUpdateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a SMTP provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSmtpProvider","weight":362,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":"","x-example":"<HOST>"},"port":{"type":"integer","description":"SMTP port.","default":null,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be 'ssl' or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":null,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/telesign":{"post":{"summary":"Create Telesign provider","operationId":"messagingCreateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Telesign provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTelesignProvider","weight":351,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/telesign\/{providerId}":{"patch":{"summary":"Update Telesign provider","operationId":"messagingUpdateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Telesign provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTelesignProvider","weight":364,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/textmagic":{"post":{"summary":"Create Textmagic provider","operationId":"messagingCreateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Textmagic provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTextmagicProvider","weight":352,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/textmagic\/{providerId}":{"patch":{"summary":"Update Textmagic provider","operationId":"messagingUpdateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Textmagic provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTextmagicProvider","weight":365,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/twilio":{"post":{"summary":"Create Twilio provider","operationId":"messagingCreateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Twilio provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTwilioProvider","weight":353,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/twilio\/{providerId}":{"patch":{"summary":"Update Twilio provider","operationId":"messagingUpdateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Twilio provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTwilioProvider","weight":366,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/vonage":{"post":{"summary":"Create Vonage provider","operationId":"messagingCreateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Vonage provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createVonageProvider","weight":354,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/vonage\/{providerId}":{"patch":{"summary":"Update Vonage provider","operationId":"messagingUpdateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Vonage provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateVonageProvider","weight":367,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/{providerId}":{"get":{"summary":"Get provider","operationId":"messagingGetProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a provider by its unique ID.\n","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"getProvider","weight":359,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]},"delete":{"summary":"Delete provider","operationId":"messagingDeleteProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a provider by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteProvider","weight":370,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]}},"\/messaging\/providers\/{providerId}\/logs":{"get":{"summary":"List provider logs","operationId":"messagingListProviderLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the provider activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listProviderLogs","weight":358,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-provider-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/subscribers\/{subscriberId}\/logs":{"get":{"summary":"List subscriber logs","operationId":"messagingListSubscriberLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the subscriber activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listSubscriberLogs","weight":379,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscriber-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics":{"get":{"summary":"List topics","operationId":"messagingListTopics","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all topics from the current Appwrite project.","responses":{"200":{"description":"Topic list","schema":{"$ref":"#\/definitions\/topicList"}}},"x-appwrite":{"method":"listTopics","weight":372,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topics.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, description, emailTotal, smsTotal, pushTotal","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create topic","operationId":"messagingCreateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new topic.","responses":{"201":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"createTopic","weight":371,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"topicId":{"type":"string","description":"Topic ID. Choose a custom Topic ID or a new Topic ID.","default":null,"x-example":"<TOPIC_ID>"},"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":["users"],"x-example":"[\"any\"]","items":{"type":"string"}}},"required":["topicId","name"]}}]}},"\/messaging\/topics\/{topicId}":{"get":{"summary":"Get topic","operationId":"messagingGetTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"getTopic","weight":374,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]},"patch":{"summary":"Update topic","operationId":"messagingUpdateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"updateTopic","weight":375,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":null,"x-example":"[\"any\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete topic","operationId":"messagingDeleteTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a topic by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTopic","weight":376,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]}},"\/messaging\/topics\/{topicId}\/logs":{"get":{"summary":"List topic logs","operationId":"messagingListTopicLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the topic activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listTopicLogs","weight":373,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topic-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"get":{"summary":"List subscribers","operationId":"messagingListSubscribers","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all subscribers from the current Appwrite project.","responses":{"200":{"description":"Subscriber list","schema":{"$ref":"#\/definitions\/subscriberList"}}},"x-appwrite":{"method":"listSubscribers","weight":378,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscribers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"JWT":[]}},"security":[{"Project":[],"JWT":[],"Session":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","default":null,"x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","default":null,"x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}]}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"get":{"summary":"Get subscriber","operationId":"messagingGetSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a subscriber by its unique ID.\n","responses":{"200":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"getSubscriber","weight":380,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]},"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"JWT":[]}},"security":[{"Project":[],"JWT":[],"Session":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]}},"\/storage\/buckets":{"get":{"summary":"List buckets","operationId":"storageListBuckets","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the storage buckets. You can use the query params to filter your results.","responses":{"200":{"description":"Buckets List","schema":{"$ref":"#\/definitions\/bucketList"}}},"x-appwrite":{"method":"listBuckets","weight":201,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-buckets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create bucket","operationId":"storageCreateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new storage bucket.","responses":{"201":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"createBucket","weight":200,"cookies":false,"type":"","deprecated":false,"demo":"storage\/create-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"bucketId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<BUCKET_ID>"},"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["bucketId","name"]}}]}},"\/storage\/buckets\/{bucketId}":{"get":{"summary":"Get bucket","operationId":"storageGetBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"getBucket","weight":202,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]},"put":{"summary":"Update bucket","operationId":"storageUpdateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a storage bucket by its unique ID.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"updateBucket","weight":203,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete bucket","operationId":"storageDeleteBucket","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a storage bucket by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteBucket","weight":204,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","schema":{"$ref":"#\/definitions\/fileList"}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"x-upload-id":true,"type":"string","x-example":"<FILE_ID>","in":"formData"},{"name":"file","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","required":true,"type":"file","in":"formData"},{"name":"permissions","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"x-example":"[\"read(\"any\")\"]","in":"formData"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","consumes":["application\/json"],"produces":["image\/*"],"tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center","in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"type":"number","format":"float","x-example":0,"default":1,"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"type":"integer","format":"int32","x-example":-360,"default":0,"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":"","in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","schema":{"$ref":"#\/definitions\/teamList"}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":["owner"],"x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}]}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]},"delete":{"summary":"Delete team","operationId":"teamsDelete","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","default":"","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","default":"","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","default":"","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["roles"]}}]}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["roles"]}}]},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users":{"get":{"summary":"List users","operationId":"usersList","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a list of all the project's users. You can use the query params to filter your results.","responses":{"200":{"description":"Users List","schema":{"$ref":"#\/definitions\/userList"}}},"x-appwrite":{"method":"list","weight":239,"cookies":false,"type":"","deprecated":false,"demo":"users\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create user","operationId":"usersCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":230,"cookies":false,"type":"","deprecated":false,"demo":"users\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"Plain text user password. Must be at least 8 chars.","default":"","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId"]}}]}},"\/users\/argon2":{"post":{"summary":"Create user with Argon2 password","operationId":"usersCreateArgon2User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createArgon2User","weight":233,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-argon2user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Argon2.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/bcrypt":{"post":{"summary":"Create user with bcrypt password","operationId":"usersCreateBcryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createBcryptUser","weight":231,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-bcrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Bcrypt.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/identities":{"get":{"summary":"List Identities","operationId":"usersListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get identities for all users.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":247,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/users\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"usersDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":270,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/users\/md5":{"post":{"summary":"Create user with MD5 password","operationId":"usersCreateMD5User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createMD5User","weight":232,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-m-d5user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using MD5.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/phpass":{"post":{"summary":"Create user with PHPass password","operationId":"usersCreatePHPassUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createPHPassUser","weight":235,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-p-h-pass-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using PHPass.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/scrypt":{"post":{"summary":"Create user with Scrypt password","operationId":"usersCreateScryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptUser","weight":236,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Optional salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordCpu":{"type":"integer","description":"Optional CPU cost used to hash password.","default":null,"x-example":null},"passwordMemory":{"type":"integer","description":"Optional memory cost used to hash password.","default":null,"x-example":null},"passwordParallel":{"type":"integer","description":"Optional parallelization cost used to hash password.","default":null,"x-example":null},"passwordLength":{"type":"integer","description":"Optional hash length used to hash password.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordCpu","passwordMemory","passwordParallel","passwordLength"]}}]}},"\/users\/scrypt-modified":{"post":{"summary":"Create user with Scrypt modified password","operationId":"usersCreateScryptModifiedUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptModifiedUser","weight":237,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-modified-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt Modified.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordSaltSeparator":{"type":"string","description":"Salt separator used to hash password.","default":null,"x-example":"<PASSWORD_SALT_SEPARATOR>"},"passwordSignerKey":{"type":"string","description":"Signer key used to hash password.","default":null,"x-example":"<PASSWORD_SIGNER_KEY>"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordSaltSeparator","passwordSignerKey"]}}]}},"\/users\/sha":{"post":{"summary":"Create user with SHA password","operationId":"usersCreateSHAUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createSHAUser","weight":234,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-s-h-a-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using SHA.","default":null,"x-example":"password"},"passwordVersion":{"type":"string","description":"Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'","default":"","x-example":"sha1","enum":["sha1","sha224","sha256","sha384","sha512\/224","sha512\/256","sha512","sha3-224","sha3-256","sha3-384","sha3-512"],"x-enum-name":"PasswordHash","x-enum-keys":[]},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/{userId}":{"get":{"summary":"Get user","operationId":"usersGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":240,"cookies":false,"type":"","deprecated":false,"demo":"users\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user","operationId":"usersDelete","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":268,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/email":{"patch":{"summary":"Update email","operationId":"usersUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":253,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"}},"required":["email"]}}]}},"\/users\/{userId}\/jwts":{"post":{"summary":"Create user JWT","operationId":"usersCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":271,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.","default":"recent","x-example":"<SESSION_ID>"},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","default":900,"x-example":0}}}}]}},"\/users\/{userId}\/labels":{"put":{"summary":"Update user labels","operationId":"usersUpdateLabels","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateLabels","weight":249,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-labels.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"labels":{"type":"array","description":"Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["labels"]}}]}},"\/users\/{userId}\/logs":{"get":{"summary":"List user logs","operationId":"usersListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":245,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/users\/{userId}\/memberships":{"get":{"summary":"List user memberships","operationId":"usersListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user membership list by its unique ID.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":244,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa":{"patch":{"summary":"Update MFA","operationId":"usersUpdateMfa","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Enable or disable MFA on a user account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfa","weight":258,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/users\/{userId}\/mfa\/authenticators\/{type}":{"delete":{"summary":"Delete Authenticator","operationId":"usersDeleteMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete an authenticator app.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":263,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/users\/{userId}\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"usersListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":259,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"usersGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":260,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"put":{"summary":"Regenerate MFA Recovery Codes","operationId":"usersUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":262,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Create MFA Recovery Codes","operationId":"usersCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":261,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/name":{"patch":{"summary":"Update name","operationId":"usersUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user name by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":251,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/users\/{userId}\/password":{"patch":{"summary":"Update password","operationId":"usersUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user password by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":252,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null}},"required":["password"]}}]}},"\/users\/{userId}\/phone":{"patch":{"summary":"Update phone","operationId":"usersUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":254,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"number":{"type":"string","description":"User phone number.","default":null,"x-example":"+12065550100"}},"required":["number"]}}]}},"\/users\/{userId}\/prefs":{"get":{"summary":"Get user preferences","operationId":"usersGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user preferences by its unique ID.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":241,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Update user preferences","operationId":"usersUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user preferences by its unique ID. 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.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":256,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users\/{userId}\/sessions":{"get":{"summary":"List user sessions","operationId":"usersListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user sessions list by its unique ID.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":243,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"post":{"summary":"Create session","operationId":"usersCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":264,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user sessions","operationId":"usersDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete all user's sessions by using the user's unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":267,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/sessions\/{sessionId}":{"delete":{"summary":"Delete user session","operationId":"usersDeleteSession","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user sessions by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":266,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"sessionId","description":"Session ID.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/users\/{userId}\/status":{"patch":{"summary":"Update user status","operationId":"usersUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":248,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"User Status. To activate the user pass `true` and to block the user pass `false`.","default":null,"x-example":false}},"required":["status"]}}]}},"\/users\/{userId}\/targets":{"get":{"summary":"List User Targets","operationId":"usersListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the messaging targets that are associated with a user.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":246,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create User Target","operationId":"usersCreateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a messaging target.","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createTarget","weight":238,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","default":null,"x-example":"email","enum":["email","sms","push"],"x-enum-name":"MessagingProviderType","x-enum-keys":[]},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}},"required":["targetId","providerType","identifier"]}}]}},"\/users\/{userId}\/targets\/{targetId}":{"get":{"summary":"Get User Target","operationId":"usersGetTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user's push notification target by ID.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"getTarget","weight":242,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]},"patch":{"summary":"Update User target","operationId":"usersUpdateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update a messaging target.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updateTarget","weight":257,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":"","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}}}}]},"delete":{"summary":"Delete user target","operationId":"usersDeleteTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete a messaging target.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTarget","weight":269,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/users\/{userId}\/tokens":{"post":{"summary":"Create token","operationId":"usersCreateToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createToken","weight":265,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"length":{"type":"integer","description":"Token length in characters. The default length is 6 characters","default":6,"x-example":4},"expire":{"type":"integer","description":"Token expiration period in seconds. The default expiration is 15 minutes.","default":900,"x-example":60}}}}]}},"\/users\/{userId}\/verification":{"patch":{"summary":"Update email verification","operationId":"usersUpdateEmailVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmailVerification","weight":255,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"emailVerification":{"type":"boolean","description":"User email verification status.","default":null,"x-example":false}},"required":["emailVerification"]}}]}},"\/users\/{userId}\/verification\/phone":{"patch":{"summary":"Update phone verification","operationId":"usersUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":250,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"phoneVerification":{"type":"boolean","description":"User phone verification status.","default":null,"x-example":false}},"required":["phoneVerification"]}}]}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"definitions":{"any":{"description":"Any","type":"object","additionalProperties":true},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"type":"object","$ref":"#\/definitions\/document"},"x-example":""}},"required":["total","documents"]},"collectionList":{"description":"Collections List","type":"object","properties":{"total":{"type":"integer","description":"Total number of collections documents that matched your query.","x-example":5,"format":"int32"},"collections":{"type":"array","description":"List of collections.","items":{"type":"object","$ref":"#\/definitions\/collection"},"x-example":""}},"required":["total","collections"]},"databaseList":{"description":"Databases List","type":"object","properties":{"total":{"type":"integer","description":"Total number of databases documents that matched your query.","x-example":5,"format":"int32"},"databases":{"type":"array","description":"List of databases.","items":{"type":"object","$ref":"#\/definitions\/database"},"x-example":""}},"required":["total","databases"]},"indexList":{"description":"Indexes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of indexes documents that matched your query.","x-example":5,"format":"int32"},"indexes":{"type":"array","description":"List of indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":""}},"required":["total","indexes"]},"userList":{"description":"Users List","type":"object","properties":{"total":{"type":"integer","description":"Total number of users documents that matched your query.","x-example":5,"format":"int32"},"users":{"type":"array","description":"List of users.","items":{"type":"object","$ref":"#\/definitions\/user"},"x-example":""}},"required":["total","users"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"type":"object","$ref":"#\/definitions\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"type":"object","$ref":"#\/definitions\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"type":"object","$ref":"#\/definitions\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"type":"object","$ref":"#\/definitions\/file"},"x-example":""}},"required":["total","files"]},"bucketList":{"description":"Buckets List","type":"object","properties":{"total":{"type":"integer","description":"Total number of buckets documents that matched your query.","x-example":5,"format":"int32"},"buckets":{"type":"array","description":"List of buckets.","items":{"type":"object","$ref":"#\/definitions\/bucket"},"x-example":""}},"required":["total","buckets"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"type":"object","$ref":"#\/definitions\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"type":"object","$ref":"#\/definitions\/membership"},"x-example":""}},"required":["total","memberships"]},"functionList":{"description":"Functions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of functions documents that matched your query.","x-example":5,"format":"int32"},"functions":{"type":"array","description":"List of functions.","items":{"type":"object","$ref":"#\/definitions\/function"},"x-example":""}},"required":["total","functions"]},"runtimeList":{"description":"Runtimes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of runtimes documents that matched your query.","x-example":5,"format":"int32"},"runtimes":{"type":"array","description":"List of runtimes.","items":{"type":"object","$ref":"#\/definitions\/runtime"},"x-example":""}},"required":["total","runtimes"]},"deploymentList":{"description":"Deployments List","type":"object","properties":{"total":{"type":"integer","description":"Total number of deployments documents that matched your query.","x-example":5,"format":"int32"},"deployments":{"type":"array","description":"List of deployments.","items":{"type":"object","$ref":"#\/definitions\/deployment"},"x-example":""}},"required":["total","deployments"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"type":"object","$ref":"#\/definitions\/execution"},"x-example":""}},"required":["total","executions"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"type":"object","$ref":"#\/definitions\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"type":"object","$ref":"#\/definitions\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"type":"object","$ref":"#\/definitions\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"type":"object","$ref":"#\/definitions\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"type":"object","$ref":"#\/definitions\/phone"},"x-example":""}},"required":["total","phones"]},"variableList":{"description":"Variables List","type":"object","properties":{"total":{"type":"integer","description":"Total number of variables documents that matched your query.","x-example":5,"format":"int32"},"variables":{"type":"array","description":"List of variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":""}},"required":["total","variables"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"type":"object","$ref":"#\/definitions\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"providerList":{"description":"Provider list","type":"object","properties":{"total":{"type":"integer","description":"Total number of providers documents that matched your query.","x-example":5,"format":"int32"},"providers":{"type":"array","description":"List of providers.","items":{"type":"object","$ref":"#\/definitions\/provider"},"x-example":""}},"required":["total","providers"]},"messageList":{"description":"Message list","type":"object","properties":{"total":{"type":"integer","description":"Total number of messages documents that matched your query.","x-example":5,"format":"int32"},"messages":{"type":"array","description":"List of messages.","items":{"type":"object","$ref":"#\/definitions\/message"},"x-example":""}},"required":["total","messages"]},"topicList":{"description":"Topic list","type":"object","properties":{"total":{"type":"integer","description":"Total number of topics documents that matched your query.","x-example":5,"format":"int32"},"topics":{"type":"array","description":"List of topics.","items":{"type":"object","$ref":"#\/definitions\/topic"},"x-example":""}},"required":["total","topics"]},"subscriberList":{"description":"Subscriber list","type":"object","properties":{"total":{"type":"integer","description":"Total number of subscribers documents that matched your query.","x-example":5,"format":"int32"},"subscribers":{"type":"array","description":"List of subscribers.","items":{"type":"object","$ref":"#\/definitions\/subscriber"},"x-example":""}},"required":["total","subscribers"]},"targetList":{"description":"Target list","type":"object","properties":{"total":{"type":"integer","description":"Total number of targets documents that matched your query.","x-example":5,"format":"int32"},"targets":{"type":"array","description":"List of targets.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":""}},"required":["total","targets"]},"database":{"description":"Database","type":"object","properties":{"$id":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Database name.","x-example":"My Database"},"$createdAt":{"type":"string","description":"Database creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Database update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"enabled":{"type":"boolean","description":"If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false}},"required":["$id","name","$createdAt","$updatedAt","enabled"]},"collection":{"description":"Collection","type":"object","properties":{"$id":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Collection creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Collection update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Collection name.","x-example":"My Collection"},"enabled":{"type":"boolean","description":"Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false},"documentSecurity":{"type":"boolean","description":"Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"attributes":{"type":"array","description":"Collection attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":{}},"indexes":{"type":"array","description":"Collection indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":{}}},"required":["$id","$createdAt","$updatedAt","$permissions","databaseId","name","enabled","documentSecurity","attributes","indexes"]},"attributeList":{"description":"Attributes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of attributes in the given collection.","x-example":5,"format":"int32"},"attributes":{"type":"array","description":"List of attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":""}},"required":["total","attributes"]},"attributeString":{"description":"AttributeString","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"size":{"type":"integer","description":"Attribute size.","x-example":128,"format":"int32"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default","x-nullable":true}},"required":["key","type","status","error","required","size"]},"attributeInteger":{"description":"AttributeInteger","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"count"},"type":{"type":"string","description":"Attribute type.","x-example":"integer"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"integer","description":"Minimum value to enforce for new documents.","x-example":1,"format":"int32","x-nullable":true},"max":{"type":"integer","description":"Maximum value to enforce for new documents.","x-example":10,"format":"int32","x-nullable":true},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":10,"format":"int32","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeFloat":{"description":"AttributeFloat","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"percentageCompleted"},"type":{"type":"string","description":"Attribute type.","x-example":"double"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"number","description":"Minimum value to enforce for new documents.","x-example":1.5,"format":"double","x-nullable":true},"max":{"type":"number","description":"Maximum value to enforce for new documents.","x-example":10.5,"format":"double","x-nullable":true},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":2.5,"format":"double","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeBoolean":{"description":"AttributeBoolean","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"isEnabled"},"type":{"type":"string","description":"Attribute type.","x-example":"boolean"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"x-nullable":true}},"required":["key","type","status","error","required"]},"attributeEmail":{"description":"AttributeEmail","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"userEmail"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"email"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default@example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeEnum":{"description":"AttributeEnum","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"status"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"elements":{"type":"array","description":"Array of elements in enumerated type.","items":{"type":"string"},"x-example":"element"},"format":{"type":"string","description":"String format.","x-example":"enum"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"element","x-nullable":true}},"required":["key","type","status","error","required","elements","format"]},"attributeIp":{"description":"AttributeIP","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"ipAddress"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"ip"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"192.0.2.0","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeUrl":{"description":"AttributeURL","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"githubUrl"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"url"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"http:\/\/example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeDatetime":{"description":"AttributeDatetime","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"birthDay"},"type":{"type":"string","description":"Attribute type.","x-example":"datetime"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"ISO 8601 format.","x-example":"datetime"},"default":{"type":"string","description":"Default value for attribute when not provided. Only null is optional","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeRelationship":{"description":"AttributeRelationship","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"relatedCollection":{"type":"string","description":"The ID of the related collection.","x-example":"collection"},"relationType":{"type":"string","description":"The type of the relationship.","x-example":"oneToOne|oneToMany|manyToOne|manyToMany"},"twoWay":{"type":"boolean","description":"Is the relationship two-way?","x-example":false},"twoWayKey":{"type":"string","description":"The key of the two-way relationship.","x-example":"string"},"onDelete":{"type":"string","description":"How deleting the parent document will propagate to child documents.","x-example":"restrict|cascade|setNull"},"side":{"type":"string","description":"Whether this is the parent or child side of the relationship","x-example":"parent|child"}},"required":["key","type","status","error","required","relatedCollection","relationType","twoWay","twoWayKey","onDelete","side"]},"index":{"description":"Index","type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":"index1"},"type":{"type":"string","description":"Index type.","x-example":"primary"},"status":{"type":"string","description":"Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an index.","x-example":"string"},"attributes":{"type":"array","description":"Index attributes.","items":{"type":"string"},"x-example":[]},"orders":{"type":"array","description":"Index orders.","items":{"type":"string"},"x-example":[],"x-nullable":true}},"required":["key","type","status","error","attributes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","x-nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","x-nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"x-oneOf":[{"$ref":"#\/definitions\/algoArgon2"},{"$ref":"#\/definitions\/algoScrypt"},{"$ref":"#\/definitions\/algoScryptModified"},{"$ref":"#\/definitions\/algoBcrypt"},{"$ref":"#\/definitions\/algoPhpass"},{"$ref":"#\/definitions\/algoSha"},{"$ref":"#\/definitions\/algoMd5"}]},"x-nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"bucket":{"description":"Bucket","type":"object","properties":{"$id":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Bucket creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Bucket update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"fileSecurity":{"type":"boolean","description":"Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"name":{"type":"string","description":"Bucket name.","x-example":"Documents"},"enabled":{"type":"boolean","description":"Bucket enabled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size supported.","x-example":100,"format":"int32"},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions.","items":{"type":"string"},"x-example":["jpg","png"]},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).","x-example":"gzip"},"encryption":{"type":"boolean","description":"Bucket is encrypted.","x-example":false},"antivirus":{"type":"boolean","description":"Virus scanning is enabled.","x-example":false}},"required":["$id","$createdAt","$updatedAt","$permissions","fileSecurity","name","enabled","maximumFileSize","allowedFileExtensions","compression","encryption","antivirus"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"function":{"description":"Function","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"execute":{"type":"array","description":"Execution permissions.","items":{"type":"string"},"x-example":"users"},"name":{"type":"string","description":"Function name.","x-example":"My Function"},"enabled":{"type":"boolean","description":"Function enabled.","x-example":false},"live":{"type":"boolean","description":"Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"runtime":{"type":"string","description":"Function execution runtime.","x-example":"python-3.8"},"deployment":{"type":"string","description":"Function's active deployment ID.","x-example":"5e5ea5c16897e"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"vars":{"type":"array","description":"Function variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":[]},"events":{"type":"array","description":"Function trigger events.","items":{"type":"string"},"x-example":"account.create"},"schedule":{"type":"string","description":"Function execution schedult in CRON format.","x-example":"5 4 * * *"},"timeout":{"type":"integer","description":"Function execution timeout in seconds.","x-example":300,"format":"int32"},"entrypoint":{"type":"string","description":"The entrypoint file used to execute the deployment.","x-example":"index.js"},"commands":{"type":"string","description":"The build command used to build the deployment.","x-example":"npm install"},"version":{"type":"string","description":"Version of Open Runtimes used for the function.","x-example":"v2"},"installationId":{"type":"string","description":"Function VCS (Version Control System) installation id.","x-example":"6m40at4ejk5h2u9s1hboo"},"providerRepositoryId":{"type":"string","description":"VCS (Version Control System) Repository ID","x-example":"appwrite"},"providerBranch":{"type":"string","description":"VCS (Version Control System) branch name","x-example":"main"},"providerRootDirectory":{"type":"string","description":"Path to function in VCS (Version Control System) repository","x-example":"functions\/helloWorld"},"providerSilentMode":{"type":"boolean","description":"Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests","x-example":false}},"required":["$id","$createdAt","$updatedAt","execute","name","enabled","live","logging","runtime","deployment","scopes","vars","events","schedule","timeout","entrypoint","commands","version","installationId","providerRepositoryId","providerBranch","providerRootDirectory","providerSilentMode"]},"runtime":{"description":"Runtime","type":"object","properties":{"$id":{"type":"string","description":"Runtime ID.","x-example":"python-3.8"},"name":{"type":"string","description":"Runtime Name.","x-example":"Python"},"version":{"type":"string","description":"Runtime version.","x-example":"3.8"},"base":{"type":"string","description":"Base Docker image used to build the runtime.","x-example":"python:3.8-alpine"},"image":{"type":"string","description":"Image name of Docker Hub.","x-example":"appwrite\\\/runtime-for-python:3.8"},"logo":{"type":"string","description":"Name of the logo image.","x-example":"python.png"},"supports":{"type":"array","description":"List of supported architectures.","items":{"type":"string"},"x-example":"amd64"}},"required":["$id","name","version","base","image","logo","supports"]},"deployment":{"description":"Deployment","type":"object","properties":{"$id":{"type":"string","description":"Deployment ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Deployment update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"type":{"type":"string","description":"Type of deployment.","x-example":"vcs"},"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea6g16897e"},"resourceType":{"type":"string","description":"Resource type.","x-example":"functions"},"entrypoint":{"type":"string","description":"The entrypoint file to use to execute the deployment code.","x-example":"index.js"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"},"buildId":{"type":"string","description":"The current build ID.","x-example":"5e5ea5c16897e"},"activate":{"type":"boolean","description":"Whether the deployment should be automatically activated.","x-example":true},"status":{"type":"string","description":"The deployment status. Possible values are \"processing\", \"building\", \"waiting\", \"ready\", and \"failed\".","x-example":"ready"},"buildLogs":{"type":"string","description":"The build logs.","x-example":"Compiling source files..."},"buildTime":{"type":"integer","description":"The current build time in seconds.","x-example":128,"format":"int32"},"providerRepositoryName":{"type":"string","description":"The name of the vcs provider repository","x-example":"database"},"providerRepositoryOwner":{"type":"string","description":"The name of the vcs provider repository owner","x-example":"utopia"},"providerRepositoryUrl":{"type":"string","description":"The url of the vcs provider repository","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function"},"providerBranch":{"type":"string","description":"The branch of the vcs repository","x-example":"0.7.x"},"providerCommitHash":{"type":"string","description":"The commit hash of the vcs commit","x-example":"7c3f25d"},"providerCommitAuthorUrl":{"type":"string","description":"The url of vcs commit author","x-example":"https:\/\/github.com\/vermakhushboo"},"providerCommitAuthor":{"type":"string","description":"The name of vcs commit author","x-example":"Khushboo Verma"},"providerCommitMessage":{"type":"string","description":"The commit message","x-example":"Update index.js"},"providerCommitUrl":{"type":"string","description":"The url of the vcs commit","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"},"providerBranchUrl":{"type":"string","description":"The branch of the vcs repository","x-example":"https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"}},"required":["$id","$createdAt","$updatedAt","type","resourceId","resourceType","entrypoint","size","buildId","activate","status","buildLogs","buildTime","providerRepositoryName","providerRepositoryOwner","providerRepositoryUrl","providerBranch","providerCommitHash","providerCommitAuthorUrl","providerCommitAuthor","providerCommitMessage","providerCommitUrl","providerBranchUrl"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"build":{"description":"Build","type":"object","properties":{"$id":{"type":"string","description":"Build ID.","x-example":"5e5ea5c16897e"},"deploymentId":{"type":"string","description":"The deployment that created this build.","x-example":"5e5ea5c16897e"},"status":{"type":"string","description":"The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built","x-example":"ready"},"stdout":{"type":"string","description":"The stdout of the build.","x-example":""},"stderr":{"type":"string","description":"The stderr of the build.","x-example":""},"startTime":{"type":"string","description":"The deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"endTime":{"type":"string","description":"The time the build was finished in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"duration":{"type":"integer","description":"The build duration in seconds.","x-example":0,"format":"int32"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"}},"required":["$id","deploymentId","status","stdout","stderr","startTime","endTime","duration","size"]},"variable":{"description":"Variable","type":"object","properties":{"$id":{"type":"string","description":"Variable ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"key":{"type":"string","description":"Variable key.","x-example":"API_KEY"},"value":{"type":"string","description":"Variable value.","x-example":"myPa$$word1"},"resourceType":{"type":"string","description":"Service to which the variable belongs. Possible values are \"project\", \"function\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"}},"required":["$id","$createdAt","$updatedAt","key","value","resourceType","resourceId"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"healthAntivirus":{"description":"Health Antivirus","type":"object","properties":{"version":{"type":"string","description":"Antivirus version.","x-example":"1.0.0"},"status":{"type":"string","description":"Antivirus status. Possible values can are: `disabled`, `offline`, `online`","x-example":"online"}},"required":["version","status"]},"healthQueue":{"description":"Health Queue","type":"object","properties":{"size":{"type":"integer","description":"Amount of actions in the queue.","x-example":8,"format":"int32"}},"required":["size"]},"healthStatus":{"description":"Health Status","type":"object","properties":{"name":{"type":"string","description":"Name of the service.","x-example":"database"},"ping":{"type":"integer","description":"Duration in milliseconds how long the health check took.","x-example":128,"format":"int32"},"status":{"type":"string","description":"Service status. Possible values can are: `pass`, `fail`","x-example":"pass"}},"required":["name","ping","status"]},"healthCertificate":{"description":"Health Certificate","type":"object","properties":{"name":{"type":"string","description":"Certificate name","x-example":"\/CN=www.google.com"},"subjectSN":{"type":"string","description":"Subject SN","x-example":""},"issuerOrganisation":{"type":"string","description":"Issuer organisation","x-example":""},"validFrom":{"type":"string","description":"Valid from","x-example":"1704200998"},"validTo":{"type":"string","description":"Valid to","x-example":"1711458597"},"signatureTypeSN":{"type":"string","description":"Signature type SN","x-example":"RSA-SHA256"}},"required":["name","subjectSN","issuerOrganisation","validFrom","validTo","signatureTypeSN"]},"healthTime":{"description":"Health Time","type":"object","properties":{"remoteTime":{"type":"integer","description":"Current unix timestamp on trustful remote server.","x-example":1639490751,"format":"int32"},"localTime":{"type":"integer","description":"Current unix timestamp of local server where Appwrite runs.","x-example":1639490844,"format":"int32"},"diff":{"type":"integer","description":"Difference of unix remote and local timestamps in milliseconds.","x-example":93,"format":"int32"}},"required":["remoteTime","localTime","diff"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"provider":{"description":"Provider","type":"object","properties":{"$id":{"type":"string","description":"Provider ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Provider creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Provider update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name for the provider instance.","x-example":"Mailgun"},"provider":{"type":"string","description":"The name of the provider service.","x-example":"mailgun"},"enabled":{"type":"boolean","description":"Is provider enabled?","x-example":true},"type":{"type":"string","description":"Type of provider.","x-example":"sms"},"credentials":{"type":"object","additionalProperties":true,"description":"Provider credentials.","x-example":{"key":"123456789"}},"options":{"type":"object","additionalProperties":true,"description":"Provider options.","x-example":{"from":"sender-email@mydomain"}}},"required":["$id","$createdAt","$updatedAt","name","provider","enabled","type","credentials"]},"message":{"description":"Message","type":"object","properties":{"$id":{"type":"string","description":"Message ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Message creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Message update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerType":{"type":"string","description":"Message provider type.","x-example":"email"},"topics":{"type":"array","description":"Topic IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"users":{"type":"array","description":"User IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"targets":{"type":"array","description":"Target IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"scheduledAt":{"type":"string","description":"The scheduled time for message.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveredAt":{"type":"string","description":"The time when the message was delivered.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveryErrors":{"type":"array","description":"Delivery errors if any.","items":{"type":"string"},"x-example":["Failed to send message to target 5e5ea5c16897e: Credentials not valid."],"x-nullable":true},"deliveredTotal":{"type":"integer","description":"Number of recipients the message was delivered to.","x-example":1,"format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Data of the message.","x-example":{"subject":"Welcome to Appwrite","content":"Hi there, welcome to Appwrite family."}},"status":{"type":"string","description":"Status of delivery.","x-example":"Message status can be one of the following: draft, processing, scheduled, sent, or failed."}},"required":["$id","$createdAt","$updatedAt","providerType","topics","users","targets","deliveredTotal","data","status"]},"topic":{"description":"Topic","type":"object","properties":{"$id":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Topic creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Topic update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name of the topic.","x-example":"events"},"emailTotal":{"type":"integer","description":"Total count of email subscribers subscribed to the topic.","x-example":100,"format":"int32"},"smsTotal":{"type":"integer","description":"Total count of SMS subscribers subscribed to the topic.","x-example":100,"format":"int32"},"pushTotal":{"type":"integer","description":"Total count of push subscribers subscribed to the topic.","x-example":100,"format":"int32"},"subscribe":{"type":"array","description":"Subscribe permissions.","items":{"type":"string"},"x-example":"users"}},"required":["$id","$createdAt","$updatedAt","name","emailTotal","smsTotal","pushTotal","subscribe"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"type":"object","$ref":"#\/definitions\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","x-nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php index b6e6337a00..37627d79fc 100644 --- a/app/controllers/api/account.php +++ b/app/controllers/api/account.php @@ -3945,7 +3945,7 @@ App::get('/v1/account/mfa/recovery-codes') App::delete('/v1/account/mfa/authenticators/:type') ->desc('Delete Authenticator') - ->groups(['api', 'account']) + ->groups(['api', 'account', 'mfaProtected']) ->label('event', 'users.[userId].delete.mfa') ->label('scope', 'account') ->label('audits.event', 'user.update') @@ -3958,12 +3958,11 @@ App::delete('/v1/account/mfa/authenticators/:type') ->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT) ->label('sdk.response.model', Response::MODEL_NONE) ->param('type', null, new WhiteList([Type::TOTP]), 'Type of authenticator.') - ->param('otp', '', new Text(256), 'Valid verification token.') ->inject('response') ->inject('user') ->inject('dbForProject') ->inject('queueForEvents') - ->action(function (string $type, string $otp, Response $response, Document $user, Database $dbForProject, Event $queueForEvents) { + ->action(function (string $type, Response $response, Document $user, Database $dbForProject, Event $queueForEvents) { $authenticator = (match ($type) { Type::TOTP => TOTP::getAuthenticatorFromUser($user), @@ -3974,27 +3973,6 @@ App::delete('/v1/account/mfa/authenticators/:type') throw new Exception(Exception::USER_AUTHENTICATOR_NOT_FOUND); } - $success = (match ($type) { - Type::TOTP => Challenge\TOTP::verify($user, $otp), - default => false - }); - - if (!$success) { - $mfaRecoveryCodes = $user->getAttribute('mfaRecoveryCodes', []); - if (in_array($otp, $mfaRecoveryCodes)) { - $mfaRecoveryCodes = array_diff($mfaRecoveryCodes, [$otp]); - $mfaRecoveryCodes = array_values($mfaRecoveryCodes); - $user->setAttribute('mfaRecoveryCodes', $mfaRecoveryCodes); - $dbForProject->updateDocument('users', $user->getId(), $user); - - $success = true; - } - } - - if (!$success) { - throw new Exception(Exception::USER_INVALID_TOKEN); - } - $dbForProject->deleteDocument('authenticators', $authenticator->getId()); $dbForProject->purgeCachedDocument('users', $user->getId()); From 8c19fcd087f8de8691b53e418baec3f3be3ceb38 Mon Sep 17 00:00:00 2001 From: Bradley Schofield <ionicisere@gmail.com> Date: Mon, 8 Jul 2024 12:59:49 +0900 Subject: [PATCH 2/6] Update documentation --- .../client-rest/examples/account/delete-mfa-authenticator.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/examples/1.5.x/client-rest/examples/account/delete-mfa-authenticator.md b/docs/examples/1.5.x/client-rest/examples/account/delete-mfa-authenticator.md index 3d178f6b59..9e0fbb8707 100644 --- a/docs/examples/1.5.x/client-rest/examples/account/delete-mfa-authenticator.md +++ b/docs/examples/1.5.x/client-rest/examples/account/delete-mfa-authenticator.md @@ -5,7 +5,3 @@ X-Appwrite-Response-Format: 1.5.0 X-Appwrite-Project: 5df5acd0d48c2 X-Appwrite-Session: X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ... - -{ - "otp": "<OTP>" -} From 542d2e23bdf65449da89775a43271df3e413c63c Mon Sep 17 00:00:00 2001 From: Bradley Schofield <ionicisere@gmail.com> Date: Tue, 9 Jul 2024 02:21:52 +0000 Subject: [PATCH 3/6] Rollback Docs --- .../client-rest/examples/account/delete-mfa-authenticator.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/examples/1.5.x/client-rest/examples/account/delete-mfa-authenticator.md b/docs/examples/1.5.x/client-rest/examples/account/delete-mfa-authenticator.md index 9e0fbb8707..dfb054f980 100644 --- a/docs/examples/1.5.x/client-rest/examples/account/delete-mfa-authenticator.md +++ b/docs/examples/1.5.x/client-rest/examples/account/delete-mfa-authenticator.md @@ -5,3 +5,7 @@ X-Appwrite-Response-Format: 1.5.0 X-Appwrite-Project: 5df5acd0d48c2 X-Appwrite-Session: X-Appwrite-JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ... + +{ + "otp": "<OTP>" +} \ No newline at end of file From 14ce70b0ffe3d74ec01aa408e651a0bda75621b0 Mon Sep 17 00:00:00 2001 From: Bradley Schofield <ionicisere@gmail.com> Date: Tue, 9 Jul 2024 13:49:44 +0900 Subject: [PATCH 4/6] Add 1.6.x Docs --- app/config/specs/swagger2-1.6.X-client.json | 1 + app/config/specs/swagger2-1.6.X-console.json | 1 + app/config/specs/swagger2-1.6.x-server.json | 1 + .../java/account/create-anonymous-session.md | 18 ++++++ .../account/create-email-password-session.md | 23 ++++++++ .../java/account/create-email-token.md | 24 ++++++++ .../java/account/create-j-w-t.md | 18 ++++++ .../java/account/create-magic-u-r-l-token.md | 25 ++++++++ .../java/account/create-mfa-authenticator.md | 23 ++++++++ .../java/account/create-mfa-challenge.md | 23 ++++++++ .../java/account/create-mfa-recovery-codes.md | 18 ++++++ .../java/account/create-o-auth2session.md | 26 +++++++++ .../java/account/create-o-auth2token.md | 26 +++++++++ .../java/account/create-phone-token.md | 23 ++++++++ .../java/account/create-phone-verification.md | 18 ++++++ .../java/account/create-push-target.md | 24 ++++++++ .../java/account/create-recovery.md | 23 ++++++++ .../java/account/create-session.md | 23 ++++++++ .../java/account/create-verification.md | 22 +++++++ .../client-android/java/account/create.md | 25 ++++++++ .../java/account/delete-identity.md | 22 +++++++ .../java/account/delete-mfa-authenticator.md | 23 ++++++++ .../java/account/delete-push-target.md | 22 +++++++ .../java/account/delete-session.md | 22 +++++++ .../java/account/delete-sessions.md | 18 ++++++ .../java/account/get-mfa-recovery-codes.md | 18 ++++++ .../client-android/java/account/get-prefs.md | 18 ++++++ .../java/account/get-session.md | 22 +++++++ .../1.6.x/client-android/java/account/get.md | 18 ++++++ .../java/account/list-identities.md | 22 +++++++ .../client-android/java/account/list-logs.md | 22 +++++++ .../java/account/list-mfa-factors.md | 18 ++++++ .../java/account/list-sessions.md | 18 ++++++ .../java/account/update-email.md | 23 ++++++++ .../java/account/update-m-f-a.md | 22 +++++++ .../account/update-magic-u-r-l-session.md | 23 ++++++++ .../java/account/update-mfa-authenticator.md | 24 ++++++++ .../java/account/update-mfa-challenge.md | 23 ++++++++ .../java/account/update-mfa-recovery-codes.md | 18 ++++++ .../java/account/update-name.md | 22 +++++++ .../java/account/update-password.md | 23 ++++++++ .../java/account/update-phone-session.md | 23 ++++++++ .../java/account/update-phone-verification.md | 23 ++++++++ .../java/account/update-phone.md | 23 ++++++++ .../java/account/update-prefs.md | 22 +++++++ .../java/account/update-push-target.md | 23 ++++++++ .../java/account/update-recovery.md | 24 ++++++++ .../java/account/update-session.md | 22 +++++++ .../java/account/update-status.md | 18 ++++++ .../java/account/update-verification.md | 23 ++++++++ .../java/avatars/get-browser.md | 26 +++++++++ .../java/avatars/get-credit-card.md | 26 +++++++++ .../java/avatars/get-favicon.md | 22 +++++++ .../client-android/java/avatars/get-flag.md | 26 +++++++++ .../client-android/java/avatars/get-image.md | 24 ++++++++ .../java/avatars/get-initials.md | 25 ++++++++ .../client-android/java/avatars/get-q-r.md | 25 ++++++++ .../java/databases/create-document.md | 26 +++++++++ .../java/databases/delete-document.md | 24 ++++++++ .../java/databases/get-document.md | 25 ++++++++ .../java/databases/list-documents.md | 24 ++++++++ .../java/databases/update-document.md | 26 +++++++++ .../java/functions/create-execution.md | 28 +++++++++ .../java/functions/get-execution.md | 23 ++++++++ .../java/functions/list-executions.md | 24 ++++++++ .../client-android/java/graphql/mutation.md | 22 +++++++ .../client-android/java/graphql/query.md | 22 +++++++ .../1.6.x/client-android/java/locale/get.md | 18 ++++++ .../client-android/java/locale/list-codes.md | 18 ++++++ .../java/locale/list-continents.md | 18 ++++++ .../java/locale/list-countries-e-u.md | 18 ++++++ .../java/locale/list-countries-phones.md | 18 ++++++ .../java/locale/list-countries.md | 18 ++++++ .../java/locale/list-currencies.md | 18 ++++++ .../java/locale/list-languages.md | 18 ++++++ .../java/messaging/create-subscriber.md | 24 ++++++++ .../java/messaging/delete-subscriber.md | 23 ++++++++ .../java/storage/create-file.md | 26 +++++++++ .../java/storage/delete-file.md | 23 ++++++++ .../java/storage/get-file-download.md | 23 ++++++++ .../java/storage/get-file-preview.md | 34 +++++++++++ .../java/storage/get-file-view.md | 23 ++++++++ .../client-android/java/storage/get-file.md | 23 ++++++++ .../client-android/java/storage/list-files.md | 24 ++++++++ .../java/storage/update-file.md | 25 ++++++++ .../java/teams/create-membership.md | 28 +++++++++ .../1.6.x/client-android/java/teams/create.md | 24 ++++++++ .../java/teams/delete-membership.md | 23 ++++++++ .../1.6.x/client-android/java/teams/delete.md | 22 +++++++ .../java/teams/get-membership.md | 23 ++++++++ .../client-android/java/teams/get-prefs.md | 22 +++++++ .../1.6.x/client-android/java/teams/get.md | 22 +++++++ .../java/teams/list-memberships.md | 24 ++++++++ .../1.6.x/client-android/java/teams/list.md | 23 ++++++++ .../java/teams/update-membership-status.md | 25 ++++++++ .../java/teams/update-membership.md | 24 ++++++++ .../client-android/java/teams/update-name.md | 23 ++++++++ .../client-android/java/teams/update-prefs.md | 23 ++++++++ .../account/create-anonymous-session.md | 11 ++++ .../account/create-email-password-session.md | 14 +++++ .../kotlin/account/create-email-token.md | 15 +++++ .../kotlin/account/create-j-w-t.md | 11 ++++ .../account/create-magic-u-r-l-token.md | 16 ++++++ .../account/create-mfa-authenticator.md | 14 +++++ .../kotlin/account/create-mfa-challenge.md | 14 +++++ .../account/create-mfa-recovery-codes.md | 11 ++++ .../kotlin/account/create-o-auth2session.md | 17 ++++++ .../kotlin/account/create-o-auth2token.md | 17 ++++++ .../kotlin/account/create-phone-token.md | 14 +++++ .../account/create-phone-verification.md | 11 ++++ .../kotlin/account/create-push-target.md | 15 +++++ .../kotlin/account/create-recovery.md | 14 +++++ .../kotlin/account/create-session.md | 14 +++++ .../kotlin/account/create-verification.md | 13 +++++ .../client-android/kotlin/account/create.md | 16 ++++++ .../kotlin/account/delete-identity.md | 13 +++++ .../account/delete-mfa-authenticator.md | 14 +++++ .../kotlin/account/delete-push-target.md | 13 +++++ .../kotlin/account/delete-session.md | 13 +++++ .../kotlin/account/delete-sessions.md | 11 ++++ .../kotlin/account/get-mfa-recovery-codes.md | 11 ++++ .../kotlin/account/get-prefs.md | 11 ++++ .../kotlin/account/get-session.md | 13 +++++ .../client-android/kotlin/account/get.md | 11 ++++ .../kotlin/account/list-identities.md | 13 +++++ .../kotlin/account/list-logs.md | 13 +++++ .../kotlin/account/list-mfa-factors.md | 11 ++++ .../kotlin/account/list-sessions.md | 11 ++++ .../kotlin/account/update-email.md | 14 +++++ .../kotlin/account/update-m-f-a.md | 13 +++++ .../account/update-magic-u-r-l-session.md | 14 +++++ .../account/update-mfa-authenticator.md | 15 +++++ .../kotlin/account/update-mfa-challenge.md | 14 +++++ .../account/update-mfa-recovery-codes.md | 11 ++++ .../kotlin/account/update-name.md | 13 +++++ .../kotlin/account/update-password.md | 14 +++++ .../kotlin/account/update-phone-session.md | 14 +++++ .../account/update-phone-verification.md | 14 +++++ .../kotlin/account/update-phone.md | 14 +++++ .../kotlin/account/update-prefs.md | 13 +++++ .../kotlin/account/update-push-target.md | 14 +++++ .../kotlin/account/update-recovery.md | 15 +++++ .../kotlin/account/update-session.md | 13 +++++ .../kotlin/account/update-status.md | 11 ++++ .../kotlin/account/update-verification.md | 14 +++++ .../kotlin/avatars/get-browser.md | 17 ++++++ .../kotlin/avatars/get-credit-card.md | 17 ++++++ .../kotlin/avatars/get-favicon.md | 13 +++++ .../client-android/kotlin/avatars/get-flag.md | 17 ++++++ .../kotlin/avatars/get-image.md | 15 +++++ .../kotlin/avatars/get-initials.md | 16 ++++++ .../client-android/kotlin/avatars/get-q-r.md | 16 ++++++ .../kotlin/databases/create-document.md | 17 ++++++ .../kotlin/databases/delete-document.md | 15 +++++ .../kotlin/databases/get-document.md | 16 ++++++ .../kotlin/databases/list-documents.md | 15 +++++ .../kotlin/databases/update-document.md | 17 ++++++ .../kotlin/functions/create-execution.md | 19 +++++++ .../kotlin/functions/get-execution.md | 14 +++++ .../kotlin/functions/list-executions.md | 15 +++++ .../client-android/kotlin/graphql/mutation.md | 13 +++++ .../client-android/kotlin/graphql/query.md | 13 +++++ .../1.6.x/client-android/kotlin/locale/get.md | 11 ++++ .../kotlin/locale/list-codes.md | 11 ++++ .../kotlin/locale/list-continents.md | 11 ++++ .../kotlin/locale/list-countries-e-u.md | 11 ++++ .../kotlin/locale/list-countries-phones.md | 11 ++++ .../kotlin/locale/list-countries.md | 11 ++++ .../kotlin/locale/list-currencies.md | 11 ++++ .../kotlin/locale/list-languages.md | 11 ++++ .../kotlin/messaging/create-subscriber.md | 15 +++++ .../kotlin/messaging/delete-subscriber.md | 14 +++++ .../kotlin/storage/create-file.md | 17 ++++++ .../kotlin/storage/delete-file.md | 14 +++++ .../kotlin/storage/get-file-download.md | 14 +++++ .../kotlin/storage/get-file-preview.md | 25 ++++++++ .../kotlin/storage/get-file-view.md | 14 +++++ .../client-android/kotlin/storage/get-file.md | 14 +++++ .../kotlin/storage/list-files.md | 15 +++++ .../kotlin/storage/update-file.md | 16 ++++++ .../kotlin/teams/create-membership.md | 19 +++++++ .../client-android/kotlin/teams/create.md | 15 +++++ .../kotlin/teams/delete-membership.md | 14 +++++ .../client-android/kotlin/teams/delete.md | 13 +++++ .../kotlin/teams/get-membership.md | 14 +++++ .../client-android/kotlin/teams/get-prefs.md | 13 +++++ .../1.6.x/client-android/kotlin/teams/get.md | 13 +++++ .../kotlin/teams/list-memberships.md | 15 +++++ .../1.6.x/client-android/kotlin/teams/list.md | 14 +++++ .../kotlin/teams/update-membership-status.md | 16 ++++++ .../kotlin/teams/update-membership.md | 15 +++++ .../kotlin/teams/update-name.md | 14 +++++ .../kotlin/teams/update-prefs.md | 14 +++++ .../account/create-anonymous-session.md | 10 ++++ .../account/create-email-password-session.md | 13 +++++ .../examples/account/create-email-token.md | 14 +++++ .../examples/account/create-j-w-t.md | 10 ++++ .../account/create-magic-u-r-l-token.md | 15 +++++ .../account/create-mfa-authenticator.md | 13 +++++ .../examples/account/create-mfa-challenge.md | 13 +++++ .../account/create-mfa-recovery-codes.md | 10 ++++ .../examples/account/create-o-auth2session.md | 16 ++++++ .../examples/account/create-o-auth2token.md | 16 ++++++ .../examples/account/create-phone-token.md | 13 +++++ .../account/create-phone-verification.md | 10 ++++ .../examples/account/create-push-target.md | 14 +++++ .../examples/account/create-recovery.md | 13 +++++ .../examples/account/create-session.md | 13 +++++ .../examples/account/create-verification.md | 12 ++++ .../client-apple/examples/account/create.md | 15 +++++ .../examples/account/delete-identity.md | 12 ++++ .../account/delete-mfa-authenticator.md | 13 +++++ .../examples/account/delete-push-target.md | 12 ++++ .../examples/account/delete-session.md | 12 ++++ .../examples/account/delete-sessions.md | 10 ++++ .../account/get-mfa-recovery-codes.md | 10 ++++ .../examples/account/get-prefs.md | 10 ++++ .../examples/account/get-session.md | 12 ++++ .../client-apple/examples/account/get.md | 10 ++++ .../examples/account/list-identities.md | 12 ++++ .../examples/account/list-logs.md | 12 ++++ .../examples/account/list-mfa-factors.md | 10 ++++ .../examples/account/list-sessions.md | 10 ++++ .../examples/account/update-email.md | 13 +++++ .../examples/account/update-m-f-a.md | 12 ++++ .../account/update-magic-u-r-l-session.md | 13 +++++ .../account/update-mfa-authenticator.md | 14 +++++ .../examples/account/update-mfa-challenge.md | 13 +++++ .../account/update-mfa-recovery-codes.md | 10 ++++ .../examples/account/update-name.md | 12 ++++ .../examples/account/update-password.md | 13 +++++ .../examples/account/update-phone-session.md | 13 +++++ .../account/update-phone-verification.md | 13 +++++ .../examples/account/update-phone.md | 13 +++++ .../examples/account/update-prefs.md | 12 ++++ .../examples/account/update-push-target.md | 13 +++++ .../examples/account/update-recovery.md | 14 +++++ .../examples/account/update-session.md | 12 ++++ .../examples/account/update-status.md | 10 ++++ .../examples/account/update-verification.md | 13 +++++ .../examples/avatars/get-browser.md | 16 ++++++ .../examples/avatars/get-credit-card.md | 16 ++++++ .../examples/avatars/get-favicon.md | 12 ++++ .../client-apple/examples/avatars/get-flag.md | 16 ++++++ .../examples/avatars/get-image.md | 14 +++++ .../examples/avatars/get-initials.md | 15 +++++ .../client-apple/examples/avatars/get-q-r.md | 15 +++++ .../examples/databases/create-document.md | 16 ++++++ .../examples/databases/delete-document.md | 14 +++++ .../examples/databases/get-document.md | 15 +++++ .../examples/databases/list-documents.md | 14 +++++ .../examples/databases/update-document.md | 16 ++++++ .../examples/functions/create-execution.md | 19 +++++++ .../examples/functions/get-execution.md | 13 +++++ .../examples/functions/list-executions.md | 14 +++++ .../client-apple/examples/graphql/mutation.md | 12 ++++ .../client-apple/examples/graphql/query.md | 12 ++++ .../1.6.x/client-apple/examples/locale/get.md | 10 ++++ .../examples/locale/list-codes.md | 10 ++++ .../examples/locale/list-continents.md | 10 ++++ .../examples/locale/list-countries-e-u.md | 10 ++++ .../examples/locale/list-countries-phones.md | 10 ++++ .../examples/locale/list-countries.md | 10 ++++ .../examples/locale/list-currencies.md | 10 ++++ .../examples/locale/list-languages.md | 10 ++++ .../examples/messaging/create-subscriber.md | 14 +++++ .../examples/messaging/delete-subscriber.md | 13 +++++ .../examples/storage/create-file.md | 15 +++++ .../examples/storage/delete-file.md | 13 +++++ .../examples/storage/get-file-download.md | 13 +++++ .../examples/storage/get-file-preview.md | 25 ++++++++ .../examples/storage/get-file-view.md | 13 +++++ .../client-apple/examples/storage/get-file.md | 13 +++++ .../examples/storage/list-files.md | 14 +++++ .../examples/storage/update-file.md | 15 +++++ .../examples/teams/create-membership.md | 18 ++++++ .../client-apple/examples/teams/create.md | 14 +++++ .../examples/teams/delete-membership.md | 13 +++++ .../client-apple/examples/teams/delete.md | 12 ++++ .../examples/teams/get-membership.md | 13 +++++ .../client-apple/examples/teams/get-prefs.md | 12 ++++ .../1.6.x/client-apple/examples/teams/get.md | 12 ++++ .../examples/teams/list-memberships.md | 14 +++++ .../1.6.x/client-apple/examples/teams/list.md | 13 +++++ .../teams/update-membership-status.md | 15 +++++ .../examples/teams/update-membership.md | 14 +++++ .../examples/teams/update-name.md | 13 +++++ .../examples/teams/update-prefs.md | 13 +++++ .../account/create-anonymous-session.md | 9 +++ .../account/create-email-password-session.md | 12 ++++ .../examples/account/create-email-token.md | 13 +++++ .../examples/account/create-j-w-t.md | 9 +++ .../account/create-magic-u-r-l-token.md | 14 +++++ .../account/create-mfa-authenticator.md | 11 ++++ .../examples/account/create-mfa-challenge.md | 11 ++++ .../account/create-mfa-recovery-codes.md | 9 +++ .../examples/account/create-o-auth2session.md | 14 +++++ .../examples/account/create-o-auth2token.md | 14 +++++ .../examples/account/create-phone-token.md | 12 ++++ .../account/create-phone-verification.md | 9 +++ .../examples/account/create-push-target.md | 13 +++++ .../examples/account/create-recovery.md | 12 ++++ .../examples/account/create-session.md | 12 ++++ .../examples/account/create-verification.md | 11 ++++ .../client-flutter/examples/account/create.md | 14 +++++ .../examples/account/delete-identity.md | 11 ++++ .../account/delete-mfa-authenticator.md | 11 ++++ .../examples/account/delete-push-target.md | 11 ++++ .../examples/account/delete-session.md | 11 ++++ .../examples/account/delete-sessions.md | 9 +++ .../account/get-mfa-recovery-codes.md | 9 +++ .../examples/account/get-prefs.md | 9 +++ .../examples/account/get-session.md | 11 ++++ .../client-flutter/examples/account/get.md | 9 +++ .../examples/account/list-identities.md | 11 ++++ .../examples/account/list-logs.md | 11 ++++ .../examples/account/list-mfa-factors.md | 9 +++ .../examples/account/list-sessions.md | 9 +++ .../examples/account/update-email.md | 12 ++++ .../examples/account/update-m-f-a.md | 11 ++++ .../account/update-magic-u-r-l-session.md | 12 ++++ .../account/update-mfa-authenticator.md | 12 ++++ .../examples/account/update-mfa-challenge.md | 12 ++++ .../account/update-mfa-recovery-codes.md | 9 +++ .../examples/account/update-name.md | 11 ++++ .../examples/account/update-password.md | 12 ++++ .../examples/account/update-phone-session.md | 12 ++++ .../account/update-phone-verification.md | 12 ++++ .../examples/account/update-phone.md | 12 ++++ .../examples/account/update-prefs.md | 11 ++++ .../examples/account/update-push-target.md | 12 ++++ .../examples/account/update-recovery.md | 13 +++++ .../examples/account/update-session.md | 11 ++++ .../examples/account/update-status.md | 9 +++ .../examples/account/update-verification.md | 12 ++++ .../examples/avatars/get-browser.md | 33 +++++++++++ .../examples/avatars/get-credit-card.md | 33 +++++++++++ .../examples/avatars/get-favicon.md | 27 +++++++++ .../examples/avatars/get-flag.md | 33 +++++++++++ .../examples/avatars/get-image.md | 31 ++++++++++ .../examples/avatars/get-initials.md | 33 +++++++++++ .../examples/avatars/get-q-r.md | 33 +++++++++++ .../examples/databases/create-document.md | 15 +++++ .../examples/databases/delete-document.md | 13 +++++ .../examples/databases/get-document.md | 14 +++++ .../examples/databases/list-documents.md | 13 +++++ .../examples/databases/update-document.md | 15 +++++ .../examples/functions/create-execution.md | 17 ++++++ .../examples/functions/get-execution.md | 12 ++++ .../examples/functions/list-executions.md | 13 +++++ .../examples/graphql/mutation.md | 11 ++++ .../client-flutter/examples/graphql/query.md | 11 ++++ .../client-flutter/examples/locale/get.md | 9 +++ .../examples/locale/list-codes.md | 9 +++ .../examples/locale/list-continents.md | 9 +++ .../examples/locale/list-countries-e-u.md | 9 +++ .../examples/locale/list-countries-phones.md | 9 +++ .../examples/locale/list-countries.md | 9 +++ .../examples/locale/list-currencies.md | 9 +++ .../examples/locale/list-languages.md | 9 +++ .../examples/messaging/create-subscriber.md | 13 +++++ .../examples/messaging/delete-subscriber.md | 12 ++++ .../examples/storage/create-file.md | 15 +++++ .../examples/storage/delete-file.md | 12 ++++ .../examples/storage/get-file-download.md | 29 ++++++++++ .../examples/storage/get-file-preview.md | 51 +++++++++++++++++ .../examples/storage/get-file-view.md | 29 ++++++++++ .../examples/storage/get-file.md | 12 ++++ .../examples/storage/list-files.md | 13 +++++ .../examples/storage/update-file.md | 14 +++++ .../examples/teams/create-membership.md | 17 ++++++ .../client-flutter/examples/teams/create.md | 13 +++++ .../examples/teams/delete-membership.md | 12 ++++ .../client-flutter/examples/teams/delete.md | 11 ++++ .../examples/teams/get-membership.md | 12 ++++ .../examples/teams/get-prefs.md | 11 ++++ .../client-flutter/examples/teams/get.md | 11 ++++ .../examples/teams/list-memberships.md | 13 +++++ .../client-flutter/examples/teams/list.md | 12 ++++ .../teams/update-membership-status.md | 14 +++++ .../examples/teams/update-membership.md | 13 +++++ .../examples/teams/update-name.md | 12 ++++ .../examples/teams/update-prefs.md | 12 ++++ .../account/create-anonymous-session.md | 33 +++++++++++ .../account/create-email-password-session.md | 36 ++++++++++++ .../examples/account/create-email-token.md | 14 +++++ .../examples/account/create-j-w-t.md | 5 ++ .../account/create-magic-u-r-l-token.md | 15 +++++ .../account/create-mfa-authenticator.md | 8 +++ .../examples/account/create-mfa-challenge.md | 10 ++++ .../account/create-mfa-recovery-codes.md | 5 ++ .../examples/account/create-phone-token.md | 13 +++++ .../account/create-phone-verification.md | 10 ++++ .../examples/account/create-push-target.md | 16 ++++++ .../examples/account/create-recovery.md | 13 +++++ .../examples/account/create-session.md | 36 ++++++++++++ .../examples/account/create-verification.md | 12 ++++ .../client-graphql/examples/account/create.md | 39 +++++++++++++ .../examples/account/delete-identity.md | 7 +++ .../account/delete-mfa-authenticator.md | 7 +++ .../examples/account/delete-push-target.md | 7 +++ .../examples/account/delete-session.md | 7 +++ .../examples/account/delete-sessions.md | 5 ++ .../account/get-mfa-recovery-codes.md | 5 ++ .../examples/account/get-prefs.md | 5 ++ .../examples/account/get-session.md | 35 ++++++++++++ .../client-graphql/examples/account/get.md | 34 +++++++++++ .../examples/account/list-identities.md | 19 +++++++ .../examples/account/list-logs.md | 30 ++++++++++ .../examples/account/list-mfa-factors.md | 8 +++ .../examples/account/list-sessions.md | 36 ++++++++++++ .../examples/account/update-email.md | 37 ++++++++++++ .../examples/account/update-m-f-a.md | 36 ++++++++++++ .../account/update-magic-u-r-l-session.md | 36 ++++++++++++ .../account/update-mfa-authenticator.md | 37 ++++++++++++ .../examples/account/update-mfa-challenge.md | 8 +++ .../account/update-mfa-recovery-codes.md | 5 ++ .../examples/account/update-name.md | 36 ++++++++++++ .../examples/account/update-password.md | 37 ++++++++++++ .../examples/account/update-phone-session.md | 36 ++++++++++++ .../account/update-phone-verification.md | 13 +++++ .../examples/account/update-phone.md | 37 ++++++++++++ .../examples/account/update-prefs.md | 36 ++++++++++++ .../examples/account/update-push-target.md | 15 +++++ .../examples/account/update-recovery.md | 14 +++++ .../examples/account/update-session.md | 35 ++++++++++++ .../examples/account/update-status.md | 34 +++++++++++ .../examples/account/update-verification.md | 13 +++++ .../examples/avatars/get-browser.md | 10 ++++ .../examples/avatars/get-credit-card.md | 10 ++++ .../examples/avatars/get-favicon.md | 7 +++ .../examples/avatars/get-flag.md | 10 ++++ .../examples/avatars/get-image.md | 9 +++ .../examples/avatars/get-initials.md | 10 ++++ .../examples/avatars/get-q-r.md | 10 ++++ .../examples/databases/create-document.md | 17 ++++++ .../examples/databases/delete-document.md | 9 +++ .../examples/databases/get-document.md | 16 ++++++ .../examples/databases/list-documents.md | 18 ++++++ .../examples/databases/update-document.md | 17 ++++++ .../examples/functions/create-execution.md | 34 +++++++++++ .../examples/functions/get-execution.md | 29 ++++++++++ .../examples/functions/list-executions.md | 33 +++++++++++ .../client-graphql/examples/locale/get.md | 11 ++++ .../examples/locale/list-codes.md | 9 +++ .../examples/locale/list-continents.md | 9 +++ .../examples/locale/list-countries-e-u.md | 9 +++ .../examples/locale/list-countries-phones.md | 10 ++++ .../examples/locale/list-countries.md | 9 +++ .../examples/locale/list-currencies.md | 14 +++++ .../examples/locale/list-languages.md | 10 ++++ .../examples/messaging/create-subscriber.md | 26 +++++++++ .../examples/messaging/delete-subscriber.md | 8 +++ .../examples/storage/create-file.md | 25 ++++++++ .../examples/storage/delete-file.md | 8 +++ .../examples/storage/get-file-download.md | 8 +++ .../examples/storage/get-file-preview.md | 19 +++++++ .../examples/storage/get-file-view.md | 8 +++ .../examples/storage/get-file.md | 18 ++++++ .../examples/storage/list-files.md | 22 +++++++ .../examples/storage/update-file.md | 20 +++++++ .../examples/teams/create-membership.md | 25 ++++++++ .../client-graphql/examples/teams/create.md | 16 ++++++ .../examples/teams/delete-membership.md | 8 +++ .../client-graphql/examples/teams/delete.md | 7 +++ .../examples/teams/get-membership.md | 20 +++++++ .../examples/teams/get-prefs.md | 7 +++ .../client-graphql/examples/teams/get.md | 14 +++++ .../examples/teams/list-memberships.md | 24 ++++++++ .../client-graphql/examples/teams/list.md | 18 ++++++ .../teams/update-membership-status.md | 22 +++++++ .../examples/teams/update-membership.md | 21 +++++++ .../examples/teams/update-name.md | 15 +++++ .../examples/teams/update-prefs.md | 8 +++ .../account/create-anonymous-session.md | 11 ++++ .../account/create-email-password-session.md | 14 +++++ .../examples/account/create-email-token.md | 15 +++++ .../examples/account/create-j-w-t.md | 11 ++++ .../account/create-magic-u-r-l-token.md | 16 ++++++ .../account/create-mfa-authenticator.md | 13 +++++ .../examples/account/create-mfa-challenge.md | 13 +++++ .../account/create-mfa-recovery-codes.md | 11 ++++ .../examples/account/create-o-auth2session.md | 15 +++++ .../examples/account/create-o-auth2token.md | 15 +++++ .../examples/account/create-phone-token.md | 14 +++++ .../account/create-phone-verification.md | 11 ++++ .../examples/account/create-push-target.md | 15 +++++ .../examples/account/create-recovery.md | 14 +++++ .../examples/account/create-session.md | 14 +++++ .../examples/account/create-verification.md | 13 +++++ .../examples/account/create.md | 16 ++++++ .../examples/account/delete-identity.md | 13 +++++ .../account/delete-mfa-authenticator.md | 13 +++++ .../examples/account/delete-push-target.md | 13 +++++ .../examples/account/delete-session.md | 13 +++++ .../examples/account/delete-sessions.md | 11 ++++ .../account/get-mfa-recovery-codes.md | 11 ++++ .../examples/account/get-prefs.md | 11 ++++ .../examples/account/get-session.md | 13 +++++ .../examples/account/get.md | 11 ++++ .../examples/account/list-identities.md | 13 +++++ .../examples/account/list-logs.md | 13 +++++ .../examples/account/list-mfa-factors.md | 11 ++++ .../examples/account/list-sessions.md | 11 ++++ .../examples/account/update-email.md | 14 +++++ .../examples/account/update-m-f-a.md | 13 +++++ .../account/update-magic-u-r-l-session.md | 14 +++++ .../account/update-mfa-authenticator.md | 14 +++++ .../examples/account/update-mfa-challenge.md | 14 +++++ .../account/update-mfa-recovery-codes.md | 11 ++++ .../examples/account/update-name.md | 13 +++++ .../examples/account/update-password.md | 14 +++++ .../examples/account/update-phone-session.md | 14 +++++ .../account/update-phone-verification.md | 14 +++++ .../examples/account/update-phone.md | 14 +++++ .../examples/account/update-prefs.md | 13 +++++ .../examples/account/update-push-target.md | 14 +++++ .../examples/account/update-recovery.md | 15 +++++ .../examples/account/update-session.md | 13 +++++ .../examples/account/update-status.md | 11 ++++ .../examples/account/update-verification.md | 14 +++++ .../examples/avatars/get-browser.md | 16 ++++++ .../examples/avatars/get-credit-card.md | 16 ++++++ .../examples/avatars/get-favicon.md | 13 +++++ .../examples/avatars/get-flag.md | 16 ++++++ .../examples/avatars/get-image.md | 15 +++++ .../examples/avatars/get-initials.md | 16 ++++++ .../examples/avatars/get-q-r.md | 16 ++++++ .../examples/databases/create-document.md | 17 ++++++ .../examples/databases/delete-document.md | 15 +++++ .../examples/databases/get-document.md | 16 ++++++ .../examples/databases/list-documents.md | 15 +++++ .../examples/databases/update-document.md | 17 ++++++ .../examples/functions/create-execution.md | 19 +++++++ .../examples/functions/get-execution.md | 14 +++++ .../examples/functions/list-executions.md | 15 +++++ .../examples/graphql/mutation.md | 13 +++++ .../examples/graphql/query.md | 13 +++++ .../examples/locale/get.md | 11 ++++ .../examples/locale/list-codes.md | 11 ++++ .../examples/locale/list-continents.md | 11 ++++ .../examples/locale/list-countries-e-u.md | 11 ++++ .../examples/locale/list-countries-phones.md | 11 ++++ .../examples/locale/list-countries.md | 11 ++++ .../examples/locale/list-currencies.md | 11 ++++ .../examples/locale/list-languages.md | 11 ++++ .../examples/messaging/create-subscriber.md | 15 +++++ .../examples/messaging/delete-subscriber.md | 14 +++++ .../examples/storage/create-file.md | 16 ++++++ .../examples/storage/delete-file.md | 14 +++++ .../examples/storage/get-file-download.md | 14 +++++ .../examples/storage/get-file-preview.md | 25 ++++++++ .../examples/storage/get-file-view.md | 14 +++++ .../examples/storage/get-file.md | 14 +++++ .../examples/storage/list-files.md | 15 +++++ .../examples/storage/update-file.md | 16 ++++++ .../examples/teams/create-membership.md | 19 +++++++ .../examples/teams/create.md | 15 +++++ .../examples/teams/delete-membership.md | 14 +++++ .../examples/teams/delete.md | 13 +++++ .../examples/teams/get-membership.md | 14 +++++ .../examples/teams/get-prefs.md | 13 +++++ .../client-react-native/examples/teams/get.md | 13 +++++ .../examples/teams/list-memberships.md | 15 +++++ .../examples/teams/list.md | 14 +++++ .../teams/update-membership-status.md | 16 ++++++ .../examples/teams/update-membership.md | 15 +++++ .../examples/teams/update-name.md | 14 +++++ .../examples/teams/update-prefs.md | 14 +++++ .../account/create-anonymous-session.md | 6 ++ .../account/create-email-password-session.md | 10 ++++ .../examples/account/create-email-token.md | 11 ++++ .../examples/account/create-j-w-t.md | 6 ++ .../account/create-magic-u-r-l-token.md | 12 ++++ .../account/create-mfa-authenticator.md | 8 +++ .../examples/account/create-mfa-challenge.md | 9 +++ .../account/create-mfa-recovery-codes.md | 8 +++ .../examples/account/create-o-auth2session.md | 6 ++ .../examples/account/create-o-auth2token.md | 6 ++ .../examples/account/create-phone-token.md | 10 ++++ .../account/create-phone-verification.md | 8 +++ .../examples/account/create-push-target.md | 12 ++++ .../examples/account/create-recovery.md | 12 ++++ .../examples/account/create-session.md | 10 ++++ .../examples/account/create-verification.md | 11 ++++ .../client-rest/examples/account/create.md | 12 ++++ .../examples/account/delete-identity.md | 8 +++ .../account/delete-mfa-authenticator.md | 8 +++ .../examples/account/delete-push-target.md | 7 +++ .../examples/account/delete-session.md | 8 +++ .../examples/account/delete-sessions.md | 8 +++ .../account/get-mfa-recovery-codes.md | 8 +++ .../client-rest/examples/account/get-prefs.md | 8 +++ .../examples/account/get-session.md | 8 +++ .../1.6.x/client-rest/examples/account/get.md | 8 +++ .../examples/account/list-identities.md | 8 +++ .../client-rest/examples/account/list-logs.md | 8 +++ .../examples/account/list-mfa-factors.md | 8 +++ .../examples/account/list-sessions.md | 8 +++ .../examples/account/update-email.md | 12 ++++ .../examples/account/update-m-f-a.md | 11 ++++ .../account/update-magic-u-r-l-session.md | 10 ++++ .../account/update-mfa-authenticator.md | 11 ++++ .../examples/account/update-mfa-challenge.md | 12 ++++ .../account/update-mfa-recovery-codes.md | 8 +++ .../examples/account/update-name.md | 11 ++++ .../examples/account/update-password.md | 12 ++++ .../examples/account/update-phone-session.md | 10 ++++ .../account/update-phone-verification.md | 12 ++++ .../examples/account/update-phone.md | 12 ++++ .../examples/account/update-prefs.md | 11 ++++ .../examples/account/update-push-target.md | 10 ++++ .../examples/account/update-recovery.md | 13 +++++ .../examples/account/update-session.md | 8 +++ .../examples/account/update-status.md | 8 +++ .../examples/account/update-verification.md | 12 ++++ .../examples/avatars/get-browser.md | 8 +++ .../examples/avatars/get-credit-card.md | 8 +++ .../examples/avatars/get-favicon.md | 8 +++ .../client-rest/examples/avatars/get-flag.md | 8 +++ .../client-rest/examples/avatars/get-image.md | 8 +++ .../examples/avatars/get-initials.md | 8 +++ .../client-rest/examples/avatars/get-q-r.md | 8 +++ .../examples/databases/create-document.md | 13 +++++ .../examples/databases/delete-document.md | 8 +++ .../examples/databases/get-document.md | 8 +++ .../examples/databases/list-documents.md | 8 +++ .../examples/databases/update-document.md | 12 ++++ .../examples/functions/create-execution.md | 16 ++++++ .../examples/functions/get-execution.md | 8 +++ .../examples/functions/list-executions.md | 8 +++ .../client-rest/examples/graphql/mutation.md | 12 ++++ .../client-rest/examples/graphql/query.md | 12 ++++ .../1.6.x/client-rest/examples/locale/get.md | 8 +++ .../client-rest/examples/locale/list-codes.md | 8 +++ .../examples/locale/list-continents.md | 8 +++ .../examples/locale/list-countries-e-u.md | 8 +++ .../examples/locale/list-countries-phones.md | 8 +++ .../examples/locale/list-countries.md | 8 +++ .../examples/locale/list-currencies.md | 8 +++ .../examples/locale/list-languages.md | 8 +++ .../examples/messaging/create-subscriber.md | 12 ++++ .../examples/messaging/delete-subscriber.md | 8 +++ .../examples/storage/create-file.md | 26 +++++++++ .../examples/storage/delete-file.md | 8 +++ .../examples/storage/get-file-download.md | 8 +++ .../examples/storage/get-file-preview.md | 8 +++ .../examples/storage/get-file-view.md | 8 +++ .../client-rest/examples/storage/get-file.md | 8 +++ .../examples/storage/list-files.md | 8 +++ .../examples/storage/update-file.md | 12 ++++ .../examples/teams/create-membership.md | 16 ++++++ .../client-rest/examples/teams/create.md | 13 +++++ .../examples/teams/delete-membership.md | 8 +++ .../client-rest/examples/teams/delete.md | 8 +++ .../examples/teams/get-membership.md | 8 +++ .../client-rest/examples/teams/get-prefs.md | 8 +++ .../1.6.x/client-rest/examples/teams/get.md | 8 +++ .../examples/teams/list-memberships.md | 8 +++ .../1.6.x/client-rest/examples/teams/list.md | 8 +++ .../teams/update-membership-status.md | 12 ++++ .../examples/teams/update-membership.md | 11 ++++ .../client-rest/examples/teams/update-name.md | 11 ++++ .../examples/teams/update-prefs.md | 11 ++++ .../account/create-anonymous-session.md | 11 ++++ .../account/create-email-password-session.md | 14 +++++ .../examples/account/create-email-token.md | 15 +++++ .../examples/account/create-j-w-t.md | 11 ++++ .../account/create-magic-u-r-l-token.md | 16 ++++++ .../account/create-mfa-authenticator.md | 13 +++++ .../examples/account/create-mfa-challenge.md | 13 +++++ .../account/create-mfa-recovery-codes.md | 11 ++++ .../examples/account/create-o-auth2session.md | 15 +++++ .../examples/account/create-o-auth2token.md | 15 +++++ .../examples/account/create-phone-token.md | 14 +++++ .../account/create-phone-verification.md | 11 ++++ .../examples/account/create-push-target.md | 15 +++++ .../examples/account/create-recovery.md | 14 +++++ .../examples/account/create-session.md | 14 +++++ .../examples/account/create-verification.md | 13 +++++ .../client-web/examples/account/create.md | 16 ++++++ .../examples/account/delete-identity.md | 13 +++++ .../account/delete-mfa-authenticator.md | 13 +++++ .../examples/account/delete-push-target.md | 13 +++++ .../examples/account/delete-session.md | 13 +++++ .../examples/account/delete-sessions.md | 11 ++++ .../account/get-mfa-recovery-codes.md | 11 ++++ .../client-web/examples/account/get-prefs.md | 11 ++++ .../examples/account/get-session.md | 13 +++++ .../1.6.x/client-web/examples/account/get.md | 11 ++++ .../examples/account/list-identities.md | 13 +++++ .../client-web/examples/account/list-logs.md | 13 +++++ .../examples/account/list-mfa-factors.md | 11 ++++ .../examples/account/list-sessions.md | 11 ++++ .../examples/account/update-email.md | 14 +++++ .../examples/account/update-m-f-a.md | 13 +++++ .../account/update-magic-u-r-l-session.md | 14 +++++ .../account/update-mfa-authenticator.md | 14 +++++ .../examples/account/update-mfa-challenge.md | 14 +++++ .../account/update-mfa-recovery-codes.md | 11 ++++ .../examples/account/update-name.md | 13 +++++ .../examples/account/update-password.md | 14 +++++ .../examples/account/update-phone-session.md | 14 +++++ .../account/update-phone-verification.md | 14 +++++ .../examples/account/update-phone.md | 14 +++++ .../examples/account/update-prefs.md | 13 +++++ .../examples/account/update-push-target.md | 14 +++++ .../examples/account/update-recovery.md | 15 +++++ .../examples/account/update-session.md | 13 +++++ .../examples/account/update-status.md | 11 ++++ .../examples/account/update-verification.md | 14 +++++ .../examples/avatars/get-browser.md | 16 ++++++ .../examples/avatars/get-credit-card.md | 16 ++++++ .../examples/avatars/get-favicon.md | 13 +++++ .../client-web/examples/avatars/get-flag.md | 16 ++++++ .../client-web/examples/avatars/get-image.md | 15 +++++ .../examples/avatars/get-initials.md | 16 ++++++ .../client-web/examples/avatars/get-q-r.md | 16 ++++++ .../examples/databases/create-document.md | 17 ++++++ .../examples/databases/delete-document.md | 15 +++++ .../examples/databases/get-document.md | 16 ++++++ .../examples/databases/list-documents.md | 15 +++++ .../examples/databases/update-document.md | 17 ++++++ .../examples/functions/create-execution.md | 19 +++++++ .../examples/functions/get-execution.md | 14 +++++ .../examples/functions/list-executions.md | 15 +++++ .../client-web/examples/graphql/mutation.md | 13 +++++ .../client-web/examples/graphql/query.md | 13 +++++ .../1.6.x/client-web/examples/locale/get.md | 11 ++++ .../client-web/examples/locale/list-codes.md | 11 ++++ .../examples/locale/list-continents.md | 11 ++++ .../examples/locale/list-countries-e-u.md | 11 ++++ .../examples/locale/list-countries-phones.md | 11 ++++ .../examples/locale/list-countries.md | 11 ++++ .../examples/locale/list-currencies.md | 11 ++++ .../examples/locale/list-languages.md | 11 ++++ .../examples/messaging/create-subscriber.md | 15 +++++ .../examples/messaging/delete-subscriber.md | 14 +++++ .../examples/storage/create-file.md | 16 ++++++ .../examples/storage/delete-file.md | 14 +++++ .../examples/storage/get-file-download.md | 14 +++++ .../examples/storage/get-file-preview.md | 25 ++++++++ .../examples/storage/get-file-view.md | 14 +++++ .../client-web/examples/storage/get-file.md | 14 +++++ .../client-web/examples/storage/list-files.md | 15 +++++ .../examples/storage/update-file.md | 16 ++++++ .../examples/teams/create-membership.md | 19 +++++++ .../1.6.x/client-web/examples/teams/create.md | 15 +++++ .../examples/teams/delete-membership.md | 14 +++++ .../1.6.x/client-web/examples/teams/delete.md | 13 +++++ .../examples/teams/get-membership.md | 14 +++++ .../client-web/examples/teams/get-prefs.md | 13 +++++ .../1.6.x/client-web/examples/teams/get.md | 13 +++++ .../examples/teams/list-memberships.md | 15 +++++ .../1.6.x/client-web/examples/teams/list.md | 14 +++++ .../teams/update-membership-status.md | 16 ++++++ .../examples/teams/update-membership.md | 15 +++++ .../client-web/examples/teams/update-name.md | 14 +++++ .../client-web/examples/teams/update-prefs.md | 14 +++++ .../account/create-anonymous-session.md | 1 + .../account/create-email-password-session.md | 3 + .../examples/account/create-email-token.md | 4 ++ .../examples/account/create-j-w-t.md | 1 + .../account/create-magic-u-r-l-token.md | 5 ++ .../account/create-mfa-authenticator.md | 2 + .../examples/account/create-mfa-challenge.md | 2 + .../account/create-mfa-recovery-codes.md | 1 + .../examples/account/create-o-auth2session.md | 5 ++ .../examples/account/create-o-auth2token.md | 5 ++ .../examples/account/create-phone-token.md | 3 + .../account/create-phone-verification.md | 1 + .../examples/account/create-push-target.md | 4 ++ .../examples/account/create-recovery.md | 3 + .../examples/account/create-session.md | 3 + .../examples/account/create-verification.md | 2 + .../console-cli/examples/account/create.md | 5 ++ .../examples/account/delete-identity.md | 2 + .../account/delete-mfa-authenticator.md | 2 + .../examples/account/delete-push-target.md | 2 + .../examples/account/delete-session.md | 2 + .../examples/account/delete-sessions.md | 1 + .../console-cli/examples/account/delete.md | 1 + .../account/get-mfa-recovery-codes.md | 1 + .../console-cli/examples/account/get-prefs.md | 1 + .../examples/account/get-session.md | 2 + .../1.6.x/console-cli/examples/account/get.md | 1 + .../examples/account/list-identities.md | 2 + .../console-cli/examples/account/list-logs.md | 2 + .../examples/account/list-mfa-factors.md | 1 + .../examples/account/list-sessions.md | 1 + .../examples/account/update-email.md | 3 + .../examples/account/update-m-f-a.md | 2 + .../account/update-magic-u-r-l-session.md | 3 + .../account/update-mfa-authenticator.md | 3 + .../examples/account/update-mfa-challenge.md | 3 + .../account/update-mfa-recovery-codes.md | 1 + .../examples/account/update-name.md | 2 + .../examples/account/update-password.md | 3 + .../examples/account/update-phone-session.md | 3 + .../account/update-phone-verification.md | 3 + .../examples/account/update-phone.md | 3 + .../examples/account/update-prefs.md | 2 + .../examples/account/update-push-target.md | 3 + .../examples/account/update-recovery.md | 4 ++ .../examples/account/update-session.md | 2 + .../examples/account/update-status.md | 1 + .../examples/account/update-verification.md | 3 + .../console-cli/examples/assistant/chat.md | 2 + .../examples/avatars/get-browser.md | 5 ++ .../examples/avatars/get-credit-card.md | 5 ++ .../examples/avatars/get-favicon.md | 2 + .../console-cli/examples/avatars/get-flag.md | 5 ++ .../console-cli/examples/avatars/get-image.md | 4 ++ .../examples/avatars/get-initials.md | 5 ++ .../console-cli/examples/avatars/get-q-r.md | 5 ++ .../console-cli/examples/console/variables.md | 1 + .../databases/create-boolean-attribute.md | 7 +++ .../examples/databases/create-collection.md | 7 +++ .../databases/create-datetime-attribute.md | 7 +++ .../examples/databases/create-document.md | 6 ++ .../databases/create-email-attribute.md | 7 +++ .../databases/create-enum-attribute.md | 8 +++ .../databases/create-float-attribute.md | 9 +++ .../examples/databases/create-index.md | 7 +++ .../databases/create-integer-attribute.md | 9 +++ .../examples/databases/create-ip-attribute.md | 7 +++ .../create-relationship-attribute.md | 9 +++ .../databases/create-string-attribute.md | 9 +++ .../databases/create-url-attribute.md | 7 +++ .../console-cli/examples/databases/create.md | 4 ++ .../examples/databases/delete-attribute.md | 4 ++ .../examples/databases/delete-collection.md | 3 + .../examples/databases/delete-document.md | 4 ++ .../examples/databases/delete-index.md | 4 ++ .../console-cli/examples/databases/delete.md | 2 + .../examples/databases/get-attribute.md | 4 ++ .../databases/get-collection-usage.md | 4 ++ .../examples/databases/get-collection.md | 3 + .../examples/databases/get-database-usage.md | 3 + .../examples/databases/get-document.md | 5 ++ .../examples/databases/get-index.md | 4 ++ .../examples/databases/get-usage.md | 2 + .../console-cli/examples/databases/get.md | 2 + .../examples/databases/list-attributes.md | 4 ++ .../databases/list-collection-logs.md | 4 ++ .../examples/databases/list-collections.md | 4 ++ .../examples/databases/list-document-logs.md | 5 ++ .../examples/databases/list-documents.md | 4 ++ .../examples/databases/list-indexes.md | 4 ++ .../examples/databases/list-logs.md | 3 + .../console-cli/examples/databases/list.md | 3 + .../databases/update-boolean-attribute.md | 6 ++ .../examples/databases/update-collection.md | 7 +++ .../databases/update-datetime-attribute.md | 6 ++ .../examples/databases/update-document.md | 6 ++ .../databases/update-email-attribute.md | 6 ++ .../databases/update-enum-attribute.md | 7 +++ .../databases/update-float-attribute.md | 8 +++ .../databases/update-integer-attribute.md | 8 +++ .../examples/databases/update-ip-attribute.md | 6 ++ .../update-relationship-attribute.md | 5 ++ .../databases/update-string-attribute.md | 6 ++ .../databases/update-url-attribute.md | 6 ++ .../console-cli/examples/databases/update.md | 4 ++ .../examples/functions/create-build.md | 4 ++ .../examples/functions/create-deployment.md | 6 ++ .../examples/functions/create-execution.md | 8 +++ .../examples/functions/create-variable.md | 4 ++ .../console-cli/examples/functions/create.md | 22 +++++++ .../examples/functions/delete-deployment.md | 3 + .../examples/functions/delete-execution.md | 3 + .../examples/functions/delete-variable.md | 3 + .../console-cli/examples/functions/delete.md | 2 + .../examples/functions/download-deployment.md | 3 + .../examples/functions/get-deployment.md | 3 + .../examples/functions/get-execution.md | 3 + .../examples/functions/get-function-usage.md | 3 + .../examples/functions/get-usage.md | 2 + .../examples/functions/get-variable.md | 3 + .../console-cli/examples/functions/get.md | 2 + .../examples/functions/list-deployments.md | 4 ++ .../examples/functions/list-executions.md | 4 ++ .../examples/functions/list-runtimes.md | 1 + .../examples/functions/list-variables.md | 2 + .../console-cli/examples/functions/list.md | 3 + .../functions/update-deployment-build.md | 3 + .../examples/functions/update-deployment.md | 3 + .../examples/functions/update-variable.md | 5 ++ .../console-cli/examples/functions/update.md | 18 ++++++ .../console-cli/examples/graphql/mutation.md | 2 + .../console-cli/examples/graphql/query.md | 2 + .../examples/health/get-antivirus.md | 1 + .../console-cli/examples/health/get-cache.md | 1 + .../examples/health/get-certificate.md | 2 + .../console-cli/examples/health/get-d-b.md | 1 + .../examples/health/get-failed-jobs.md | 3 + .../examples/health/get-pub-sub.md | 1 + .../examples/health/get-queue-builds.md | 2 + .../examples/health/get-queue-certificates.md | 2 + .../examples/health/get-queue-databases.md | 3 + .../examples/health/get-queue-deletes.md | 2 + .../examples/health/get-queue-functions.md | 2 + .../examples/health/get-queue-logs.md | 2 + .../examples/health/get-queue-mails.md | 2 + .../examples/health/get-queue-messaging.md | 2 + .../examples/health/get-queue-migrations.md | 2 + .../examples/health/get-queue-usage-dump.md | 2 + .../examples/health/get-queue-usage.md | 2 + .../examples/health/get-queue-webhooks.md | 2 + .../console-cli/examples/health/get-queue.md | 1 + .../examples/health/get-storage-local.md | 1 + .../examples/health/get-storage.md | 1 + .../console-cli/examples/health/get-time.md | 1 + .../1.6.x/console-cli/examples/health/get.md | 1 + .../1.6.x/console-cli/examples/locale/get.md | 1 + .../console-cli/examples/locale/list-codes.md | 1 + .../examples/locale/list-continents.md | 1 + .../examples/locale/list-countries-e-u.md | 1 + .../examples/locale/list-countries-phones.md | 1 + .../examples/locale/list-countries.md | 1 + .../examples/locale/list-currencies.md | 1 + .../examples/locale/list-languages.md | 1 + .../messaging/create-apns-provider.md | 9 +++ .../examples/messaging/create-email.md | 13 +++++ .../examples/messaging/create-fcm-provider.md | 5 ++ .../messaging/create-mailgun-provider.md | 11 ++++ .../messaging/create-msg91provider.md | 7 +++ .../examples/messaging/create-push.md | 17 ++++++ .../messaging/create-sendgrid-provider.md | 9 +++ .../examples/messaging/create-sms.md | 8 +++ .../messaging/create-smtp-provider.md | 15 +++++ .../examples/messaging/create-subscriber.md | 4 ++ .../messaging/create-telesign-provider.md | 7 +++ .../messaging/create-textmagic-provider.md | 7 +++ .../examples/messaging/create-topic.md | 4 ++ .../messaging/create-twilio-provider.md | 7 +++ .../messaging/create-vonage-provider.md | 7 +++ .../examples/messaging/delete-provider.md | 2 + .../examples/messaging/delete-subscriber.md | 3 + .../examples/messaging/delete-topic.md | 2 + .../console-cli/examples/messaging/delete.md | 2 + .../examples/messaging/get-message.md | 2 + .../examples/messaging/get-provider.md | 2 + .../examples/messaging/get-subscriber.md | 3 + .../examples/messaging/get-topic.md | 2 + .../examples/messaging/list-message-logs.md | 3 + .../examples/messaging/list-messages.md | 3 + .../examples/messaging/list-provider-logs.md | 3 + .../examples/messaging/list-providers.md | 3 + .../messaging/list-subscriber-logs.md | 3 + .../examples/messaging/list-subscribers.md | 4 ++ .../examples/messaging/list-targets.md | 3 + .../examples/messaging/list-topic-logs.md | 3 + .../examples/messaging/list-topics.md | 3 + .../messaging/update-apns-provider.md | 9 +++ .../examples/messaging/update-email.md | 13 +++++ .../examples/messaging/update-fcm-provider.md | 5 ++ .../messaging/update-mailgun-provider.md | 11 ++++ .../messaging/update-msg91provider.md | 7 +++ .../examples/messaging/update-push.md | 17 ++++++ .../messaging/update-sendgrid-provider.md | 9 +++ .../examples/messaging/update-sms.md | 8 +++ .../messaging/update-smtp-provider.md | 15 +++++ .../messaging/update-telesign-provider.md | 7 +++ .../messaging/update-textmagic-provider.md | 7 +++ .../examples/messaging/update-topic.md | 4 ++ .../messaging/update-twilio-provider.md | 7 +++ .../messaging/update-vonage-provider.md | 7 +++ .../migrations/create-appwrite-migration.md | 5 ++ .../migrations/create-firebase-migration.md | 3 + .../create-firebase-o-auth-migration.md | 3 + .../migrations/create-n-host-migration.md | 9 +++ .../migrations/create-supabase-migration.md | 8 +++ .../migrations/delete-firebase-auth.md | 1 + .../console-cli/examples/migrations/delete.md | 2 + .../migrations/get-appwrite-report.md | 5 ++ .../migrations/get-firebase-report-o-auth.md | 3 + .../migrations/get-firebase-report.md | 3 + .../examples/migrations/get-n-host-report.md | 9 +++ .../migrations/get-supabase-report.md | 8 +++ .../console-cli/examples/migrations/get.md | 2 + .../migrations/list-firebase-projects.md | 1 + .../console-cli/examples/migrations/list.md | 3 + .../console-cli/examples/migrations/retry.md | 2 + .../examples/project/create-variable.md | 3 + .../examples/project/delete-variable.md | 2 + .../console-cli/examples/project/get-usage.md | 4 ++ .../examples/project/get-variable.md | 2 + .../examples/project/list-variables.md | 1 + .../examples/project/update-variable.md | 4 ++ .../examples/projects/create-j-w-t.md | 4 ++ .../examples/projects/create-key.md | 5 ++ .../examples/projects/create-platform.md | 7 +++ .../examples/projects/create-smtp-test.md | 11 ++++ .../examples/projects/create-webhook.md | 9 +++ .../console-cli/examples/projects/create.md | 14 +++++ .../projects/delete-email-template.md | 4 ++ .../examples/projects/delete-key.md | 3 + .../examples/projects/delete-platform.md | 3 + .../examples/projects/delete-sms-template.md | 4 ++ .../examples/projects/delete-webhook.md | 3 + .../console-cli/examples/projects/delete.md | 2 + .../examples/projects/get-email-template.md | 4 ++ .../console-cli/examples/projects/get-key.md | 3 + .../examples/projects/get-platform.md | 3 + .../examples/projects/get-sms-template.md | 4 ++ .../examples/projects/get-webhook.md | 3 + .../console-cli/examples/projects/get.md | 2 + .../examples/projects/list-keys.md | 2 + .../examples/projects/list-platforms.md | 2 + .../examples/projects/list-webhooks.md | 2 + .../console-cli/examples/projects/list.md | 3 + .../projects/update-api-status-all.md | 3 + .../examples/projects/update-api-status.md | 4 ++ .../examples/projects/update-auth-duration.md | 3 + .../examples/projects/update-auth-limit.md | 3 + .../update-auth-password-dictionary.md | 3 + .../projects/update-auth-password-history.md | 3 + .../projects/update-auth-sessions-limit.md | 3 + .../examples/projects/update-auth-status.md | 4 ++ .../projects/update-email-template.md | 9 +++ .../examples/projects/update-key.md | 6 ++ .../examples/projects/update-mock-numbers.md | 3 + .../examples/projects/update-o-auth2.md | 6 ++ .../projects/update-personal-data-check.md | 3 + .../examples/projects/update-platform.md | 7 +++ .../projects/update-service-status-all.md | 3 + .../projects/update-service-status.md | 4 ++ .../projects/update-session-alerts.md | 3 + .../examples/projects/update-sms-template.md | 5 ++ .../examples/projects/update-smtp.md | 11 ++++ .../examples/projects/update-team.md | 3 + .../projects/update-webhook-signature.md | 3 + .../examples/projects/update-webhook.md | 10 ++++ .../console-cli/examples/projects/update.md | 12 ++++ .../console-cli/examples/proxy/create-rule.md | 4 ++ .../console-cli/examples/proxy/delete-rule.md | 2 + .../console-cli/examples/proxy/get-rule.md | 2 + .../console-cli/examples/proxy/list-rules.md | 3 + .../proxy/update-rule-verification.md | 2 + .../examples/storage/create-bucket.md | 11 ++++ .../examples/storage/create-file.md | 5 ++ .../examples/storage/delete-bucket.md | 2 + .../examples/storage/delete-file.md | 3 + .../examples/storage/get-bucket-usage.md | 3 + .../examples/storage/get-bucket.md | 2 + .../examples/storage/get-file-download.md | 3 + .../examples/storage/get-file-preview.md | 14 +++++ .../examples/storage/get-file-view.md | 3 + .../console-cli/examples/storage/get-file.md | 3 + .../console-cli/examples/storage/get-usage.md | 2 + .../examples/storage/list-buckets.md | 3 + .../examples/storage/list-files.md | 4 ++ .../examples/storage/update-bucket.md | 11 ++++ .../examples/storage/update-file.md | 5 ++ .../examples/teams/create-membership.md | 8 +++ .../console-cli/examples/teams/create.md | 4 ++ .../examples/teams/delete-membership.md | 3 + .../console-cli/examples/teams/delete.md | 2 + .../examples/teams/get-membership.md | 3 + .../console-cli/examples/teams/get-prefs.md | 2 + .../1.6.x/console-cli/examples/teams/get.md | 2 + .../console-cli/examples/teams/list-logs.md | 3 + .../examples/teams/list-memberships.md | 4 ++ .../1.6.x/console-cli/examples/teams/list.md | 3 + .../teams/update-membership-status.md | 5 ++ .../examples/teams/update-membership.md | 4 ++ .../console-cli/examples/teams/update-name.md | 3 + .../examples/teams/update-prefs.md | 3 + .../examples/users/create-argon2user.md | 5 ++ .../examples/users/create-bcrypt-user.md | 5 ++ .../examples/users/create-j-w-t.md | 4 ++ .../examples/users/create-m-d5user.md | 5 ++ .../users/create-mfa-recovery-codes.md | 2 + .../examples/users/create-p-h-pass-user.md | 5 ++ .../examples/users/create-s-h-a-user.md | 6 ++ .../users/create-scrypt-modified-user.md | 8 +++ .../examples/users/create-scrypt-user.md | 10 ++++ .../examples/users/create-session.md | 2 + .../examples/users/create-target.md | 7 +++ .../examples/users/create-token.md | 4 ++ .../console-cli/examples/users/create.md | 6 ++ .../examples/users/delete-identity.md | 2 + .../users/delete-mfa-authenticator.md | 3 + .../examples/users/delete-session.md | 3 + .../examples/users/delete-sessions.md | 2 + .../examples/users/delete-target.md | 3 + .../console-cli/examples/users/delete.md | 2 + .../examples/users/get-mfa-recovery-codes.md | 2 + .../console-cli/examples/users/get-prefs.md | 2 + .../console-cli/examples/users/get-target.md | 3 + .../console-cli/examples/users/get-usage.md | 2 + .../1.6.x/console-cli/examples/users/get.md | 2 + .../examples/users/list-identities.md | 3 + .../console-cli/examples/users/list-logs.md | 3 + .../examples/users/list-memberships.md | 2 + .../examples/users/list-mfa-factors.md | 2 + .../examples/users/list-sessions.md | 2 + .../examples/users/list-targets.md | 3 + .../1.6.x/console-cli/examples/users/list.md | 3 + .../users/update-email-verification.md | 3 + .../examples/users/update-email.md | 3 + .../examples/users/update-labels.md | 3 + .../users/update-mfa-recovery-codes.md | 2 + .../console-cli/examples/users/update-mfa.md | 3 + .../console-cli/examples/users/update-name.md | 3 + .../examples/users/update-password.md | 3 + .../users/update-phone-verification.md | 3 + .../examples/users/update-phone.md | 3 + .../examples/users/update-prefs.md | 3 + .../examples/users/update-status.md | 3 + .../examples/users/update-target.md | 6 ++ .../vcs/create-repository-detection.md | 4 ++ .../examples/vcs/create-repository.md | 4 ++ .../examples/vcs/delete-installation.md | 2 + .../examples/vcs/get-installation.md | 2 + .../examples/vcs/get-repository-contents.md | 4 ++ .../examples/vcs/get-repository.md | 3 + .../examples/vcs/list-installations.md | 3 + .../examples/vcs/list-repositories.md | 3 + .../examples/vcs/list-repository-branches.md | 3 + .../vcs/update-external-deployments.md | 4 ++ .../account/create-anonymous-session.md | 11 ++++ .../account/create-email-password-session.md | 14 +++++ .../examples/account/create-email-token.md | 15 +++++ .../examples/account/create-j-w-t.md | 11 ++++ .../account/create-magic-u-r-l-token.md | 16 ++++++ .../account/create-mfa-authenticator.md | 13 +++++ .../examples/account/create-mfa-challenge.md | 13 +++++ .../account/create-mfa-recovery-codes.md | 11 ++++ .../examples/account/create-o-auth2session.md | 15 +++++ .../examples/account/create-o-auth2token.md | 15 +++++ .../examples/account/create-phone-token.md | 14 +++++ .../account/create-phone-verification.md | 11 ++++ .../examples/account/create-push-target.md | 15 +++++ .../examples/account/create-recovery.md | 14 +++++ .../examples/account/create-session.md | 14 +++++ .../examples/account/create-verification.md | 13 +++++ .../console-web/examples/account/create.md | 16 ++++++ .../examples/account/delete-identity.md | 13 +++++ .../account/delete-mfa-authenticator.md | 13 +++++ .../examples/account/delete-push-target.md | 13 +++++ .../examples/account/delete-session.md | 13 +++++ .../examples/account/delete-sessions.md | 11 ++++ .../console-web/examples/account/delete.md | 11 ++++ .../account/get-mfa-recovery-codes.md | 11 ++++ .../console-web/examples/account/get-prefs.md | 11 ++++ .../examples/account/get-session.md | 13 +++++ .../1.6.x/console-web/examples/account/get.md | 11 ++++ .../examples/account/list-identities.md | 13 +++++ .../console-web/examples/account/list-logs.md | 13 +++++ .../examples/account/list-mfa-factors.md | 11 ++++ .../examples/account/list-sessions.md | 11 ++++ .../examples/account/update-email.md | 14 +++++ .../examples/account/update-m-f-a.md | 13 +++++ .../account/update-magic-u-r-l-session.md | 14 +++++ .../account/update-mfa-authenticator.md | 14 +++++ .../examples/account/update-mfa-challenge.md | 14 +++++ .../account/update-mfa-recovery-codes.md | 11 ++++ .../examples/account/update-name.md | 13 +++++ .../examples/account/update-password.md | 14 +++++ .../examples/account/update-phone-session.md | 14 +++++ .../account/update-phone-verification.md | 14 +++++ .../examples/account/update-phone.md | 14 +++++ .../examples/account/update-prefs.md | 13 +++++ .../examples/account/update-push-target.md | 14 +++++ .../examples/account/update-recovery.md | 15 +++++ .../examples/account/update-session.md | 13 +++++ .../examples/account/update-status.md | 11 ++++ .../examples/account/update-verification.md | 14 +++++ .../console-web/examples/assistant/chat.md | 13 +++++ .../examples/avatars/get-browser.md | 16 ++++++ .../examples/avatars/get-credit-card.md | 16 ++++++ .../examples/avatars/get-favicon.md | 13 +++++ .../console-web/examples/avatars/get-flag.md | 16 ++++++ .../console-web/examples/avatars/get-image.md | 15 +++++ .../examples/avatars/get-initials.md | 16 ++++++ .../console-web/examples/avatars/get-q-r.md | 16 ++++++ .../console-web/examples/console/variables.md | 11 ++++ .../databases/create-boolean-attribute.md | 18 ++++++ .../examples/databases/create-collection.md | 18 ++++++ .../databases/create-datetime-attribute.md | 18 ++++++ .../examples/databases/create-document.md | 17 ++++++ .../databases/create-email-attribute.md | 18 ++++++ .../databases/create-enum-attribute.md | 19 +++++++ .../databases/create-float-attribute.md | 20 +++++++ .../examples/databases/create-index.md | 18 ++++++ .../databases/create-integer-attribute.md | 20 +++++++ .../examples/databases/create-ip-attribute.md | 18 ++++++ .../create-relationship-attribute.md | 20 +++++++ .../databases/create-string-attribute.md | 20 +++++++ .../databases/create-url-attribute.md | 18 ++++++ .../console-web/examples/databases/create.md | 15 +++++ .../examples/databases/delete-attribute.md | 15 +++++ .../examples/databases/delete-collection.md | 14 +++++ .../examples/databases/delete-document.md | 15 +++++ .../examples/databases/delete-index.md | 15 +++++ .../console-web/examples/databases/delete.md | 13 +++++ .../examples/databases/get-attribute.md | 15 +++++ .../databases/get-collection-usage.md | 15 +++++ .../examples/databases/get-collection.md | 14 +++++ .../examples/databases/get-database-usage.md | 14 +++++ .../examples/databases/get-document.md | 16 ++++++ .../examples/databases/get-index.md | 15 +++++ .../examples/databases/get-usage.md | 13 +++++ .../console-web/examples/databases/get.md | 13 +++++ .../examples/databases/list-attributes.md | 15 +++++ .../databases/list-collection-logs.md | 15 +++++ .../examples/databases/list-collections.md | 15 +++++ .../examples/databases/list-document-logs.md | 16 ++++++ .../examples/databases/list-documents.md | 15 +++++ .../examples/databases/list-indexes.md | 15 +++++ .../examples/databases/list-logs.md | 14 +++++ .../console-web/examples/databases/list.md | 14 +++++ .../databases/update-boolean-attribute.md | 17 ++++++ .../examples/databases/update-collection.md | 18 ++++++ .../databases/update-datetime-attribute.md | 17 ++++++ .../examples/databases/update-document.md | 17 ++++++ .../databases/update-email-attribute.md | 17 ++++++ .../databases/update-enum-attribute.md | 18 ++++++ .../databases/update-float-attribute.md | 19 +++++++ .../databases/update-integer-attribute.md | 19 +++++++ .../examples/databases/update-ip-attribute.md | 17 ++++++ .../update-relationship-attribute.md | 16 ++++++ .../databases/update-string-attribute.md | 17 ++++++ .../databases/update-url-attribute.md | 17 ++++++ .../console-web/examples/databases/update.md | 15 +++++ .../examples/functions/create-build.md | 15 +++++ .../examples/functions/create-deployment.md | 17 ++++++ .../examples/functions/create-execution.md | 19 +++++++ .../examples/functions/create-variable.md | 15 +++++ .../console-web/examples/functions/create.md | 33 +++++++++++ .../examples/functions/delete-deployment.md | 14 +++++ .../examples/functions/delete-execution.md | 14 +++++ .../examples/functions/delete-variable.md | 14 +++++ .../console-web/examples/functions/delete.md | 13 +++++ .../examples/functions/download-deployment.md | 14 +++++ .../examples/functions/get-deployment.md | 14 +++++ .../examples/functions/get-execution.md | 14 +++++ .../examples/functions/get-function-usage.md | 14 +++++ .../examples/functions/get-usage.md | 13 +++++ .../examples/functions/get-variable.md | 14 +++++ .../console-web/examples/functions/get.md | 13 +++++ .../examples/functions/list-deployments.md | 15 +++++ .../examples/functions/list-executions.md | 15 +++++ .../examples/functions/list-runtimes.md | 11 ++++ .../examples/functions/list-variables.md | 13 +++++ .../console-web/examples/functions/list.md | 14 +++++ .../functions/update-deployment-build.md | 14 +++++ .../examples/functions/update-deployment.md | 14 +++++ .../examples/functions/update-variable.md | 16 ++++++ .../console-web/examples/functions/update.md | 29 ++++++++++ .../console-web/examples/graphql/mutation.md | 13 +++++ .../console-web/examples/graphql/query.md | 13 +++++ .../examples/health/get-antivirus.md | 11 ++++ .../console-web/examples/health/get-cache.md | 11 ++++ .../examples/health/get-certificate.md | 13 +++++ .../console-web/examples/health/get-d-b.md | 11 ++++ .../examples/health/get-failed-jobs.md | 14 +++++ .../examples/health/get-pub-sub.md | 11 ++++ .../examples/health/get-queue-builds.md | 13 +++++ .../examples/health/get-queue-certificates.md | 13 +++++ .../examples/health/get-queue-databases.md | 14 +++++ .../examples/health/get-queue-deletes.md | 13 +++++ .../examples/health/get-queue-functions.md | 13 +++++ .../examples/health/get-queue-logs.md | 13 +++++ .../examples/health/get-queue-mails.md | 13 +++++ .../examples/health/get-queue-messaging.md | 13 +++++ .../examples/health/get-queue-migrations.md | 13 +++++ .../examples/health/get-queue-usage-dump.md | 13 +++++ .../examples/health/get-queue-usage.md | 13 +++++ .../examples/health/get-queue-webhooks.md | 13 +++++ .../console-web/examples/health/get-queue.md | 11 ++++ .../examples/health/get-storage-local.md | 11 ++++ .../examples/health/get-storage.md | 11 ++++ .../console-web/examples/health/get-time.md | 11 ++++ .../1.6.x/console-web/examples/health/get.md | 11 ++++ .../1.6.x/console-web/examples/locale/get.md | 11 ++++ .../console-web/examples/locale/list-codes.md | 11 ++++ .../examples/locale/list-continents.md | 11 ++++ .../examples/locale/list-countries-e-u.md | 11 ++++ .../examples/locale/list-countries-phones.md | 11 ++++ .../examples/locale/list-countries.md | 11 ++++ .../examples/locale/list-currencies.md | 11 ++++ .../examples/locale/list-languages.md | 11 ++++ .../messaging/create-apns-provider.md | 20 +++++++ .../examples/messaging/create-email.md | 24 ++++++++ .../examples/messaging/create-fcm-provider.md | 16 ++++++ .../messaging/create-mailgun-provider.md | 22 +++++++ .../messaging/create-msg91provider.md | 18 ++++++ .../examples/messaging/create-push.md | 28 +++++++++ .../messaging/create-sendgrid-provider.md | 20 +++++++ .../examples/messaging/create-sms.md | 19 +++++++ .../messaging/create-smtp-provider.md | 26 +++++++++ .../examples/messaging/create-subscriber.md | 15 +++++ .../messaging/create-telesign-provider.md | 18 ++++++ .../messaging/create-textmagic-provider.md | 18 ++++++ .../examples/messaging/create-topic.md | 15 +++++ .../messaging/create-twilio-provider.md | 18 ++++++ .../messaging/create-vonage-provider.md | 18 ++++++ .../examples/messaging/delete-provider.md | 13 +++++ .../examples/messaging/delete-subscriber.md | 14 +++++ .../examples/messaging/delete-topic.md | 13 +++++ .../console-web/examples/messaging/delete.md | 13 +++++ .../examples/messaging/get-message.md | 13 +++++ .../examples/messaging/get-provider.md | 13 +++++ .../examples/messaging/get-subscriber.md | 14 +++++ .../examples/messaging/get-topic.md | 13 +++++ .../examples/messaging/list-message-logs.md | 14 +++++ .../examples/messaging/list-messages.md | 14 +++++ .../examples/messaging/list-provider-logs.md | 14 +++++ .../examples/messaging/list-providers.md | 14 +++++ .../messaging/list-subscriber-logs.md | 14 +++++ .../examples/messaging/list-subscribers.md | 15 +++++ .../examples/messaging/list-targets.md | 14 +++++ .../examples/messaging/list-topic-logs.md | 14 +++++ .../examples/messaging/list-topics.md | 14 +++++ .../messaging/update-apns-provider.md | 20 +++++++ .../examples/messaging/update-email.md | 24 ++++++++ .../examples/messaging/update-fcm-provider.md | 16 ++++++ .../messaging/update-mailgun-provider.md | 22 +++++++ .../messaging/update-msg91provider.md | 18 ++++++ .../examples/messaging/update-push.md | 28 +++++++++ .../messaging/update-sendgrid-provider.md | 20 +++++++ .../examples/messaging/update-sms.md | 19 +++++++ .../messaging/update-smtp-provider.md | 26 +++++++++ .../messaging/update-telesign-provider.md | 18 ++++++ .../messaging/update-textmagic-provider.md | 18 ++++++ .../examples/messaging/update-topic.md | 15 +++++ .../messaging/update-twilio-provider.md | 18 ++++++ .../messaging/update-vonage-provider.md | 18 ++++++ .../migrations/create-appwrite-migration.md | 16 ++++++ .../migrations/create-firebase-migration.md | 14 +++++ .../create-firebase-o-auth-migration.md | 14 +++++ .../migrations/create-n-host-migration.md | 20 +++++++ .../migrations/create-supabase-migration.md | 19 +++++++ .../migrations/delete-firebase-auth.md | 11 ++++ .../console-web/examples/migrations/delete.md | 13 +++++ .../migrations/get-appwrite-report.md | 16 ++++++ .../migrations/get-firebase-report-o-auth.md | 14 +++++ .../migrations/get-firebase-report.md | 14 +++++ .../examples/migrations/get-n-host-report.md | 20 +++++++ .../migrations/get-supabase-report.md | 19 +++++++ .../console-web/examples/migrations/get.md | 13 +++++ .../migrations/list-firebase-projects.md | 11 ++++ .../console-web/examples/migrations/list.md | 14 +++++ .../console-web/examples/migrations/retry.md | 13 +++++ .../examples/project/create-variable.md | 14 +++++ .../examples/project/delete-variable.md | 13 +++++ .../console-web/examples/project/get-usage.md | 15 +++++ .../examples/project/get-variable.md | 13 +++++ .../examples/project/list-variables.md | 11 ++++ .../examples/project/update-variable.md | 15 +++++ .../examples/projects/create-j-w-t.md | 15 +++++ .../examples/projects/create-key.md | 16 ++++++ .../examples/projects/create-platform.md | 18 ++++++ .../examples/projects/create-smtp-test.md | 22 +++++++ .../examples/projects/create-webhook.md | 20 +++++++ .../console-web/examples/projects/create.md | 25 ++++++++ .../projects/delete-email-template.md | 15 +++++ .../examples/projects/delete-key.md | 14 +++++ .../examples/projects/delete-platform.md | 14 +++++ .../examples/projects/delete-sms-template.md | 15 +++++ .../examples/projects/delete-webhook.md | 14 +++++ .../console-web/examples/projects/delete.md | 13 +++++ .../examples/projects/get-email-template.md | 15 +++++ .../console-web/examples/projects/get-key.md | 14 +++++ .../examples/projects/get-platform.md | 14 +++++ .../examples/projects/get-sms-template.md | 15 +++++ .../examples/projects/get-webhook.md | 14 +++++ .../console-web/examples/projects/get.md | 13 +++++ .../examples/projects/list-keys.md | 13 +++++ .../examples/projects/list-platforms.md | 13 +++++ .../examples/projects/list-webhooks.md | 13 +++++ .../console-web/examples/projects/list.md | 14 +++++ .../projects/update-api-status-all.md | 14 +++++ .../examples/projects/update-api-status.md | 15 +++++ .../examples/projects/update-auth-duration.md | 14 +++++ .../examples/projects/update-auth-limit.md | 14 +++++ .../update-auth-password-dictionary.md | 14 +++++ .../projects/update-auth-password-history.md | 14 +++++ .../projects/update-auth-sessions-limit.md | 14 +++++ .../examples/projects/update-auth-status.md | 15 +++++ .../projects/update-email-template.md | 20 +++++++ .../examples/projects/update-key.md | 17 ++++++ .../examples/projects/update-mock-numbers.md | 14 +++++ .../examples/projects/update-o-auth2.md | 17 ++++++ .../projects/update-personal-data-check.md | 14 +++++ .../examples/projects/update-platform.md | 18 ++++++ .../projects/update-service-status-all.md | 14 +++++ .../projects/update-service-status.md | 15 +++++ .../projects/update-session-alerts.md | 14 +++++ .../examples/projects/update-sms-template.md | 16 ++++++ .../examples/projects/update-smtp.md | 22 +++++++ .../examples/projects/update-team.md | 14 +++++ .../projects/update-webhook-signature.md | 14 +++++ .../examples/projects/update-webhook.md | 21 +++++++ .../console-web/examples/projects/update.md | 23 ++++++++ .../console-web/examples/proxy/create-rule.md | 15 +++++ .../console-web/examples/proxy/delete-rule.md | 13 +++++ .../console-web/examples/proxy/get-rule.md | 13 +++++ .../console-web/examples/proxy/list-rules.md | 14 +++++ .../proxy/update-rule-verification.md | 13 +++++ .../examples/storage/create-bucket.md | 22 +++++++ .../examples/storage/create-file.md | 16 ++++++ .../examples/storage/delete-bucket.md | 13 +++++ .../examples/storage/delete-file.md | 14 +++++ .../examples/storage/get-bucket-usage.md | 14 +++++ .../examples/storage/get-bucket.md | 13 +++++ .../examples/storage/get-file-download.md | 14 +++++ .../examples/storage/get-file-preview.md | 25 ++++++++ .../examples/storage/get-file-view.md | 14 +++++ .../console-web/examples/storage/get-file.md | 14 +++++ .../console-web/examples/storage/get-usage.md | 13 +++++ .../examples/storage/list-buckets.md | 14 +++++ .../examples/storage/list-files.md | 15 +++++ .../examples/storage/update-bucket.md | 22 +++++++ .../examples/storage/update-file.md | 16 ++++++ .../examples/teams/create-membership.md | 19 +++++++ .../console-web/examples/teams/create.md | 15 +++++ .../examples/teams/delete-membership.md | 14 +++++ .../console-web/examples/teams/delete.md | 13 +++++ .../examples/teams/get-membership.md | 14 +++++ .../console-web/examples/teams/get-prefs.md | 13 +++++ .../1.6.x/console-web/examples/teams/get.md | 13 +++++ .../console-web/examples/teams/list-logs.md | 14 +++++ .../examples/teams/list-memberships.md | 15 +++++ .../1.6.x/console-web/examples/teams/list.md | 14 +++++ .../teams/update-membership-status.md | 16 ++++++ .../examples/teams/update-membership.md | 15 +++++ .../console-web/examples/teams/update-name.md | 14 +++++ .../examples/teams/update-prefs.md | 14 +++++ .../examples/users/create-argon2user.md | 16 ++++++ .../examples/users/create-bcrypt-user.md | 16 ++++++ .../examples/users/create-j-w-t.md | 15 +++++ .../examples/users/create-m-d5user.md | 16 ++++++ .../users/create-mfa-recovery-codes.md | 13 +++++ .../examples/users/create-p-h-pass-user.md | 16 ++++++ .../examples/users/create-s-h-a-user.md | 17 ++++++ .../users/create-scrypt-modified-user.md | 19 +++++++ .../examples/users/create-scrypt-user.md | 21 +++++++ .../examples/users/create-session.md | 13 +++++ .../examples/users/create-target.md | 18 ++++++ .../examples/users/create-token.md | 15 +++++ .../console-web/examples/users/create.md | 17 ++++++ .../examples/users/delete-identity.md | 13 +++++ .../users/delete-mfa-authenticator.md | 14 +++++ .../examples/users/delete-session.md | 14 +++++ .../examples/users/delete-sessions.md | 13 +++++ .../examples/users/delete-target.md | 14 +++++ .../console-web/examples/users/delete.md | 13 +++++ .../examples/users/get-mfa-recovery-codes.md | 13 +++++ .../console-web/examples/users/get-prefs.md | 13 +++++ .../console-web/examples/users/get-target.md | 14 +++++ .../console-web/examples/users/get-usage.md | 13 +++++ .../1.6.x/console-web/examples/users/get.md | 13 +++++ .../examples/users/list-identities.md | 14 +++++ .../console-web/examples/users/list-logs.md | 14 +++++ .../examples/users/list-memberships.md | 13 +++++ .../examples/users/list-mfa-factors.md | 13 +++++ .../examples/users/list-sessions.md | 13 +++++ .../examples/users/list-targets.md | 14 +++++ .../1.6.x/console-web/examples/users/list.md | 14 +++++ .../users/update-email-verification.md | 14 +++++ .../examples/users/update-email.md | 14 +++++ .../examples/users/update-labels.md | 14 +++++ .../users/update-mfa-recovery-codes.md | 13 +++++ .../console-web/examples/users/update-mfa.md | 14 +++++ .../console-web/examples/users/update-name.md | 14 +++++ .../examples/users/update-password.md | 14 +++++ .../users/update-phone-verification.md | 14 +++++ .../examples/users/update-phone.md | 14 +++++ .../examples/users/update-prefs.md | 14 +++++ .../examples/users/update-status.md | 14 +++++ .../examples/users/update-target.md | 17 ++++++ .../vcs/create-repository-detection.md | 15 +++++ .../examples/vcs/create-repository.md | 15 +++++ .../examples/vcs/delete-installation.md | 13 +++++ .../examples/vcs/get-installation.md | 13 +++++ .../examples/vcs/get-repository-contents.md | 15 +++++ .../examples/vcs/get-repository.md | 14 +++++ .../examples/vcs/list-installations.md | 14 +++++ .../examples/vcs/list-repositories.md | 14 +++++ .../examples/vcs/list-repository-branches.md | 14 +++++ .../vcs/update-external-deployments.md | 15 +++++ .../account/create-anonymous-session.md | 9 +++ .../account/create-email-password-session.md | 12 ++++ .../examples/account/create-email-token.md | 13 +++++ .../examples/account/create-j-w-t.md | 9 +++ .../account/create-magic-u-r-l-token.md | 14 +++++ .../account/create-mfa-authenticator.md | 12 ++++ .../examples/account/create-mfa-challenge.md | 11 ++++ .../account/create-mfa-recovery-codes.md | 10 ++++ .../examples/account/create-o-auth2token.md | 14 +++++ .../examples/account/create-phone-token.md | 12 ++++ .../account/create-phone-verification.md | 10 ++++ .../examples/account/create-recovery.md | 13 +++++ .../examples/account/create-session.md | 12 ++++ .../examples/account/create-verification.md | 12 ++++ .../server-dart/examples/account/create.md | 14 +++++ .../examples/account/delete-identity.md | 12 ++++ .../account/delete-mfa-authenticator.md | 12 ++++ .../examples/account/delete-session.md | 12 ++++ .../examples/account/delete-sessions.md | 10 ++++ .../account/get-mfa-recovery-codes.md | 10 ++++ .../server-dart/examples/account/get-prefs.md | 10 ++++ .../examples/account/get-session.md | 12 ++++ .../1.6.x/server-dart/examples/account/get.md | 10 ++++ .../examples/account/list-identities.md | 12 ++++ .../server-dart/examples/account/list-logs.md | 12 ++++ .../examples/account/list-mfa-factors.md | 10 ++++ .../examples/account/list-sessions.md | 10 ++++ .../examples/account/update-email.md | 13 +++++ .../examples/account/update-m-f-a.md | 12 ++++ .../account/update-magic-u-r-l-session.md | 12 ++++ .../account/update-mfa-authenticator.md | 13 +++++ .../examples/account/update-mfa-challenge.md | 13 +++++ .../account/update-mfa-recovery-codes.md | 10 ++++ .../examples/account/update-name.md | 12 ++++ .../examples/account/update-password.md | 13 +++++ .../examples/account/update-phone-session.md | 12 ++++ .../account/update-phone-verification.md | 13 +++++ .../examples/account/update-phone.md | 13 +++++ .../examples/account/update-prefs.md | 12 ++++ .../examples/account/update-recovery.md | 14 +++++ .../examples/account/update-session.md | 12 ++++ .../examples/account/update-status.md | 10 ++++ .../examples/account/update-verification.md | 13 +++++ .../examples/avatars/get-browser.md | 15 +++++ .../examples/avatars/get-credit-card.md | 15 +++++ .../examples/avatars/get-favicon.md | 12 ++++ .../server-dart/examples/avatars/get-flag.md | 15 +++++ .../server-dart/examples/avatars/get-image.md | 14 +++++ .../examples/avatars/get-initials.md | 15 +++++ .../server-dart/examples/avatars/get-q-r.md | 15 +++++ .../databases/create-boolean-attribute.md | 17 ++++++ .../examples/databases/create-collection.md | 17 ++++++ .../databases/create-datetime-attribute.md | 17 ++++++ .../examples/databases/create-document.md | 16 ++++++ .../databases/create-email-attribute.md | 17 ++++++ .../databases/create-enum-attribute.md | 18 ++++++ .../databases/create-float-attribute.md | 19 +++++++ .../examples/databases/create-index.md | 17 ++++++ .../databases/create-integer-attribute.md | 19 +++++++ .../examples/databases/create-ip-attribute.md | 17 ++++++ .../create-relationship-attribute.md | 19 +++++++ .../databases/create-string-attribute.md | 19 +++++++ .../databases/create-url-attribute.md | 17 ++++++ .../server-dart/examples/databases/create.md | 14 +++++ .../examples/databases/delete-attribute.md | 14 +++++ .../examples/databases/delete-collection.md | 13 +++++ .../examples/databases/delete-document.md | 14 +++++ .../examples/databases/delete-index.md | 14 +++++ .../server-dart/examples/databases/delete.md | 12 ++++ .../examples/databases/get-attribute.md | 14 +++++ .../examples/databases/get-collection.md | 13 +++++ .../examples/databases/get-document.md | 15 +++++ .../examples/databases/get-index.md | 14 +++++ .../server-dart/examples/databases/get.md | 12 ++++ .../examples/databases/list-attributes.md | 14 +++++ .../examples/databases/list-collections.md | 14 +++++ .../examples/databases/list-documents.md | 14 +++++ .../examples/databases/list-indexes.md | 14 +++++ .../server-dart/examples/databases/list.md | 13 +++++ .../databases/update-boolean-attribute.md | 16 ++++++ .../examples/databases/update-collection.md | 17 ++++++ .../databases/update-datetime-attribute.md | 16 ++++++ .../examples/databases/update-document.md | 16 ++++++ .../databases/update-email-attribute.md | 16 ++++++ .../databases/update-enum-attribute.md | 17 ++++++ .../databases/update-float-attribute.md | 18 ++++++ .../databases/update-integer-attribute.md | 18 ++++++ .../examples/databases/update-ip-attribute.md | 16 ++++++ .../update-relationship-attribute.md | 15 +++++ .../databases/update-string-attribute.md | 16 ++++++ .../databases/update-url-attribute.md | 16 ++++++ .../server-dart/examples/databases/update.md | 14 +++++ .../examples/functions/create-build.md | 14 +++++ .../examples/functions/create-deployment.md | 16 ++++++ .../examples/functions/create-execution.md | 18 ++++++ .../examples/functions/create-variable.md | 14 +++++ .../server-dart/examples/functions/create.md | 32 +++++++++++ .../examples/functions/delete-deployment.md | 13 +++++ .../examples/functions/delete-execution.md | 13 +++++ .../examples/functions/delete-variable.md | 13 +++++ .../server-dart/examples/functions/delete.md | 12 ++++ .../examples/functions/download-deployment.md | 13 +++++ .../examples/functions/get-deployment.md | 13 +++++ .../examples/functions/get-execution.md | 13 +++++ .../examples/functions/get-variable.md | 13 +++++ .../server-dart/examples/functions/get.md | 12 ++++ .../examples/functions/list-deployments.md | 14 +++++ .../examples/functions/list-executions.md | 14 +++++ .../examples/functions/list-runtimes.md | 10 ++++ .../examples/functions/list-variables.md | 12 ++++ .../server-dart/examples/functions/list.md | 13 +++++ .../functions/update-deployment-build.md | 13 +++++ .../examples/functions/update-deployment.md | 13 +++++ .../examples/functions/update-variable.md | 15 +++++ .../server-dart/examples/functions/update.md | 28 +++++++++ .../server-dart/examples/graphql/mutation.md | 12 ++++ .../server-dart/examples/graphql/query.md | 12 ++++ .../examples/health/get-antivirus.md | 10 ++++ .../server-dart/examples/health/get-cache.md | 10 ++++ .../examples/health/get-certificate.md | 12 ++++ .../server-dart/examples/health/get-d-b.md | 10 ++++ .../examples/health/get-failed-jobs.md | 13 +++++ .../examples/health/get-pub-sub.md | 10 ++++ .../examples/health/get-queue-builds.md | 12 ++++ .../examples/health/get-queue-certificates.md | 12 ++++ .../examples/health/get-queue-databases.md | 13 +++++ .../examples/health/get-queue-deletes.md | 12 ++++ .../examples/health/get-queue-functions.md | 12 ++++ .../examples/health/get-queue-logs.md | 12 ++++ .../examples/health/get-queue-mails.md | 12 ++++ .../examples/health/get-queue-messaging.md | 12 ++++ .../examples/health/get-queue-migrations.md | 12 ++++ .../examples/health/get-queue-usage-dump.md | 12 ++++ .../examples/health/get-queue-usage.md | 12 ++++ .../examples/health/get-queue-webhooks.md | 12 ++++ .../server-dart/examples/health/get-queue.md | 10 ++++ .../examples/health/get-storage-local.md | 10 ++++ .../examples/health/get-storage.md | 10 ++++ .../server-dart/examples/health/get-time.md | 10 ++++ .../1.6.x/server-dart/examples/health/get.md | 10 ++++ .../1.6.x/server-dart/examples/locale/get.md | 10 ++++ .../server-dart/examples/locale/list-codes.md | 10 ++++ .../examples/locale/list-continents.md | 10 ++++ .../examples/locale/list-countries-e-u.md | 10 ++++ .../examples/locale/list-countries-phones.md | 10 ++++ .../examples/locale/list-countries.md | 10 ++++ .../examples/locale/list-currencies.md | 10 ++++ .../examples/locale/list-languages.md | 10 ++++ .../messaging/create-apns-provider.md | 19 +++++++ .../examples/messaging/create-email.md | 23 ++++++++ .../examples/messaging/create-fcm-provider.md | 15 +++++ .../messaging/create-mailgun-provider.md | 21 +++++++ .../messaging/create-msg91provider.md | 17 ++++++ .../examples/messaging/create-push.md | 27 +++++++++ .../messaging/create-sendgrid-provider.md | 19 +++++++ .../examples/messaging/create-sms.md | 18 ++++++ .../messaging/create-smtp-provider.md | 25 ++++++++ .../examples/messaging/create-subscriber.md | 14 +++++ .../messaging/create-telesign-provider.md | 17 ++++++ .../messaging/create-textmagic-provider.md | 17 ++++++ .../examples/messaging/create-topic.md | 14 +++++ .../messaging/create-twilio-provider.md | 17 ++++++ .../messaging/create-vonage-provider.md | 17 ++++++ .../examples/messaging/delete-provider.md | 12 ++++ .../examples/messaging/delete-subscriber.md | 13 +++++ .../examples/messaging/delete-topic.md | 12 ++++ .../server-dart/examples/messaging/delete.md | 12 ++++ .../examples/messaging/get-message.md | 12 ++++ .../examples/messaging/get-provider.md | 12 ++++ .../examples/messaging/get-subscriber.md | 13 +++++ .../examples/messaging/get-topic.md | 12 ++++ .../examples/messaging/list-message-logs.md | 13 +++++ .../examples/messaging/list-messages.md | 13 +++++ .../examples/messaging/list-provider-logs.md | 13 +++++ .../examples/messaging/list-providers.md | 13 +++++ .../messaging/list-subscriber-logs.md | 13 +++++ .../examples/messaging/list-subscribers.md | 14 +++++ .../examples/messaging/list-targets.md | 13 +++++ .../examples/messaging/list-topic-logs.md | 13 +++++ .../examples/messaging/list-topics.md | 13 +++++ .../messaging/update-apns-provider.md | 19 +++++++ .../examples/messaging/update-email.md | 23 ++++++++ .../examples/messaging/update-fcm-provider.md | 15 +++++ .../messaging/update-mailgun-provider.md | 21 +++++++ .../messaging/update-msg91provider.md | 17 ++++++ .../examples/messaging/update-push.md | 27 +++++++++ .../messaging/update-sendgrid-provider.md | 19 +++++++ .../examples/messaging/update-sms.md | 18 ++++++ .../messaging/update-smtp-provider.md | 25 ++++++++ .../messaging/update-telesign-provider.md | 17 ++++++ .../messaging/update-textmagic-provider.md | 17 ++++++ .../examples/messaging/update-topic.md | 14 +++++ .../messaging/update-twilio-provider.md | 17 ++++++ .../messaging/update-vonage-provider.md | 17 ++++++ .../examples/storage/create-bucket.md | 21 +++++++ .../examples/storage/create-file.md | 16 ++++++ .../examples/storage/delete-bucket.md | 12 ++++ .../examples/storage/delete-file.md | 13 +++++ .../examples/storage/get-bucket.md | 12 ++++ .../examples/storage/get-file-download.md | 13 +++++ .../examples/storage/get-file-preview.md | 24 ++++++++ .../examples/storage/get-file-view.md | 13 +++++ .../server-dart/examples/storage/get-file.md | 13 +++++ .../examples/storage/list-buckets.md | 13 +++++ .../examples/storage/list-files.md | 14 +++++ .../examples/storage/update-bucket.md | 21 +++++++ .../examples/storage/update-file.md | 15 +++++ .../examples/teams/create-membership.md | 18 ++++++ .../server-dart/examples/teams/create.md | 14 +++++ .../examples/teams/delete-membership.md | 13 +++++ .../server-dart/examples/teams/delete.md | 12 ++++ .../examples/teams/get-membership.md | 13 +++++ .../server-dart/examples/teams/get-prefs.md | 12 ++++ .../1.6.x/server-dart/examples/teams/get.md | 12 ++++ .../examples/teams/list-memberships.md | 14 +++++ .../1.6.x/server-dart/examples/teams/list.md | 13 +++++ .../teams/update-membership-status.md | 15 +++++ .../examples/teams/update-membership.md | 14 +++++ .../server-dart/examples/teams/update-name.md | 13 +++++ .../examples/teams/update-prefs.md | 13 +++++ .../examples/users/create-argon2user.md | 15 +++++ .../examples/users/create-bcrypt-user.md | 15 +++++ .../examples/users/create-j-w-t.md | 14 +++++ .../examples/users/create-m-d5user.md | 15 +++++ .../users/create-mfa-recovery-codes.md | 12 ++++ .../examples/users/create-p-h-pass-user.md | 15 +++++ .../examples/users/create-s-h-a-user.md | 16 ++++++ .../users/create-scrypt-modified-user.md | 18 ++++++ .../examples/users/create-scrypt-user.md | 20 +++++++ .../examples/users/create-session.md | 12 ++++ .../examples/users/create-target.md | 17 ++++++ .../examples/users/create-token.md | 14 +++++ .../server-dart/examples/users/create.md | 16 ++++++ .../examples/users/delete-identity.md | 12 ++++ .../users/delete-mfa-authenticator.md | 13 +++++ .../examples/users/delete-session.md | 13 +++++ .../examples/users/delete-sessions.md | 12 ++++ .../examples/users/delete-target.md | 13 +++++ .../server-dart/examples/users/delete.md | 12 ++++ .../examples/users/get-mfa-recovery-codes.md | 12 ++++ .../server-dart/examples/users/get-prefs.md | 12 ++++ .../server-dart/examples/users/get-target.md | 13 +++++ .../1.6.x/server-dart/examples/users/get.md | 12 ++++ .../examples/users/list-identities.md | 13 +++++ .../server-dart/examples/users/list-logs.md | 13 +++++ .../examples/users/list-memberships.md | 12 ++++ .../examples/users/list-mfa-factors.md | 12 ++++ .../examples/users/list-sessions.md | 12 ++++ .../examples/users/list-targets.md | 13 +++++ .../1.6.x/server-dart/examples/users/list.md | 13 +++++ .../users/update-email-verification.md | 13 +++++ .../examples/users/update-email.md | 13 +++++ .../examples/users/update-labels.md | 13 +++++ .../users/update-mfa-recovery-codes.md | 12 ++++ .../server-dart/examples/users/update-mfa.md | 13 +++++ .../server-dart/examples/users/update-name.md | 13 +++++ .../examples/users/update-password.md | 13 +++++ .../users/update-phone-verification.md | 13 +++++ .../examples/users/update-phone.md | 13 +++++ .../examples/users/update-prefs.md | 13 +++++ .../examples/users/update-status.md | 13 +++++ .../examples/users/update-target.md | 16 ++++++ .../account/create-anonymous-session.md | 9 +++ .../account/create-email-password-session.md | 12 ++++ .../examples/account/create-email-token.md | 13 +++++ .../examples/account/create-j-w-t.md | 9 +++ .../account/create-magic-u-r-l-token.md | 14 +++++ .../account/create-mfa-authenticator.md | 12 ++++ .../examples/account/create-mfa-challenge.md | 11 ++++ .../account/create-mfa-recovery-codes.md | 10 ++++ .../examples/account/create-o-auth2token.md | 14 +++++ .../examples/account/create-phone-token.md | 12 ++++ .../account/create-phone-verification.md | 10 ++++ .../examples/account/create-recovery.md | 13 +++++ .../examples/account/create-session.md | 12 ++++ .../examples/account/create-verification.md | 12 ++++ .../server-deno/examples/account/create.md | 14 +++++ .../examples/account/delete-identity.md | 12 ++++ .../account/delete-mfa-authenticator.md | 12 ++++ .../examples/account/delete-session.md | 12 ++++ .../examples/account/delete-sessions.md | 10 ++++ .../account/get-mfa-recovery-codes.md | 10 ++++ .../server-deno/examples/account/get-prefs.md | 10 ++++ .../examples/account/get-session.md | 12 ++++ .../1.6.x/server-deno/examples/account/get.md | 10 ++++ .../examples/account/list-identities.md | 12 ++++ .../server-deno/examples/account/list-logs.md | 12 ++++ .../examples/account/list-mfa-factors.md | 10 ++++ .../examples/account/list-sessions.md | 10 ++++ .../examples/account/update-email.md | 13 +++++ .../examples/account/update-m-f-a.md | 12 ++++ .../account/update-magic-u-r-l-session.md | 12 ++++ .../account/update-mfa-authenticator.md | 13 +++++ .../examples/account/update-mfa-challenge.md | 13 +++++ .../account/update-mfa-recovery-codes.md | 10 ++++ .../examples/account/update-name.md | 12 ++++ .../examples/account/update-password.md | 13 +++++ .../examples/account/update-phone-session.md | 12 ++++ .../account/update-phone-verification.md | 13 +++++ .../examples/account/update-phone.md | 13 +++++ .../examples/account/update-prefs.md | 12 ++++ .../examples/account/update-recovery.md | 14 +++++ .../examples/account/update-session.md | 12 ++++ .../examples/account/update-status.md | 10 ++++ .../examples/account/update-verification.md | 13 +++++ .../examples/avatars/get-browser.md | 15 +++++ .../examples/avatars/get-credit-card.md | 15 +++++ .../examples/avatars/get-favicon.md | 12 ++++ .../server-deno/examples/avatars/get-flag.md | 15 +++++ .../server-deno/examples/avatars/get-image.md | 14 +++++ .../examples/avatars/get-initials.md | 15 +++++ .../server-deno/examples/avatars/get-q-r.md | 15 +++++ .../databases/create-boolean-attribute.md | 17 ++++++ .../examples/databases/create-collection.md | 17 ++++++ .../databases/create-datetime-attribute.md | 17 ++++++ .../examples/databases/create-document.md | 16 ++++++ .../databases/create-email-attribute.md | 17 ++++++ .../databases/create-enum-attribute.md | 18 ++++++ .../databases/create-float-attribute.md | 19 +++++++ .../examples/databases/create-index.md | 17 ++++++ .../databases/create-integer-attribute.md | 19 +++++++ .../examples/databases/create-ip-attribute.md | 17 ++++++ .../create-relationship-attribute.md | 19 +++++++ .../databases/create-string-attribute.md | 19 +++++++ .../databases/create-url-attribute.md | 17 ++++++ .../server-deno/examples/databases/create.md | 14 +++++ .../examples/databases/delete-attribute.md | 14 +++++ .../examples/databases/delete-collection.md | 13 +++++ .../examples/databases/delete-document.md | 14 +++++ .../examples/databases/delete-index.md | 14 +++++ .../server-deno/examples/databases/delete.md | 12 ++++ .../examples/databases/get-attribute.md | 14 +++++ .../examples/databases/get-collection.md | 13 +++++ .../examples/databases/get-document.md | 15 +++++ .../examples/databases/get-index.md | 14 +++++ .../server-deno/examples/databases/get.md | 12 ++++ .../examples/databases/list-attributes.md | 14 +++++ .../examples/databases/list-collections.md | 14 +++++ .../examples/databases/list-documents.md | 14 +++++ .../examples/databases/list-indexes.md | 14 +++++ .../server-deno/examples/databases/list.md | 13 +++++ .../databases/update-boolean-attribute.md | 16 ++++++ .../examples/databases/update-collection.md | 17 ++++++ .../databases/update-datetime-attribute.md | 16 ++++++ .../examples/databases/update-document.md | 16 ++++++ .../databases/update-email-attribute.md | 16 ++++++ .../databases/update-enum-attribute.md | 17 ++++++ .../databases/update-float-attribute.md | 18 ++++++ .../databases/update-integer-attribute.md | 18 ++++++ .../examples/databases/update-ip-attribute.md | 16 ++++++ .../update-relationship-attribute.md | 15 +++++ .../databases/update-string-attribute.md | 16 ++++++ .../databases/update-url-attribute.md | 16 ++++++ .../server-deno/examples/databases/update.md | 14 +++++ .../examples/functions/create-build.md | 14 +++++ .../examples/functions/create-deployment.md | 16 ++++++ .../examples/functions/create-execution.md | 18 ++++++ .../examples/functions/create-variable.md | 14 +++++ .../server-deno/examples/functions/create.md | 32 +++++++++++ .../examples/functions/delete-deployment.md | 13 +++++ .../examples/functions/delete-execution.md | 13 +++++ .../examples/functions/delete-variable.md | 13 +++++ .../server-deno/examples/functions/delete.md | 12 ++++ .../examples/functions/download-deployment.md | 13 +++++ .../examples/functions/get-deployment.md | 13 +++++ .../examples/functions/get-execution.md | 13 +++++ .../examples/functions/get-variable.md | 13 +++++ .../server-deno/examples/functions/get.md | 12 ++++ .../examples/functions/list-deployments.md | 14 +++++ .../examples/functions/list-executions.md | 14 +++++ .../examples/functions/list-runtimes.md | 10 ++++ .../examples/functions/list-variables.md | 12 ++++ .../server-deno/examples/functions/list.md | 13 +++++ .../functions/update-deployment-build.md | 13 +++++ .../examples/functions/update-deployment.md | 13 +++++ .../examples/functions/update-variable.md | 15 +++++ .../server-deno/examples/functions/update.md | 28 +++++++++ .../server-deno/examples/graphql/mutation.md | 12 ++++ .../server-deno/examples/graphql/query.md | 12 ++++ .../examples/health/get-antivirus.md | 10 ++++ .../server-deno/examples/health/get-cache.md | 10 ++++ .../examples/health/get-certificate.md | 12 ++++ .../server-deno/examples/health/get-d-b.md | 10 ++++ .../examples/health/get-failed-jobs.md | 13 +++++ .../examples/health/get-pub-sub.md | 10 ++++ .../examples/health/get-queue-builds.md | 12 ++++ .../examples/health/get-queue-certificates.md | 12 ++++ .../examples/health/get-queue-databases.md | 13 +++++ .../examples/health/get-queue-deletes.md | 12 ++++ .../examples/health/get-queue-functions.md | 12 ++++ .../examples/health/get-queue-logs.md | 12 ++++ .../examples/health/get-queue-mails.md | 12 ++++ .../examples/health/get-queue-messaging.md | 12 ++++ .../examples/health/get-queue-migrations.md | 12 ++++ .../examples/health/get-queue-usage-dump.md | 12 ++++ .../examples/health/get-queue-usage.md | 12 ++++ .../examples/health/get-queue-webhooks.md | 12 ++++ .../server-deno/examples/health/get-queue.md | 10 ++++ .../examples/health/get-storage-local.md | 10 ++++ .../examples/health/get-storage.md | 10 ++++ .../server-deno/examples/health/get-time.md | 10 ++++ .../1.6.x/server-deno/examples/health/get.md | 10 ++++ .../1.6.x/server-deno/examples/locale/get.md | 10 ++++ .../server-deno/examples/locale/list-codes.md | 10 ++++ .../examples/locale/list-continents.md | 10 ++++ .../examples/locale/list-countries-e-u.md | 10 ++++ .../examples/locale/list-countries-phones.md | 10 ++++ .../examples/locale/list-countries.md | 10 ++++ .../examples/locale/list-currencies.md | 10 ++++ .../examples/locale/list-languages.md | 10 ++++ .../messaging/create-apns-provider.md | 19 +++++++ .../examples/messaging/create-email.md | 23 ++++++++ .../examples/messaging/create-fcm-provider.md | 15 +++++ .../messaging/create-mailgun-provider.md | 21 +++++++ .../messaging/create-msg91provider.md | 17 ++++++ .../examples/messaging/create-push.md | 27 +++++++++ .../messaging/create-sendgrid-provider.md | 19 +++++++ .../examples/messaging/create-sms.md | 18 ++++++ .../messaging/create-smtp-provider.md | 25 ++++++++ .../examples/messaging/create-subscriber.md | 14 +++++ .../messaging/create-telesign-provider.md | 17 ++++++ .../messaging/create-textmagic-provider.md | 17 ++++++ .../examples/messaging/create-topic.md | 14 +++++ .../messaging/create-twilio-provider.md | 17 ++++++ .../messaging/create-vonage-provider.md | 17 ++++++ .../examples/messaging/delete-provider.md | 12 ++++ .../examples/messaging/delete-subscriber.md | 13 +++++ .../examples/messaging/delete-topic.md | 12 ++++ .../server-deno/examples/messaging/delete.md | 12 ++++ .../examples/messaging/get-message.md | 12 ++++ .../examples/messaging/get-provider.md | 12 ++++ .../examples/messaging/get-subscriber.md | 13 +++++ .../examples/messaging/get-topic.md | 12 ++++ .../examples/messaging/list-message-logs.md | 13 +++++ .../examples/messaging/list-messages.md | 13 +++++ .../examples/messaging/list-provider-logs.md | 13 +++++ .../examples/messaging/list-providers.md | 13 +++++ .../messaging/list-subscriber-logs.md | 13 +++++ .../examples/messaging/list-subscribers.md | 14 +++++ .../examples/messaging/list-targets.md | 13 +++++ .../examples/messaging/list-topic-logs.md | 13 +++++ .../examples/messaging/list-topics.md | 13 +++++ .../messaging/update-apns-provider.md | 19 +++++++ .../examples/messaging/update-email.md | 23 ++++++++ .../examples/messaging/update-fcm-provider.md | 15 +++++ .../messaging/update-mailgun-provider.md | 21 +++++++ .../messaging/update-msg91provider.md | 17 ++++++ .../examples/messaging/update-push.md | 27 +++++++++ .../messaging/update-sendgrid-provider.md | 19 +++++++ .../examples/messaging/update-sms.md | 18 ++++++ .../messaging/update-smtp-provider.md | 25 ++++++++ .../messaging/update-telesign-provider.md | 17 ++++++ .../messaging/update-textmagic-provider.md | 17 ++++++ .../examples/messaging/update-topic.md | 14 +++++ .../messaging/update-twilio-provider.md | 17 ++++++ .../messaging/update-vonage-provider.md | 17 ++++++ .../examples/storage/create-bucket.md | 21 +++++++ .../examples/storage/create-file.md | 15 +++++ .../examples/storage/delete-bucket.md | 12 ++++ .../examples/storage/delete-file.md | 13 +++++ .../examples/storage/get-bucket.md | 12 ++++ .../examples/storage/get-file-download.md | 13 +++++ .../examples/storage/get-file-preview.md | 24 ++++++++ .../examples/storage/get-file-view.md | 13 +++++ .../server-deno/examples/storage/get-file.md | 13 +++++ .../examples/storage/list-buckets.md | 13 +++++ .../examples/storage/list-files.md | 14 +++++ .../examples/storage/update-bucket.md | 21 +++++++ .../examples/storage/update-file.md | 15 +++++ .../examples/teams/create-membership.md | 18 ++++++ .../server-deno/examples/teams/create.md | 14 +++++ .../examples/teams/delete-membership.md | 13 +++++ .../server-deno/examples/teams/delete.md | 12 ++++ .../examples/teams/get-membership.md | 13 +++++ .../server-deno/examples/teams/get-prefs.md | 12 ++++ .../1.6.x/server-deno/examples/teams/get.md | 12 ++++ .../examples/teams/list-memberships.md | 14 +++++ .../1.6.x/server-deno/examples/teams/list.md | 13 +++++ .../teams/update-membership-status.md | 15 +++++ .../examples/teams/update-membership.md | 14 +++++ .../server-deno/examples/teams/update-name.md | 13 +++++ .../examples/teams/update-prefs.md | 13 +++++ .../examples/users/create-argon2user.md | 15 +++++ .../examples/users/create-bcrypt-user.md | 15 +++++ .../examples/users/create-j-w-t.md | 14 +++++ .../examples/users/create-m-d5user.md | 15 +++++ .../users/create-mfa-recovery-codes.md | 12 ++++ .../examples/users/create-p-h-pass-user.md | 15 +++++ .../examples/users/create-s-h-a-user.md | 16 ++++++ .../users/create-scrypt-modified-user.md | 18 ++++++ .../examples/users/create-scrypt-user.md | 20 +++++++ .../examples/users/create-session.md | 12 ++++ .../examples/users/create-target.md | 17 ++++++ .../examples/users/create-token.md | 14 +++++ .../server-deno/examples/users/create.md | 16 ++++++ .../examples/users/delete-identity.md | 12 ++++ .../users/delete-mfa-authenticator.md | 13 +++++ .../examples/users/delete-session.md | 13 +++++ .../examples/users/delete-sessions.md | 12 ++++ .../examples/users/delete-target.md | 13 +++++ .../server-deno/examples/users/delete.md | 12 ++++ .../examples/users/get-mfa-recovery-codes.md | 12 ++++ .../server-deno/examples/users/get-prefs.md | 12 ++++ .../server-deno/examples/users/get-target.md | 13 +++++ .../1.6.x/server-deno/examples/users/get.md | 12 ++++ .../examples/users/list-identities.md | 13 +++++ .../server-deno/examples/users/list-logs.md | 13 +++++ .../examples/users/list-memberships.md | 12 ++++ .../examples/users/list-mfa-factors.md | 12 ++++ .../examples/users/list-sessions.md | 12 ++++ .../examples/users/list-targets.md | 13 +++++ .../1.6.x/server-deno/examples/users/list.md | 13 +++++ .../users/update-email-verification.md | 13 +++++ .../examples/users/update-email.md | 13 +++++ .../examples/users/update-labels.md | 13 +++++ .../users/update-mfa-recovery-codes.md | 12 ++++ .../server-deno/examples/users/update-mfa.md | 13 +++++ .../server-deno/examples/users/update-name.md | 13 +++++ .../examples/users/update-password.md | 13 +++++ .../users/update-phone-verification.md | 13 +++++ .../examples/users/update-phone.md | 13 +++++ .../examples/users/update-prefs.md | 13 +++++ .../examples/users/update-status.md | 13 +++++ .../examples/users/update-target.md | 16 ++++++ .../account/create-anonymous-session.md | 11 ++++ .../account/create-email-password-session.md | 14 +++++ .../examples/account/create-email-token.md | 15 +++++ .../examples/account/create-j-w-t.md | 11 ++++ .../account/create-magic-u-r-l-token.md | 16 ++++++ .../account/create-mfa-authenticator.md | 15 +++++ .../examples/account/create-mfa-challenge.md | 14 +++++ .../account/create-mfa-recovery-codes.md | 12 ++++ .../examples/account/create-o-auth2token.md | 17 ++++++ .../examples/account/create-phone-token.md | 14 +++++ .../account/create-phone-verification.md | 12 ++++ .../examples/account/create-recovery.md | 15 +++++ .../examples/account/create-session.md | 14 +++++ .../examples/account/create-verification.md | 14 +++++ .../server-dotnet/examples/account/create.md | 16 ++++++ .../examples/account/delete-identity.md | 14 +++++ .../account/delete-mfa-authenticator.md | 15 +++++ .../examples/account/delete-session.md | 14 +++++ .../examples/account/delete-sessions.md | 12 ++++ .../account/get-mfa-recovery-codes.md | 12 ++++ .../examples/account/get-prefs.md | 12 ++++ .../examples/account/get-session.md | 14 +++++ .../server-dotnet/examples/account/get.md | 12 ++++ .../examples/account/list-identities.md | 14 +++++ .../examples/account/list-logs.md | 14 +++++ .../examples/account/list-mfa-factors.md | 12 ++++ .../examples/account/list-sessions.md | 12 ++++ .../examples/account/update-email.md | 15 +++++ .../examples/account/update-m-f-a.md | 14 +++++ .../account/update-magic-u-r-l-session.md | 14 +++++ .../account/update-mfa-authenticator.md | 16 ++++++ .../examples/account/update-mfa-challenge.md | 15 +++++ .../account/update-mfa-recovery-codes.md | 12 ++++ .../examples/account/update-name.md | 14 +++++ .../examples/account/update-password.md | 15 +++++ .../examples/account/update-phone-session.md | 14 +++++ .../account/update-phone-verification.md | 15 +++++ .../examples/account/update-phone.md | 15 +++++ .../examples/account/update-prefs.md | 14 +++++ .../examples/account/update-recovery.md | 16 ++++++ .../examples/account/update-session.md | 14 +++++ .../examples/account/update-status.md | 12 ++++ .../examples/account/update-verification.md | 15 +++++ .../examples/avatars/get-browser.md | 18 ++++++ .../examples/avatars/get-credit-card.md | 18 ++++++ .../examples/avatars/get-favicon.md | 14 +++++ .../examples/avatars/get-flag.md | 18 ++++++ .../examples/avatars/get-image.md | 16 ++++++ .../examples/avatars/get-initials.md | 17 ++++++ .../server-dotnet/examples/avatars/get-q-r.md | 17 ++++++ .../databases/create-boolean-attribute.md | 19 +++++++ .../examples/databases/create-collection.md | 19 +++++++ .../databases/create-datetime-attribute.md | 19 +++++++ .../examples/databases/create-document.md | 18 ++++++ .../databases/create-email-attribute.md | 19 +++++++ .../databases/create-enum-attribute.md | 20 +++++++ .../databases/create-float-attribute.md | 21 +++++++ .../examples/databases/create-index.md | 20 +++++++ .../databases/create-integer-attribute.md | 21 +++++++ .../examples/databases/create-ip-attribute.md | 19 +++++++ .../create-relationship-attribute.md | 22 +++++++ .../databases/create-string-attribute.md | 21 +++++++ .../databases/create-url-attribute.md | 19 +++++++ .../examples/databases/create.md | 16 ++++++ .../examples/databases/delete-attribute.md | 16 ++++++ .../examples/databases/delete-collection.md | 15 +++++ .../examples/databases/delete-document.md | 16 ++++++ .../examples/databases/delete-index.md | 16 ++++++ .../examples/databases/delete.md | 14 +++++ .../examples/databases/get-attribute.md | 16 ++++++ .../examples/databases/get-collection.md | 15 +++++ .../examples/databases/get-document.md | 17 ++++++ .../examples/databases/get-index.md | 16 ++++++ .../server-dotnet/examples/databases/get.md | 14 +++++ .../examples/databases/list-attributes.md | 16 ++++++ .../examples/databases/list-collections.md | 16 ++++++ .../examples/databases/list-documents.md | 16 ++++++ .../examples/databases/list-indexes.md | 16 ++++++ .../server-dotnet/examples/databases/list.md | 15 +++++ .../databases/update-boolean-attribute.md | 18 ++++++ .../examples/databases/update-collection.md | 19 +++++++ .../databases/update-datetime-attribute.md | 18 ++++++ .../examples/databases/update-document.md | 18 ++++++ .../databases/update-email-attribute.md | 18 ++++++ .../databases/update-enum-attribute.md | 19 +++++++ .../databases/update-float-attribute.md | 20 +++++++ .../databases/update-integer-attribute.md | 20 +++++++ .../examples/databases/update-ip-attribute.md | 18 ++++++ .../update-relationship-attribute.md | 18 ++++++ .../databases/update-string-attribute.md | 18 ++++++ .../databases/update-url-attribute.md | 18 ++++++ .../examples/databases/update.md | 16 ++++++ .../examples/functions/create-build.md | 16 ++++++ .../examples/functions/create-deployment.md | 18 ++++++ .../examples/functions/create-execution.md | 21 +++++++ .../examples/functions/create-variable.md | 16 ++++++ .../examples/functions/create.md | 35 ++++++++++++ .../examples/functions/delete-deployment.md | 15 +++++ .../examples/functions/delete-execution.md | 15 +++++ .../examples/functions/delete-variable.md | 15 +++++ .../examples/functions/delete.md | 14 +++++ .../examples/functions/download-deployment.md | 15 +++++ .../examples/functions/get-deployment.md | 15 +++++ .../examples/functions/get-execution.md | 15 +++++ .../examples/functions/get-variable.md | 15 +++++ .../server-dotnet/examples/functions/get.md | 14 +++++ .../examples/functions/list-deployments.md | 16 ++++++ .../examples/functions/list-executions.md | 16 ++++++ .../examples/functions/list-runtimes.md | 12 ++++ .../examples/functions/list-variables.md | 14 +++++ .../server-dotnet/examples/functions/list.md | 15 +++++ .../functions/update-deployment-build.md | 15 +++++ .../examples/functions/update-deployment.md | 15 +++++ .../examples/functions/update-variable.md | 17 ++++++ .../examples/functions/update.md | 31 ++++++++++ .../examples/graphql/mutation.md | 14 +++++ .../server-dotnet/examples/graphql/query.md | 14 +++++ .../examples/health/get-antivirus.md | 12 ++++ .../examples/health/get-cache.md | 12 ++++ .../examples/health/get-certificate.md | 14 +++++ .../server-dotnet/examples/health/get-d-b.md | 12 ++++ .../examples/health/get-failed-jobs.md | 16 ++++++ .../examples/health/get-pub-sub.md | 12 ++++ .../examples/health/get-queue-builds.md | 14 +++++ .../examples/health/get-queue-certificates.md | 14 +++++ .../examples/health/get-queue-databases.md | 15 +++++ .../examples/health/get-queue-deletes.md | 14 +++++ .../examples/health/get-queue-functions.md | 14 +++++ .../examples/health/get-queue-logs.md | 14 +++++ .../examples/health/get-queue-mails.md | 14 +++++ .../examples/health/get-queue-messaging.md | 14 +++++ .../examples/health/get-queue-migrations.md | 14 +++++ .../examples/health/get-queue-usage-dump.md | 14 +++++ .../examples/health/get-queue-usage.md | 14 +++++ .../examples/health/get-queue-webhooks.md | 14 +++++ .../examples/health/get-queue.md | 12 ++++ .../examples/health/get-storage-local.md | 12 ++++ .../examples/health/get-storage.md | 12 ++++ .../server-dotnet/examples/health/get-time.md | 12 ++++ .../server-dotnet/examples/health/get.md | 12 ++++ .../server-dotnet/examples/locale/get.md | 12 ++++ .../examples/locale/list-codes.md | 12 ++++ .../examples/locale/list-continents.md | 12 ++++ .../examples/locale/list-countries-e-u.md | 12 ++++ .../examples/locale/list-countries-phones.md | 12 ++++ .../examples/locale/list-countries.md | 12 ++++ .../examples/locale/list-currencies.md | 12 ++++ .../examples/locale/list-languages.md | 12 ++++ .../messaging/create-apns-provider.md | 21 +++++++ .../examples/messaging/create-email.md | 25 ++++++++ .../examples/messaging/create-fcm-provider.md | 17 ++++++ .../messaging/create-mailgun-provider.md | 23 ++++++++ .../messaging/create-msg91provider.md | 19 +++++++ .../examples/messaging/create-push.md | 29 ++++++++++ .../messaging/create-sendgrid-provider.md | 21 +++++++ .../examples/messaging/create-sms.md | 20 +++++++ .../messaging/create-smtp-provider.md | 28 +++++++++ .../examples/messaging/create-subscriber.md | 16 ++++++ .../messaging/create-telesign-provider.md | 19 +++++++ .../messaging/create-textmagic-provider.md | 19 +++++++ .../examples/messaging/create-topic.md | 16 ++++++ .../messaging/create-twilio-provider.md | 19 +++++++ .../messaging/create-vonage-provider.md | 19 +++++++ .../examples/messaging/delete-provider.md | 14 +++++ .../examples/messaging/delete-subscriber.md | 15 +++++ .../examples/messaging/delete-topic.md | 14 +++++ .../examples/messaging/delete.md | 14 +++++ .../examples/messaging/get-message.md | 14 +++++ .../examples/messaging/get-provider.md | 14 +++++ .../examples/messaging/get-subscriber.md | 15 +++++ .../examples/messaging/get-topic.md | 14 +++++ .../examples/messaging/list-message-logs.md | 15 +++++ .../examples/messaging/list-messages.md | 15 +++++ .../examples/messaging/list-provider-logs.md | 15 +++++ .../examples/messaging/list-providers.md | 15 +++++ .../messaging/list-subscriber-logs.md | 15 +++++ .../examples/messaging/list-subscribers.md | 16 ++++++ .../examples/messaging/list-targets.md | 15 +++++ .../examples/messaging/list-topic-logs.md | 15 +++++ .../examples/messaging/list-topics.md | 15 +++++ .../messaging/update-apns-provider.md | 21 +++++++ .../examples/messaging/update-email.md | 25 ++++++++ .../examples/messaging/update-fcm-provider.md | 17 ++++++ .../messaging/update-mailgun-provider.md | 23 ++++++++ .../messaging/update-msg91provider.md | 19 +++++++ .../examples/messaging/update-push.md | 29 ++++++++++ .../messaging/update-sendgrid-provider.md | 21 +++++++ .../examples/messaging/update-sms.md | 20 +++++++ .../messaging/update-smtp-provider.md | 28 +++++++++ .../messaging/update-telesign-provider.md | 19 +++++++ .../messaging/update-textmagic-provider.md | 19 +++++++ .../examples/messaging/update-topic.md | 16 ++++++ .../messaging/update-twilio-provider.md | 19 +++++++ .../messaging/update-vonage-provider.md | 19 +++++++ .../examples/storage/create-bucket.md | 24 ++++++++ .../examples/storage/create-file.md | 17 ++++++ .../examples/storage/delete-bucket.md | 14 +++++ .../examples/storage/delete-file.md | 15 +++++ .../examples/storage/get-bucket.md | 14 +++++ .../examples/storage/get-file-download.md | 15 +++++ .../examples/storage/get-file-preview.md | 27 +++++++++ .../examples/storage/get-file-view.md | 15 +++++ .../examples/storage/get-file.md | 15 +++++ .../examples/storage/list-buckets.md | 15 +++++ .../examples/storage/list-files.md | 16 ++++++ .../examples/storage/update-bucket.md | 24 ++++++++ .../examples/storage/update-file.md | 17 ++++++ .../examples/teams/create-membership.md | 20 +++++++ .../server-dotnet/examples/teams/create.md | 16 ++++++ .../examples/teams/delete-membership.md | 15 +++++ .../server-dotnet/examples/teams/delete.md | 14 +++++ .../examples/teams/get-membership.md | 15 +++++ .../server-dotnet/examples/teams/get-prefs.md | 14 +++++ .../1.6.x/server-dotnet/examples/teams/get.md | 14 +++++ .../examples/teams/list-memberships.md | 16 ++++++ .../server-dotnet/examples/teams/list.md | 15 +++++ .../teams/update-membership-status.md | 17 ++++++ .../examples/teams/update-membership.md | 16 ++++++ .../examples/teams/update-name.md | 15 +++++ .../examples/teams/update-prefs.md | 15 +++++ .../examples/users/create-argon2user.md | 17 ++++++ .../examples/users/create-bcrypt-user.md | 17 ++++++ .../examples/users/create-j-w-t.md | 16 ++++++ .../examples/users/create-m-d5user.md | 17 ++++++ .../users/create-mfa-recovery-codes.md | 14 +++++ .../examples/users/create-p-h-pass-user.md | 17 ++++++ .../examples/users/create-s-h-a-user.md | 19 +++++++ .../users/create-scrypt-modified-user.md | 20 +++++++ .../examples/users/create-scrypt-user.md | 22 +++++++ .../examples/users/create-session.md | 14 +++++ .../examples/users/create-target.md | 20 +++++++ .../examples/users/create-token.md | 16 ++++++ .../server-dotnet/examples/users/create.md | 18 ++++++ .../examples/users/delete-identity.md | 14 +++++ .../users/delete-mfa-authenticator.md | 16 ++++++ .../examples/users/delete-session.md | 15 +++++ .../examples/users/delete-sessions.md | 14 +++++ .../examples/users/delete-target.md | 15 +++++ .../server-dotnet/examples/users/delete.md | 14 +++++ .../examples/users/get-mfa-recovery-codes.md | 14 +++++ .../server-dotnet/examples/users/get-prefs.md | 14 +++++ .../examples/users/get-target.md | 15 +++++ .../1.6.x/server-dotnet/examples/users/get.md | 14 +++++ .../examples/users/list-identities.md | 15 +++++ .../server-dotnet/examples/users/list-logs.md | 15 +++++ .../examples/users/list-memberships.md | 14 +++++ .../examples/users/list-mfa-factors.md | 14 +++++ .../examples/users/list-sessions.md | 14 +++++ .../examples/users/list-targets.md | 15 +++++ .../server-dotnet/examples/users/list.md | 15 +++++ .../users/update-email-verification.md | 15 +++++ .../examples/users/update-email.md | 15 +++++ .../examples/users/update-labels.md | 15 +++++ .../users/update-mfa-recovery-codes.md | 14 +++++ .../examples/users/update-mfa.md | 15 +++++ .../examples/users/update-name.md | 15 +++++ .../examples/users/update-password.md | 15 +++++ .../users/update-phone-verification.md | 15 +++++ .../examples/users/update-phone.md | 15 +++++ .../examples/users/update-prefs.md | 15 +++++ .../examples/users/update-status.md | 15 +++++ .../examples/users/update-target.md | 18 ++++++ .../account/create-anonymous-session.md | 33 +++++++++++ .../account/create-email-password-session.md | 36 ++++++++++++ .../examples/account/create-email-token.md | 14 +++++ .../examples/account/create-j-w-t.md | 5 ++ .../account/create-magic-u-r-l-token.md | 15 +++++ .../account/create-mfa-authenticator.md | 8 +++ .../examples/account/create-mfa-challenge.md | 10 ++++ .../account/create-mfa-recovery-codes.md | 5 ++ .../examples/account/create-phone-token.md | 13 +++++ .../account/create-phone-verification.md | 10 ++++ .../examples/account/create-recovery.md | 13 +++++ .../examples/account/create-session.md | 36 ++++++++++++ .../examples/account/create-verification.md | 12 ++++ .../server-graphql/examples/account/create.md | 39 +++++++++++++ .../examples/account/delete-identity.md | 7 +++ .../account/delete-mfa-authenticator.md | 7 +++ .../examples/account/delete-session.md | 7 +++ .../examples/account/delete-sessions.md | 5 ++ .../account/get-mfa-recovery-codes.md | 5 ++ .../examples/account/get-prefs.md | 5 ++ .../examples/account/get-session.md | 35 ++++++++++++ .../server-graphql/examples/account/get.md | 34 +++++++++++ .../examples/account/list-identities.md | 19 +++++++ .../examples/account/list-logs.md | 30 ++++++++++ .../examples/account/list-mfa-factors.md | 8 +++ .../examples/account/list-sessions.md | 36 ++++++++++++ .../examples/account/update-email.md | 37 ++++++++++++ .../examples/account/update-m-f-a.md | 36 ++++++++++++ .../account/update-magic-u-r-l-session.md | 36 ++++++++++++ .../account/update-mfa-authenticator.md | 37 ++++++++++++ .../examples/account/update-mfa-challenge.md | 8 +++ .../account/update-mfa-recovery-codes.md | 5 ++ .../examples/account/update-name.md | 36 ++++++++++++ .../examples/account/update-password.md | 37 ++++++++++++ .../examples/account/update-phone-session.md | 36 ++++++++++++ .../account/update-phone-verification.md | 13 +++++ .../examples/account/update-phone.md | 37 ++++++++++++ .../examples/account/update-prefs.md | 36 ++++++++++++ .../examples/account/update-recovery.md | 14 +++++ .../examples/account/update-session.md | 35 ++++++++++++ .../examples/account/update-status.md | 34 +++++++++++ .../examples/account/update-verification.md | 13 +++++ .../examples/avatars/get-browser.md | 10 ++++ .../examples/avatars/get-credit-card.md | 10 ++++ .../examples/avatars/get-favicon.md | 7 +++ .../examples/avatars/get-flag.md | 10 ++++ .../examples/avatars/get-image.md | 9 +++ .../examples/avatars/get-initials.md | 10 ++++ .../examples/avatars/get-q-r.md | 10 ++++ .../databases/create-boolean-attribute.md | 18 ++++++ .../examples/databases/create-collection.md | 28 +++++++++ .../databases/create-datetime-attribute.md | 19 +++++++ .../examples/databases/create-document.md | 17 ++++++ .../databases/create-email-attribute.md | 19 +++++++ .../databases/create-enum-attribute.md | 21 +++++++ .../databases/create-float-attribute.md | 22 +++++++ .../examples/databases/create-index.md | 17 ++++++ .../databases/create-integer-attribute.md | 22 +++++++ .../examples/databases/create-ip-attribute.md | 19 +++++++ .../create-relationship-attribute.md | 25 ++++++++ .../databases/create-string-attribute.md | 21 +++++++ .../databases/create-url-attribute.md | 19 +++++++ .../examples/databases/create.md | 13 +++++ .../examples/databases/delete-attribute.md | 9 +++ .../examples/databases/delete-collection.md | 8 +++ .../examples/databases/delete-document.md | 9 +++ .../examples/databases/delete-index.md | 9 +++ .../examples/databases/delete.md | 7 +++ .../examples/databases/get-attribute.md | 9 +++ .../examples/databases/get-collection.md | 24 ++++++++ .../examples/databases/get-document.md | 16 ++++++ .../examples/databases/get-index.md | 14 +++++ .../server-graphql/examples/databases/get.md | 11 ++++ .../examples/databases/list-attributes.md | 10 ++++ .../examples/databases/list-collections.md | 28 +++++++++ .../examples/databases/list-documents.md | 18 ++++++ .../examples/databases/list-indexes.md | 17 ++++++ .../server-graphql/examples/databases/list.md | 15 +++++ .../databases/update-boolean-attribute.md | 17 ++++++ .../examples/databases/update-collection.md | 28 +++++++++ .../databases/update-datetime-attribute.md | 18 ++++++ .../examples/databases/update-document.md | 17 ++++++ .../databases/update-email-attribute.md | 18 ++++++ .../databases/update-enum-attribute.md | 20 +++++++ .../databases/update-float-attribute.md | 21 +++++++ .../databases/update-integer-attribute.md | 21 +++++++ .../examples/databases/update-ip-attribute.md | 18 ++++++ .../update-relationship-attribute.md | 21 +++++++ .../databases/update-string-attribute.md | 18 ++++++ .../databases/update-url-attribute.md | 18 ++++++ .../examples/databases/update.md | 13 +++++ .../examples/functions/create-build.md | 9 +++ .../examples/functions/create-deployment.md | 24 ++++++++ .../examples/functions/create-execution.md | 34 +++++++++++ .../examples/functions/create-variable.md | 15 +++++ .../examples/functions/create.md | 57 +++++++++++++++++++ .../examples/functions/delete-deployment.md | 8 +++ .../examples/functions/delete-execution.md | 8 +++ .../examples/functions/delete-variable.md | 8 +++ .../examples/functions/delete.md | 7 +++ .../examples/functions/download-deployment.md | 8 +++ .../examples/functions/get-deployment.md | 30 ++++++++++ .../examples/functions/get-execution.md | 29 ++++++++++ .../examples/functions/get-variable.md | 14 +++++ .../server-graphql/examples/functions/get.md | 37 ++++++++++++ .../examples/functions/list-deployments.md | 34 +++++++++++ .../examples/functions/list-executions.md | 33 +++++++++++ .../examples/functions/list-runtimes.md | 14 +++++ .../examples/functions/list-variables.md | 16 ++++++ .../server-graphql/examples/functions/list.md | 41 +++++++++++++ .../functions/update-deployment-build.md | 16 ++++++ .../examples/functions/update-deployment.md | 38 +++++++++++++ .../examples/functions/update-variable.md | 16 ++++++ .../examples/functions/update.md | 53 +++++++++++++++++ .../examples/health/get-antivirus.md | 6 ++ .../examples/health/get-cache.md | 7 +++ .../examples/health/get-certificate.md | 12 ++++ .../server-graphql/examples/health/get-d-b.md | 7 +++ .../examples/health/get-failed-jobs.md | 8 +++ .../examples/health/get-pub-sub.md | 7 +++ .../examples/health/get-queue-builds.md | 7 +++ .../examples/health/get-queue-certificates.md | 7 +++ .../examples/health/get-queue-databases.md | 8 +++ .../examples/health/get-queue-deletes.md | 7 +++ .../examples/health/get-queue-functions.md | 7 +++ .../examples/health/get-queue-logs.md | 7 +++ .../examples/health/get-queue-mails.md | 7 +++ .../examples/health/get-queue-messaging.md | 7 +++ .../examples/health/get-queue-migrations.md | 7 +++ .../examples/health/get-queue-usage-dump.md | 7 +++ .../examples/health/get-queue-usage.md | 7 +++ .../examples/health/get-queue-webhooks.md | 7 +++ .../examples/health/get-queue.md | 7 +++ .../examples/health/get-storage-local.md | 7 +++ .../examples/health/get-storage.md | 7 +++ .../examples/health/get-time.md | 7 +++ .../server-graphql/examples/health/get.md | 7 +++ .../server-graphql/examples/locale/get.md | 11 ++++ .../examples/locale/list-codes.md | 9 +++ .../examples/locale/list-continents.md | 9 +++ .../examples/locale/list-countries-e-u.md | 9 +++ .../examples/locale/list-countries-phones.md | 10 ++++ .../examples/locale/list-countries.md | 9 +++ .../examples/locale/list-currencies.md | 14 +++++ .../examples/locale/list-languages.md | 10 ++++ .../messaging/create-apns-provider.md | 22 +++++++ .../examples/messaging/create-email.md | 30 ++++++++++ .../examples/messaging/create-fcm-provider.md | 18 ++++++ .../messaging/create-mailgun-provider.md | 24 ++++++++ .../messaging/create-msg91provider.md | 20 +++++++ .../examples/messaging/create-push.md | 34 +++++++++++ .../messaging/create-sendgrid-provider.md | 22 +++++++ .../examples/messaging/create-sms.md | 25 ++++++++ .../messaging/create-smtp-provider.md | 28 +++++++++ .../examples/messaging/create-subscriber.md | 26 +++++++++ .../messaging/create-telesign-provider.md | 20 +++++++ .../messaging/create-textmagic-provider.md | 20 +++++++ .../examples/messaging/create-topic.md | 16 ++++++ .../messaging/create-twilio-provider.md | 20 +++++++ .../messaging/create-vonage-provider.md | 20 +++++++ .../examples/messaging/delete-provider.md | 7 +++ .../examples/messaging/delete-subscriber.md | 8 +++ .../examples/messaging/delete-topic.md | 7 +++ .../examples/messaging/delete.md | 7 +++ .../examples/messaging/get-message.md | 19 +++++++ .../examples/messaging/get-provider.md | 15 +++++ .../examples/messaging/get-subscriber.md | 25 ++++++++ .../examples/messaging/get-topic.md | 14 +++++ .../examples/messaging/list-message-logs.md | 31 ++++++++++ .../examples/messaging/list-messages.md | 23 ++++++++ .../examples/messaging/list-provider-logs.md | 31 ++++++++++ .../examples/messaging/list-providers.md | 19 +++++++ .../messaging/list-subscriber-logs.md | 31 ++++++++++ .../examples/messaging/list-subscribers.md | 29 ++++++++++ .../examples/messaging/list-targets.md | 18 ++++++ .../examples/messaging/list-topic-logs.md | 31 ++++++++++ .../examples/messaging/list-topics.md | 18 ++++++ .../messaging/update-apns-provider.md | 22 +++++++ .../examples/messaging/update-email.md | 30 ++++++++++ .../examples/messaging/update-fcm-provider.md | 18 ++++++ .../messaging/update-mailgun-provider.md | 24 ++++++++ .../messaging/update-msg91provider.md | 20 +++++++ .../examples/messaging/update-push.md | 34 +++++++++++ .../messaging/update-sendgrid-provider.md | 22 +++++++ .../examples/messaging/update-sms.md | 25 ++++++++ .../messaging/update-smtp-provider.md | 28 +++++++++ .../messaging/update-telesign-provider.md | 20 +++++++ .../messaging/update-textmagic-provider.md | 20 +++++++ .../examples/messaging/update-topic.md | 16 ++++++ .../messaging/update-twilio-provider.md | 20 +++++++ .../messaging/update-vonage-provider.md | 20 +++++++ .../examples/storage/create-bucket.md | 27 +++++++++ .../examples/storage/create-file.md | 26 +++++++++ .../examples/storage/delete-bucket.md | 7 +++ .../examples/storage/delete-file.md | 8 +++ .../examples/storage/get-bucket.md | 18 ++++++ .../examples/storage/get-file-download.md | 8 +++ .../examples/storage/get-file-preview.md | 19 +++++++ .../examples/storage/get-file-view.md | 8 +++ .../examples/storage/get-file.md | 18 ++++++ .../examples/storage/list-buckets.md | 22 +++++++ .../examples/storage/list-files.md | 22 +++++++ .../examples/storage/update-bucket.md | 27 +++++++++ .../examples/storage/update-file.md | 20 +++++++ .../examples/teams/create-membership.md | 25 ++++++++ .../server-graphql/examples/teams/create.md | 16 ++++++ .../examples/teams/delete-membership.md | 8 +++ .../server-graphql/examples/teams/delete.md | 7 +++ .../examples/teams/get-membership.md | 20 +++++++ .../examples/teams/get-prefs.md | 7 +++ .../server-graphql/examples/teams/get.md | 14 +++++ .../examples/teams/list-memberships.md | 24 ++++++++ .../server-graphql/examples/teams/list.md | 18 ++++++ .../teams/update-membership-status.md | 22 +++++++ .../examples/teams/update-membership.md | 21 +++++++ .../examples/teams/update-name.md | 15 +++++ .../examples/teams/update-prefs.md | 8 +++ .../examples/users/create-argon2user.md | 39 +++++++++++++ .../examples/users/create-bcrypt-user.md | 39 +++++++++++++ .../examples/users/create-j-w-t.md | 9 +++ .../examples/users/create-m-d5user.md | 39 +++++++++++++ .../users/create-mfa-recovery-codes.md | 7 +++ .../examples/users/create-p-h-pass-user.md | 39 +++++++++++++ .../examples/users/create-s-h-a-user.md | 40 +++++++++++++ .../users/create-scrypt-modified-user.md | 42 ++++++++++++++ .../examples/users/create-scrypt-user.md | 44 ++++++++++++++ .../examples/users/create-session.md | 35 ++++++++++++ .../examples/users/create-target.md | 19 +++++++ .../examples/users/create-token.md | 14 +++++ .../server-graphql/examples/users/create.md | 40 +++++++++++++ .../examples/users/delete-identity.md | 7 +++ .../users/delete-mfa-authenticator.md | 37 ++++++++++++ .../examples/users/delete-session.md | 8 +++ .../examples/users/delete-sessions.md | 7 +++ .../examples/users/delete-target.md | 8 +++ .../server-graphql/examples/users/delete.md | 7 +++ .../examples/users/get-mfa-recovery-codes.md | 7 +++ .../examples/users/get-prefs.md | 7 +++ .../examples/users/get-target.md | 15 +++++ .../server-graphql/examples/users/get.md | 36 ++++++++++++ .../examples/users/list-identities.md | 20 +++++++ .../examples/users/list-logs.md | 31 ++++++++++ .../examples/users/list-memberships.md | 22 +++++++ .../examples/users/list-mfa-factors.md | 10 ++++ .../examples/users/list-sessions.md | 38 +++++++++++++ .../examples/users/list-targets.md | 18 ++++++ .../server-graphql/examples/users/list.md | 40 +++++++++++++ .../users/update-email-verification.md | 37 ++++++++++++ .../examples/users/update-email.md | 37 ++++++++++++ .../examples/users/update-labels.md | 37 ++++++++++++ .../users/update-mfa-recovery-codes.md | 7 +++ .../examples/users/update-mfa.md | 37 ++++++++++++ .../examples/users/update-name.md | 37 ++++++++++++ .../examples/users/update-password.md | 37 ++++++++++++ .../users/update-phone-verification.md | 37 ++++++++++++ .../examples/users/update-phone.md | 37 ++++++++++++ .../examples/users/update-prefs.md | 8 +++ .../examples/users/update-status.md | 37 ++++++++++++ .../examples/users/update-target.md | 18 ++++++ .../java/account/create-anonymous-session.md | 18 ++++++ .../account/create-email-password-session.md | 23 ++++++++ .../java/account/create-email-token.md | 24 ++++++++ .../java/account/create-j-w-t.md | 18 ++++++ .../java/account/create-magic-u-r-l-token.md | 25 ++++++++ .../java/account/create-mfa-authenticator.md | 24 ++++++++ .../java/account/create-mfa-challenge.md | 23 ++++++++ .../java/account/create-mfa-recovery-codes.md | 19 +++++++ .../java/account/create-o-auth2token.md | 26 +++++++++ .../java/account/create-phone-token.md | 23 ++++++++ .../java/account/create-phone-verification.md | 19 +++++++ .../java/account/create-recovery.md | 24 ++++++++ .../java/account/create-session.md | 23 ++++++++ .../java/account/create-verification.md | 23 ++++++++ .../server-kotlin/java/account/create.md | 25 ++++++++ .../java/account/delete-identity.md | 23 ++++++++ .../java/account/delete-mfa-authenticator.md | 24 ++++++++ .../java/account/delete-session.md | 23 ++++++++ .../java/account/delete-sessions.md | 19 +++++++ .../java/account/get-mfa-recovery-codes.md | 19 +++++++ .../server-kotlin/java/account/get-prefs.md | 19 +++++++ .../server-kotlin/java/account/get-session.md | 23 ++++++++ .../1.6.x/server-kotlin/java/account/get.md | 19 +++++++ .../java/account/list-identities.md | 23 ++++++++ .../server-kotlin/java/account/list-logs.md | 23 ++++++++ .../java/account/list-mfa-factors.md | 19 +++++++ .../java/account/list-sessions.md | 19 +++++++ .../java/account/update-email.md | 24 ++++++++ .../java/account/update-m-f-a.md | 23 ++++++++ .../account/update-magic-u-r-l-session.md | 23 ++++++++ .../java/account/update-mfa-authenticator.md | 25 ++++++++ .../java/account/update-mfa-challenge.md | 24 ++++++++ .../java/account/update-mfa-recovery-codes.md | 19 +++++++ .../server-kotlin/java/account/update-name.md | 23 ++++++++ .../java/account/update-password.md | 24 ++++++++ .../java/account/update-phone-session.md | 23 ++++++++ .../java/account/update-phone-verification.md | 24 ++++++++ .../java/account/update-phone.md | 24 ++++++++ .../java/account/update-prefs.md | 23 ++++++++ .../java/account/update-recovery.md | 25 ++++++++ .../java/account/update-session.md | 23 ++++++++ .../java/account/update-status.md | 19 +++++++ .../java/account/update-verification.md | 24 ++++++++ .../server-kotlin/java/avatars/get-browser.md | 27 +++++++++ .../java/avatars/get-credit-card.md | 27 +++++++++ .../server-kotlin/java/avatars/get-favicon.md | 23 ++++++++ .../server-kotlin/java/avatars/get-flag.md | 27 +++++++++ .../server-kotlin/java/avatars/get-image.md | 25 ++++++++ .../java/avatars/get-initials.md | 26 +++++++++ .../server-kotlin/java/avatars/get-q-r.md | 26 +++++++++ .../databases/create-boolean-attribute.md | 28 +++++++++ .../java/databases/create-collection.md | 28 +++++++++ .../databases/create-datetime-attribute.md | 28 +++++++++ .../java/databases/create-document.md | 27 +++++++++ .../java/databases/create-email-attribute.md | 28 +++++++++ .../java/databases/create-enum-attribute.md | 29 ++++++++++ .../java/databases/create-float-attribute.md | 30 ++++++++++ .../java/databases/create-index.md | 29 ++++++++++ .../databases/create-integer-attribute.md | 30 ++++++++++ .../java/databases/create-ip-attribute.md | 28 +++++++++ .../create-relationship-attribute.md | 31 ++++++++++ .../java/databases/create-string-attribute.md | 30 ++++++++++ .../java/databases/create-url-attribute.md | 28 +++++++++ .../server-kotlin/java/databases/create.md | 25 ++++++++ .../java/databases/delete-attribute.md | 25 ++++++++ .../java/databases/delete-collection.md | 24 ++++++++ .../java/databases/delete-document.md | 25 ++++++++ .../java/databases/delete-index.md | 25 ++++++++ .../server-kotlin/java/databases/delete.md | 23 ++++++++ .../java/databases/get-attribute.md | 25 ++++++++ .../java/databases/get-collection.md | 24 ++++++++ .../java/databases/get-document.md | 26 +++++++++ .../server-kotlin/java/databases/get-index.md | 25 ++++++++ .../1.6.x/server-kotlin/java/databases/get.md | 23 ++++++++ .../java/databases/list-attributes.md | 25 ++++++++ .../java/databases/list-collections.md | 25 ++++++++ .../java/databases/list-documents.md | 25 ++++++++ .../java/databases/list-indexes.md | 25 ++++++++ .../server-kotlin/java/databases/list.md | 24 ++++++++ .../databases/update-boolean-attribute.md | 27 +++++++++ .../java/databases/update-collection.md | 28 +++++++++ .../databases/update-datetime-attribute.md | 27 +++++++++ .../java/databases/update-document.md | 27 +++++++++ .../java/databases/update-email-attribute.md | 27 +++++++++ .../java/databases/update-enum-attribute.md | 28 +++++++++ .../java/databases/update-float-attribute.md | 29 ++++++++++ .../databases/update-integer-attribute.md | 29 ++++++++++ .../java/databases/update-ip-attribute.md | 27 +++++++++ .../update-relationship-attribute.md | 26 +++++++++ .../java/databases/update-string-attribute.md | 27 +++++++++ .../java/databases/update-url-attribute.md | 27 +++++++++ .../server-kotlin/java/databases/update.md | 25 ++++++++ .../java/functions/create-build.md | 25 ++++++++ .../java/functions/create-deployment.md | 28 +++++++++ .../java/functions/create-execution.md | 29 ++++++++++ .../java/functions/create-variable.md | 25 ++++++++ .../server-kotlin/java/functions/create.md | 44 ++++++++++++++ .../java/functions/delete-deployment.md | 24 ++++++++ .../java/functions/delete-execution.md | 24 ++++++++ .../java/functions/delete-variable.md | 24 ++++++++ .../server-kotlin/java/functions/delete.md | 23 ++++++++ .../java/functions/download-deployment.md | 24 ++++++++ .../java/functions/get-deployment.md | 24 ++++++++ .../java/functions/get-execution.md | 24 ++++++++ .../java/functions/get-variable.md | 24 ++++++++ .../1.6.x/server-kotlin/java/functions/get.md | 23 ++++++++ .../java/functions/list-deployments.md | 25 ++++++++ .../java/functions/list-executions.md | 25 ++++++++ .../java/functions/list-runtimes.md | 19 +++++++ .../java/functions/list-variables.md | 23 ++++++++ .../server-kotlin/java/functions/list.md | 24 ++++++++ .../java/functions/update-deployment-build.md | 24 ++++++++ .../java/functions/update-deployment.md | 24 ++++++++ .../java/functions/update-variable.md | 26 +++++++++ .../server-kotlin/java/functions/update.md | 39 +++++++++++++ .../server-kotlin/java/graphql/mutation.md | 23 ++++++++ .../1.6.x/server-kotlin/java/graphql/query.md | 23 ++++++++ .../java/health/get-antivirus.md | 19 +++++++ .../server-kotlin/java/health/get-cache.md | 19 +++++++ .../java/health/get-certificate.md | 23 ++++++++ .../server-kotlin/java/health/get-d-b.md | 19 +++++++ .../java/health/get-failed-jobs.md | 25 ++++++++ .../server-kotlin/java/health/get-pub-sub.md | 19 +++++++ .../java/health/get-queue-builds.md | 23 ++++++++ .../java/health/get-queue-certificates.md | 23 ++++++++ .../java/health/get-queue-databases.md | 24 ++++++++ .../java/health/get-queue-deletes.md | 23 ++++++++ .../java/health/get-queue-functions.md | 23 ++++++++ .../java/health/get-queue-logs.md | 23 ++++++++ .../java/health/get-queue-mails.md | 23 ++++++++ .../java/health/get-queue-messaging.md | 23 ++++++++ .../java/health/get-queue-migrations.md | 23 ++++++++ .../java/health/get-queue-usage-dump.md | 23 ++++++++ .../java/health/get-queue-usage.md | 23 ++++++++ .../java/health/get-queue-webhooks.md | 23 ++++++++ .../server-kotlin/java/health/get-queue.md | 19 +++++++ .../java/health/get-storage-local.md | 19 +++++++ .../server-kotlin/java/health/get-storage.md | 19 +++++++ .../server-kotlin/java/health/get-time.md | 19 +++++++ .../1.6.x/server-kotlin/java/health/get.md | 19 +++++++ .../1.6.x/server-kotlin/java/locale/get.md | 19 +++++++ .../server-kotlin/java/locale/list-codes.md | 19 +++++++ .../java/locale/list-continents.md | 19 +++++++ .../java/locale/list-countries-e-u.md | 19 +++++++ .../java/locale/list-countries-phones.md | 19 +++++++ .../java/locale/list-countries.md | 19 +++++++ .../java/locale/list-currencies.md | 19 +++++++ .../java/locale/list-languages.md | 19 +++++++ .../java/messaging/create-apns-provider.md | 30 ++++++++++ .../java/messaging/create-email.md | 34 +++++++++++ .../java/messaging/create-fcm-provider.md | 26 +++++++++ .../java/messaging/create-mailgun-provider.md | 32 +++++++++++ .../java/messaging/create-msg91provider.md | 28 +++++++++ .../java/messaging/create-push.md | 38 +++++++++++++ .../messaging/create-sendgrid-provider.md | 30 ++++++++++ .../java/messaging/create-sms.md | 29 ++++++++++ .../java/messaging/create-smtp-provider.md | 36 ++++++++++++ .../java/messaging/create-subscriber.md | 25 ++++++++ .../messaging/create-telesign-provider.md | 28 +++++++++ .../messaging/create-textmagic-provider.md | 28 +++++++++ .../java/messaging/create-topic.md | 25 ++++++++ .../java/messaging/create-twilio-provider.md | 28 +++++++++ .../java/messaging/create-vonage-provider.md | 28 +++++++++ .../java/messaging/delete-provider.md | 23 ++++++++ .../java/messaging/delete-subscriber.md | 24 ++++++++ .../java/messaging/delete-topic.md | 23 ++++++++ .../server-kotlin/java/messaging/delete.md | 23 ++++++++ .../java/messaging/get-message.md | 23 ++++++++ .../java/messaging/get-provider.md | 23 ++++++++ .../java/messaging/get-subscriber.md | 24 ++++++++ .../server-kotlin/java/messaging/get-topic.md | 23 ++++++++ .../java/messaging/list-message-logs.md | 24 ++++++++ .../java/messaging/list-messages.md | 24 ++++++++ .../java/messaging/list-provider-logs.md | 24 ++++++++ .../java/messaging/list-providers.md | 24 ++++++++ .../java/messaging/list-subscriber-logs.md | 24 ++++++++ .../java/messaging/list-subscribers.md | 25 ++++++++ .../java/messaging/list-targets.md | 24 ++++++++ .../java/messaging/list-topic-logs.md | 24 ++++++++ .../java/messaging/list-topics.md | 24 ++++++++ .../java/messaging/update-apns-provider.md | 30 ++++++++++ .../java/messaging/update-email.md | 34 +++++++++++ .../java/messaging/update-fcm-provider.md | 26 +++++++++ .../java/messaging/update-mailgun-provider.md | 32 +++++++++++ .../java/messaging/update-msg91provider.md | 28 +++++++++ .../java/messaging/update-push.md | 38 +++++++++++++ .../messaging/update-sendgrid-provider.md | 30 ++++++++++ .../java/messaging/update-sms.md | 29 ++++++++++ .../java/messaging/update-smtp-provider.md | 36 ++++++++++++ .../messaging/update-telesign-provider.md | 28 +++++++++ .../messaging/update-textmagic-provider.md | 28 +++++++++ .../java/messaging/update-topic.md | 25 ++++++++ .../java/messaging/update-twilio-provider.md | 28 +++++++++ .../java/messaging/update-vonage-provider.md | 28 +++++++++ .../java/storage/create-bucket.md | 32 +++++++++++ .../server-kotlin/java/storage/create-file.md | 27 +++++++++ .../java/storage/delete-bucket.md | 23 ++++++++ .../server-kotlin/java/storage/delete-file.md | 24 ++++++++ .../server-kotlin/java/storage/get-bucket.md | 23 ++++++++ .../java/storage/get-file-download.md | 24 ++++++++ .../java/storage/get-file-preview.md | 35 ++++++++++++ .../java/storage/get-file-view.md | 24 ++++++++ .../server-kotlin/java/storage/get-file.md | 24 ++++++++ .../java/storage/list-buckets.md | 24 ++++++++ .../server-kotlin/java/storage/list-files.md | 25 ++++++++ .../java/storage/update-bucket.md | 32 +++++++++++ .../server-kotlin/java/storage/update-file.md | 26 +++++++++ .../java/teams/create-membership.md | 29 ++++++++++ .../1.6.x/server-kotlin/java/teams/create.md | 25 ++++++++ .../java/teams/delete-membership.md | 24 ++++++++ .../1.6.x/server-kotlin/java/teams/delete.md | 23 ++++++++ .../java/teams/get-membership.md | 24 ++++++++ .../server-kotlin/java/teams/get-prefs.md | 23 ++++++++ .../1.6.x/server-kotlin/java/teams/get.md | 23 ++++++++ .../java/teams/list-memberships.md | 25 ++++++++ .../1.6.x/server-kotlin/java/teams/list.md | 24 ++++++++ .../java/teams/update-membership-status.md | 26 +++++++++ .../java/teams/update-membership.md | 25 ++++++++ .../server-kotlin/java/teams/update-name.md | 24 ++++++++ .../server-kotlin/java/teams/update-prefs.md | 24 ++++++++ .../java/users/create-argon2user.md | 26 +++++++++ .../java/users/create-bcrypt-user.md | 26 +++++++++ .../server-kotlin/java/users/create-j-w-t.md | 25 ++++++++ .../java/users/create-m-d5user.md | 26 +++++++++ .../java/users/create-mfa-recovery-codes.md | 23 ++++++++ .../java/users/create-p-h-pass-user.md | 26 +++++++++ .../java/users/create-s-h-a-user.md | 27 +++++++++ .../java/users/create-scrypt-modified-user.md | 29 ++++++++++ .../java/users/create-scrypt-user.md | 31 ++++++++++ .../java/users/create-session.md | 23 ++++++++ .../server-kotlin/java/users/create-target.md | 29 ++++++++++ .../server-kotlin/java/users/create-token.md | 25 ++++++++ .../1.6.x/server-kotlin/java/users/create.md | 27 +++++++++ .../java/users/delete-identity.md | 23 ++++++++ .../java/users/delete-mfa-authenticator.md | 25 ++++++++ .../java/users/delete-session.md | 24 ++++++++ .../java/users/delete-sessions.md | 23 ++++++++ .../server-kotlin/java/users/delete-target.md | 24 ++++++++ .../1.6.x/server-kotlin/java/users/delete.md | 23 ++++++++ .../java/users/get-mfa-recovery-codes.md | 23 ++++++++ .../server-kotlin/java/users/get-prefs.md | 23 ++++++++ .../server-kotlin/java/users/get-target.md | 24 ++++++++ .../1.6.x/server-kotlin/java/users/get.md | 23 ++++++++ .../java/users/list-identities.md | 24 ++++++++ .../server-kotlin/java/users/list-logs.md | 24 ++++++++ .../java/users/list-memberships.md | 23 ++++++++ .../java/users/list-mfa-factors.md | 23 ++++++++ .../server-kotlin/java/users/list-sessions.md | 23 ++++++++ .../server-kotlin/java/users/list-targets.md | 24 ++++++++ .../1.6.x/server-kotlin/java/users/list.md | 24 ++++++++ .../java/users/update-email-verification.md | 24 ++++++++ .../server-kotlin/java/users/update-email.md | 24 ++++++++ .../server-kotlin/java/users/update-labels.md | 24 ++++++++ .../java/users/update-mfa-recovery-codes.md | 23 ++++++++ .../server-kotlin/java/users/update-mfa.md | 24 ++++++++ .../server-kotlin/java/users/update-name.md | 24 ++++++++ .../java/users/update-password.md | 24 ++++++++ .../java/users/update-phone-verification.md | 24 ++++++++ .../server-kotlin/java/users/update-phone.md | 24 ++++++++ .../server-kotlin/java/users/update-prefs.md | 24 ++++++++ .../server-kotlin/java/users/update-status.md | 24 ++++++++ .../server-kotlin/java/users/update-target.md | 27 +++++++++ .../account/create-anonymous-session.md | 11 ++++ .../account/create-email-password-session.md | 14 +++++ .../kotlin/account/create-email-token.md | 15 +++++ .../kotlin/account/create-j-w-t.md | 11 ++++ .../account/create-magic-u-r-l-token.md | 16 ++++++ .../account/create-mfa-authenticator.md | 15 +++++ .../kotlin/account/create-mfa-challenge.md | 14 +++++ .../account/create-mfa-recovery-codes.md | 12 ++++ .../kotlin/account/create-o-auth2token.md | 17 ++++++ .../kotlin/account/create-phone-token.md | 14 +++++ .../account/create-phone-verification.md | 12 ++++ .../kotlin/account/create-recovery.md | 15 +++++ .../kotlin/account/create-session.md | 14 +++++ .../kotlin/account/create-verification.md | 14 +++++ .../server-kotlin/kotlin/account/create.md | 16 ++++++ .../kotlin/account/delete-identity.md | 14 +++++ .../account/delete-mfa-authenticator.md | 15 +++++ .../kotlin/account/delete-session.md | 14 +++++ .../kotlin/account/delete-sessions.md | 12 ++++ .../kotlin/account/get-mfa-recovery-codes.md | 12 ++++ .../server-kotlin/kotlin/account/get-prefs.md | 12 ++++ .../kotlin/account/get-session.md | 14 +++++ .../1.6.x/server-kotlin/kotlin/account/get.md | 12 ++++ .../kotlin/account/list-identities.md | 14 +++++ .../server-kotlin/kotlin/account/list-logs.md | 14 +++++ .../kotlin/account/list-mfa-factors.md | 12 ++++ .../kotlin/account/list-sessions.md | 12 ++++ .../kotlin/account/update-email.md | 15 +++++ .../kotlin/account/update-m-f-a.md | 14 +++++ .../account/update-magic-u-r-l-session.md | 14 +++++ .../account/update-mfa-authenticator.md | 16 ++++++ .../kotlin/account/update-mfa-challenge.md | 15 +++++ .../account/update-mfa-recovery-codes.md | 12 ++++ .../kotlin/account/update-name.md | 14 +++++ .../kotlin/account/update-password.md | 15 +++++ .../kotlin/account/update-phone-session.md | 14 +++++ .../account/update-phone-verification.md | 15 +++++ .../kotlin/account/update-phone.md | 15 +++++ .../kotlin/account/update-prefs.md | 14 +++++ .../kotlin/account/update-recovery.md | 16 ++++++ .../kotlin/account/update-session.md | 14 +++++ .../kotlin/account/update-status.md | 12 ++++ .../kotlin/account/update-verification.md | 15 +++++ .../kotlin/avatars/get-browser.md | 18 ++++++ .../kotlin/avatars/get-credit-card.md | 18 ++++++ .../kotlin/avatars/get-favicon.md | 14 +++++ .../server-kotlin/kotlin/avatars/get-flag.md | 18 ++++++ .../server-kotlin/kotlin/avatars/get-image.md | 16 ++++++ .../kotlin/avatars/get-initials.md | 17 ++++++ .../server-kotlin/kotlin/avatars/get-q-r.md | 17 ++++++ .../databases/create-boolean-attribute.md | 19 +++++++ .../kotlin/databases/create-collection.md | 19 +++++++ .../databases/create-datetime-attribute.md | 19 +++++++ .../kotlin/databases/create-document.md | 18 ++++++ .../databases/create-email-attribute.md | 19 +++++++ .../kotlin/databases/create-enum-attribute.md | 20 +++++++ .../databases/create-float-attribute.md | 21 +++++++ .../kotlin/databases/create-index.md | 20 +++++++ .../databases/create-integer-attribute.md | 21 +++++++ .../kotlin/databases/create-ip-attribute.md | 19 +++++++ .../create-relationship-attribute.md | 22 +++++++ .../databases/create-string-attribute.md | 21 +++++++ .../kotlin/databases/create-url-attribute.md | 19 +++++++ .../server-kotlin/kotlin/databases/create.md | 16 ++++++ .../kotlin/databases/delete-attribute.md | 16 ++++++ .../kotlin/databases/delete-collection.md | 15 +++++ .../kotlin/databases/delete-document.md | 16 ++++++ .../kotlin/databases/delete-index.md | 16 ++++++ .../server-kotlin/kotlin/databases/delete.md | 14 +++++ .../kotlin/databases/get-attribute.md | 16 ++++++ .../kotlin/databases/get-collection.md | 15 +++++ .../kotlin/databases/get-document.md | 17 ++++++ .../kotlin/databases/get-index.md | 16 ++++++ .../server-kotlin/kotlin/databases/get.md | 14 +++++ .../kotlin/databases/list-attributes.md | 16 ++++++ .../kotlin/databases/list-collections.md | 16 ++++++ .../kotlin/databases/list-documents.md | 16 ++++++ .../kotlin/databases/list-indexes.md | 16 ++++++ .../server-kotlin/kotlin/databases/list.md | 15 +++++ .../databases/update-boolean-attribute.md | 18 ++++++ .../kotlin/databases/update-collection.md | 19 +++++++ .../databases/update-datetime-attribute.md | 18 ++++++ .../kotlin/databases/update-document.md | 18 ++++++ .../databases/update-email-attribute.md | 18 ++++++ .../kotlin/databases/update-enum-attribute.md | 19 +++++++ .../databases/update-float-attribute.md | 20 +++++++ .../databases/update-integer-attribute.md | 20 +++++++ .../kotlin/databases/update-ip-attribute.md | 18 ++++++ .../update-relationship-attribute.md | 17 ++++++ .../databases/update-string-attribute.md | 18 ++++++ .../kotlin/databases/update-url-attribute.md | 18 ++++++ .../server-kotlin/kotlin/databases/update.md | 16 ++++++ .../kotlin/functions/create-build.md | 16 ++++++ .../kotlin/functions/create-deployment.md | 19 +++++++ .../kotlin/functions/create-execution.md | 20 +++++++ .../kotlin/functions/create-variable.md | 16 ++++++ .../server-kotlin/kotlin/functions/create.md | 35 ++++++++++++ .../kotlin/functions/delete-deployment.md | 15 +++++ .../kotlin/functions/delete-execution.md | 15 +++++ .../kotlin/functions/delete-variable.md | 15 +++++ .../server-kotlin/kotlin/functions/delete.md | 14 +++++ .../kotlin/functions/download-deployment.md | 15 +++++ .../kotlin/functions/get-deployment.md | 15 +++++ .../kotlin/functions/get-execution.md | 15 +++++ .../kotlin/functions/get-variable.md | 15 +++++ .../server-kotlin/kotlin/functions/get.md | 14 +++++ .../kotlin/functions/list-deployments.md | 16 ++++++ .../kotlin/functions/list-executions.md | 16 ++++++ .../kotlin/functions/list-runtimes.md | 12 ++++ .../kotlin/functions/list-variables.md | 14 +++++ .../server-kotlin/kotlin/functions/list.md | 15 +++++ .../functions/update-deployment-build.md | 15 +++++ .../kotlin/functions/update-deployment.md | 15 +++++ .../kotlin/functions/update-variable.md | 17 ++++++ .../server-kotlin/kotlin/functions/update.md | 30 ++++++++++ .../server-kotlin/kotlin/graphql/mutation.md | 14 +++++ .../server-kotlin/kotlin/graphql/query.md | 14 +++++ .../kotlin/health/get-antivirus.md | 12 ++++ .../server-kotlin/kotlin/health/get-cache.md | 12 ++++ .../kotlin/health/get-certificate.md | 14 +++++ .../server-kotlin/kotlin/health/get-d-b.md | 12 ++++ .../kotlin/health/get-failed-jobs.md | 16 ++++++ .../kotlin/health/get-pub-sub.md | 12 ++++ .../kotlin/health/get-queue-builds.md | 14 +++++ .../kotlin/health/get-queue-certificates.md | 14 +++++ .../kotlin/health/get-queue-databases.md | 15 +++++ .../kotlin/health/get-queue-deletes.md | 14 +++++ .../kotlin/health/get-queue-functions.md | 14 +++++ .../kotlin/health/get-queue-logs.md | 14 +++++ .../kotlin/health/get-queue-mails.md | 14 +++++ .../kotlin/health/get-queue-messaging.md | 14 +++++ .../kotlin/health/get-queue-migrations.md | 14 +++++ .../kotlin/health/get-queue-usage-dump.md | 14 +++++ .../kotlin/health/get-queue-usage.md | 14 +++++ .../kotlin/health/get-queue-webhooks.md | 14 +++++ .../server-kotlin/kotlin/health/get-queue.md | 12 ++++ .../kotlin/health/get-storage-local.md | 12 ++++ .../kotlin/health/get-storage.md | 12 ++++ .../server-kotlin/kotlin/health/get-time.md | 12 ++++ .../1.6.x/server-kotlin/kotlin/health/get.md | 12 ++++ .../1.6.x/server-kotlin/kotlin/locale/get.md | 12 ++++ .../server-kotlin/kotlin/locale/list-codes.md | 12 ++++ .../kotlin/locale/list-continents.md | 12 ++++ .../kotlin/locale/list-countries-e-u.md | 12 ++++ .../kotlin/locale/list-countries-phones.md | 12 ++++ .../kotlin/locale/list-countries.md | 12 ++++ .../kotlin/locale/list-currencies.md | 12 ++++ .../kotlin/locale/list-languages.md | 12 ++++ .../kotlin/messaging/create-apns-provider.md | 21 +++++++ .../kotlin/messaging/create-email.md | 25 ++++++++ .../kotlin/messaging/create-fcm-provider.md | 17 ++++++ .../messaging/create-mailgun-provider.md | 23 ++++++++ .../kotlin/messaging/create-msg91provider.md | 19 +++++++ .../kotlin/messaging/create-push.md | 29 ++++++++++ .../messaging/create-sendgrid-provider.md | 21 +++++++ .../kotlin/messaging/create-sms.md | 20 +++++++ .../kotlin/messaging/create-smtp-provider.md | 27 +++++++++ .../kotlin/messaging/create-subscriber.md | 16 ++++++ .../messaging/create-telesign-provider.md | 19 +++++++ .../messaging/create-textmagic-provider.md | 19 +++++++ .../kotlin/messaging/create-topic.md | 16 ++++++ .../messaging/create-twilio-provider.md | 19 +++++++ .../messaging/create-vonage-provider.md | 19 +++++++ .../kotlin/messaging/delete-provider.md | 14 +++++ .../kotlin/messaging/delete-subscriber.md | 15 +++++ .../kotlin/messaging/delete-topic.md | 14 +++++ .../server-kotlin/kotlin/messaging/delete.md | 14 +++++ .../kotlin/messaging/get-message.md | 14 +++++ .../kotlin/messaging/get-provider.md | 14 +++++ .../kotlin/messaging/get-subscriber.md | 15 +++++ .../kotlin/messaging/get-topic.md | 14 +++++ .../kotlin/messaging/list-message-logs.md | 15 +++++ .../kotlin/messaging/list-messages.md | 15 +++++ .../kotlin/messaging/list-provider-logs.md | 15 +++++ .../kotlin/messaging/list-providers.md | 15 +++++ .../kotlin/messaging/list-subscriber-logs.md | 15 +++++ .../kotlin/messaging/list-subscribers.md | 16 ++++++ .../kotlin/messaging/list-targets.md | 15 +++++ .../kotlin/messaging/list-topic-logs.md | 15 +++++ .../kotlin/messaging/list-topics.md | 15 +++++ .../kotlin/messaging/update-apns-provider.md | 21 +++++++ .../kotlin/messaging/update-email.md | 25 ++++++++ .../kotlin/messaging/update-fcm-provider.md | 17 ++++++ .../messaging/update-mailgun-provider.md | 23 ++++++++ .../kotlin/messaging/update-msg91provider.md | 19 +++++++ .../kotlin/messaging/update-push.md | 29 ++++++++++ .../messaging/update-sendgrid-provider.md | 21 +++++++ .../kotlin/messaging/update-sms.md | 20 +++++++ .../kotlin/messaging/update-smtp-provider.md | 27 +++++++++ .../messaging/update-telesign-provider.md | 19 +++++++ .../messaging/update-textmagic-provider.md | 19 +++++++ .../kotlin/messaging/update-topic.md | 16 ++++++ .../messaging/update-twilio-provider.md | 19 +++++++ .../messaging/update-vonage-provider.md | 19 +++++++ .../kotlin/storage/create-bucket.md | 23 ++++++++ .../kotlin/storage/create-file.md | 18 ++++++ .../kotlin/storage/delete-bucket.md | 14 +++++ .../kotlin/storage/delete-file.md | 15 +++++ .../kotlin/storage/get-bucket.md | 14 +++++ .../kotlin/storage/get-file-download.md | 15 +++++ .../kotlin/storage/get-file-preview.md | 26 +++++++++ .../kotlin/storage/get-file-view.md | 15 +++++ .../server-kotlin/kotlin/storage/get-file.md | 15 +++++ .../kotlin/storage/list-buckets.md | 15 +++++ .../kotlin/storage/list-files.md | 16 ++++++ .../kotlin/storage/update-bucket.md | 23 ++++++++ .../kotlin/storage/update-file.md | 17 ++++++ .../kotlin/teams/create-membership.md | 20 +++++++ .../server-kotlin/kotlin/teams/create.md | 16 ++++++ .../kotlin/teams/delete-membership.md | 15 +++++ .../server-kotlin/kotlin/teams/delete.md | 14 +++++ .../kotlin/teams/get-membership.md | 15 +++++ .../server-kotlin/kotlin/teams/get-prefs.md | 14 +++++ .../1.6.x/server-kotlin/kotlin/teams/get.md | 14 +++++ .../kotlin/teams/list-memberships.md | 16 ++++++ .../1.6.x/server-kotlin/kotlin/teams/list.md | 15 +++++ .../kotlin/teams/update-membership-status.md | 17 ++++++ .../kotlin/teams/update-membership.md | 16 ++++++ .../server-kotlin/kotlin/teams/update-name.md | 15 +++++ .../kotlin/teams/update-prefs.md | 15 +++++ .../kotlin/users/create-argon2user.md | 17 ++++++ .../kotlin/users/create-bcrypt-user.md | 17 ++++++ .../kotlin/users/create-j-w-t.md | 16 ++++++ .../kotlin/users/create-m-d5user.md | 17 ++++++ .../kotlin/users/create-mfa-recovery-codes.md | 14 +++++ .../kotlin/users/create-p-h-pass-user.md | 17 ++++++ .../kotlin/users/create-s-h-a-user.md | 18 ++++++ .../users/create-scrypt-modified-user.md | 20 +++++++ .../kotlin/users/create-scrypt-user.md | 22 +++++++ .../kotlin/users/create-session.md | 14 +++++ .../kotlin/users/create-target.md | 20 +++++++ .../kotlin/users/create-token.md | 16 ++++++ .../server-kotlin/kotlin/users/create.md | 18 ++++++ .../kotlin/users/delete-identity.md | 14 +++++ .../kotlin/users/delete-mfa-authenticator.md | 16 ++++++ .../kotlin/users/delete-session.md | 15 +++++ .../kotlin/users/delete-sessions.md | 14 +++++ .../kotlin/users/delete-target.md | 15 +++++ .../server-kotlin/kotlin/users/delete.md | 14 +++++ .../kotlin/users/get-mfa-recovery-codes.md | 14 +++++ .../server-kotlin/kotlin/users/get-prefs.md | 14 +++++ .../server-kotlin/kotlin/users/get-target.md | 15 +++++ .../1.6.x/server-kotlin/kotlin/users/get.md | 14 +++++ .../kotlin/users/list-identities.md | 15 +++++ .../server-kotlin/kotlin/users/list-logs.md | 15 +++++ .../kotlin/users/list-memberships.md | 14 +++++ .../kotlin/users/list-mfa-factors.md | 14 +++++ .../kotlin/users/list-sessions.md | 14 +++++ .../kotlin/users/list-targets.md | 15 +++++ .../1.6.x/server-kotlin/kotlin/users/list.md | 15 +++++ .../kotlin/users/update-email-verification.md | 15 +++++ .../kotlin/users/update-email.md | 15 +++++ .../kotlin/users/update-labels.md | 15 +++++ .../kotlin/users/update-mfa-recovery-codes.md | 14 +++++ .../server-kotlin/kotlin/users/update-mfa.md | 15 +++++ .../server-kotlin/kotlin/users/update-name.md | 15 +++++ .../kotlin/users/update-password.md | 15 +++++ .../kotlin/users/update-phone-verification.md | 15 +++++ .../kotlin/users/update-phone.md | 15 +++++ .../kotlin/users/update-prefs.md | 15 +++++ .../kotlin/users/update-status.md | 15 +++++ .../kotlin/users/update-target.md | 18 ++++++ .../account/create-anonymous-session.md | 9 +++ .../account/create-email-password-session.md | 12 ++++ .../examples/account/create-email-token.md | 13 +++++ .../examples/account/create-j-w-t.md | 9 +++ .../account/create-magic-u-r-l-token.md | 14 +++++ .../account/create-mfa-authenticator.md | 12 ++++ .../examples/account/create-mfa-challenge.md | 11 ++++ .../account/create-mfa-recovery-codes.md | 10 ++++ .../examples/account/create-o-auth2token.md | 14 +++++ .../examples/account/create-phone-token.md | 12 ++++ .../account/create-phone-verification.md | 10 ++++ .../examples/account/create-recovery.md | 13 +++++ .../examples/account/create-session.md | 12 ++++ .../examples/account/create-verification.md | 12 ++++ .../server-nodejs/examples/account/create.md | 14 +++++ .../examples/account/delete-identity.md | 12 ++++ .../account/delete-mfa-authenticator.md | 12 ++++ .../examples/account/delete-session.md | 12 ++++ .../examples/account/delete-sessions.md | 10 ++++ .../account/get-mfa-recovery-codes.md | 10 ++++ .../examples/account/get-prefs.md | 10 ++++ .../examples/account/get-session.md | 12 ++++ .../server-nodejs/examples/account/get.md | 10 ++++ .../examples/account/list-identities.md | 12 ++++ .../examples/account/list-logs.md | 12 ++++ .../examples/account/list-mfa-factors.md | 10 ++++ .../examples/account/list-sessions.md | 10 ++++ .../examples/account/update-email.md | 13 +++++ .../examples/account/update-m-f-a.md | 12 ++++ .../account/update-magic-u-r-l-session.md | 12 ++++ .../account/update-mfa-authenticator.md | 13 +++++ .../examples/account/update-mfa-challenge.md | 13 +++++ .../account/update-mfa-recovery-codes.md | 10 ++++ .../examples/account/update-name.md | 12 ++++ .../examples/account/update-password.md | 13 +++++ .../examples/account/update-phone-session.md | 12 ++++ .../account/update-phone-verification.md | 13 +++++ .../examples/account/update-phone.md | 13 +++++ .../examples/account/update-prefs.md | 12 ++++ .../examples/account/update-recovery.md | 14 +++++ .../examples/account/update-session.md | 12 ++++ .../examples/account/update-status.md | 10 ++++ .../examples/account/update-verification.md | 13 +++++ .../examples/avatars/get-browser.md | 15 +++++ .../examples/avatars/get-credit-card.md | 15 +++++ .../examples/avatars/get-favicon.md | 12 ++++ .../examples/avatars/get-flag.md | 15 +++++ .../examples/avatars/get-image.md | 14 +++++ .../examples/avatars/get-initials.md | 15 +++++ .../server-nodejs/examples/avatars/get-q-r.md | 15 +++++ .../databases/create-boolean-attribute.md | 17 ++++++ .../examples/databases/create-collection.md | 17 ++++++ .../databases/create-datetime-attribute.md | 17 ++++++ .../examples/databases/create-document.md | 16 ++++++ .../databases/create-email-attribute.md | 17 ++++++ .../databases/create-enum-attribute.md | 18 ++++++ .../databases/create-float-attribute.md | 19 +++++++ .../examples/databases/create-index.md | 17 ++++++ .../databases/create-integer-attribute.md | 19 +++++++ .../examples/databases/create-ip-attribute.md | 17 ++++++ .../create-relationship-attribute.md | 19 +++++++ .../databases/create-string-attribute.md | 19 +++++++ .../databases/create-url-attribute.md | 17 ++++++ .../examples/databases/create.md | 14 +++++ .../examples/databases/delete-attribute.md | 14 +++++ .../examples/databases/delete-collection.md | 13 +++++ .../examples/databases/delete-document.md | 14 +++++ .../examples/databases/delete-index.md | 14 +++++ .../examples/databases/delete.md | 12 ++++ .../examples/databases/get-attribute.md | 14 +++++ .../examples/databases/get-collection.md | 13 +++++ .../examples/databases/get-document.md | 15 +++++ .../examples/databases/get-index.md | 14 +++++ .../server-nodejs/examples/databases/get.md | 12 ++++ .../examples/databases/list-attributes.md | 14 +++++ .../examples/databases/list-collections.md | 14 +++++ .../examples/databases/list-documents.md | 14 +++++ .../examples/databases/list-indexes.md | 14 +++++ .../server-nodejs/examples/databases/list.md | 13 +++++ .../databases/update-boolean-attribute.md | 16 ++++++ .../examples/databases/update-collection.md | 17 ++++++ .../databases/update-datetime-attribute.md | 16 ++++++ .../examples/databases/update-document.md | 16 ++++++ .../databases/update-email-attribute.md | 16 ++++++ .../databases/update-enum-attribute.md | 17 ++++++ .../databases/update-float-attribute.md | 18 ++++++ .../databases/update-integer-attribute.md | 18 ++++++ .../examples/databases/update-ip-attribute.md | 16 ++++++ .../update-relationship-attribute.md | 15 +++++ .../databases/update-string-attribute.md | 16 ++++++ .../databases/update-url-attribute.md | 16 ++++++ .../examples/databases/update.md | 14 +++++ .../examples/functions/create-build.md | 14 +++++ .../examples/functions/create-deployment.md | 17 ++++++ .../examples/functions/create-execution.md | 18 ++++++ .../examples/functions/create-variable.md | 14 +++++ .../examples/functions/create.md | 32 +++++++++++ .../examples/functions/delete-deployment.md | 13 +++++ .../examples/functions/delete-execution.md | 13 +++++ .../examples/functions/delete-variable.md | 13 +++++ .../examples/functions/delete.md | 12 ++++ .../examples/functions/download-deployment.md | 13 +++++ .../examples/functions/get-deployment.md | 13 +++++ .../examples/functions/get-execution.md | 13 +++++ .../examples/functions/get-variable.md | 13 +++++ .../server-nodejs/examples/functions/get.md | 12 ++++ .../examples/functions/list-deployments.md | 14 +++++ .../examples/functions/list-executions.md | 14 +++++ .../examples/functions/list-runtimes.md | 10 ++++ .../examples/functions/list-variables.md | 12 ++++ .../server-nodejs/examples/functions/list.md | 13 +++++ .../functions/update-deployment-build.md | 13 +++++ .../examples/functions/update-deployment.md | 13 +++++ .../examples/functions/update-variable.md | 15 +++++ .../examples/functions/update.md | 28 +++++++++ .../examples/graphql/mutation.md | 12 ++++ .../server-nodejs/examples/graphql/query.md | 12 ++++ .../examples/health/get-antivirus.md | 10 ++++ .../examples/health/get-cache.md | 10 ++++ .../examples/health/get-certificate.md | 12 ++++ .../server-nodejs/examples/health/get-d-b.md | 10 ++++ .../examples/health/get-failed-jobs.md | 13 +++++ .../examples/health/get-pub-sub.md | 10 ++++ .../examples/health/get-queue-builds.md | 12 ++++ .../examples/health/get-queue-certificates.md | 12 ++++ .../examples/health/get-queue-databases.md | 13 +++++ .../examples/health/get-queue-deletes.md | 12 ++++ .../examples/health/get-queue-functions.md | 12 ++++ .../examples/health/get-queue-logs.md | 12 ++++ .../examples/health/get-queue-mails.md | 12 ++++ .../examples/health/get-queue-messaging.md | 12 ++++ .../examples/health/get-queue-migrations.md | 12 ++++ .../examples/health/get-queue-usage-dump.md | 12 ++++ .../examples/health/get-queue-usage.md | 12 ++++ .../examples/health/get-queue-webhooks.md | 12 ++++ .../examples/health/get-queue.md | 10 ++++ .../examples/health/get-storage-local.md | 10 ++++ .../examples/health/get-storage.md | 10 ++++ .../server-nodejs/examples/health/get-time.md | 10 ++++ .../server-nodejs/examples/health/get.md | 10 ++++ .../server-nodejs/examples/locale/get.md | 10 ++++ .../examples/locale/list-codes.md | 10 ++++ .../examples/locale/list-continents.md | 10 ++++ .../examples/locale/list-countries-e-u.md | 10 ++++ .../examples/locale/list-countries-phones.md | 10 ++++ .../examples/locale/list-countries.md | 10 ++++ .../examples/locale/list-currencies.md | 10 ++++ .../examples/locale/list-languages.md | 10 ++++ .../messaging/create-apns-provider.md | 19 +++++++ .../examples/messaging/create-email.md | 23 ++++++++ .../examples/messaging/create-fcm-provider.md | 15 +++++ .../messaging/create-mailgun-provider.md | 21 +++++++ .../messaging/create-msg91provider.md | 17 ++++++ .../examples/messaging/create-push.md | 27 +++++++++ .../messaging/create-sendgrid-provider.md | 19 +++++++ .../examples/messaging/create-sms.md | 18 ++++++ .../messaging/create-smtp-provider.md | 25 ++++++++ .../examples/messaging/create-subscriber.md | 14 +++++ .../messaging/create-telesign-provider.md | 17 ++++++ .../messaging/create-textmagic-provider.md | 17 ++++++ .../examples/messaging/create-topic.md | 14 +++++ .../messaging/create-twilio-provider.md | 17 ++++++ .../messaging/create-vonage-provider.md | 17 ++++++ .../examples/messaging/delete-provider.md | 12 ++++ .../examples/messaging/delete-subscriber.md | 13 +++++ .../examples/messaging/delete-topic.md | 12 ++++ .../examples/messaging/delete.md | 12 ++++ .../examples/messaging/get-message.md | 12 ++++ .../examples/messaging/get-provider.md | 12 ++++ .../examples/messaging/get-subscriber.md | 13 +++++ .../examples/messaging/get-topic.md | 12 ++++ .../examples/messaging/list-message-logs.md | 13 +++++ .../examples/messaging/list-messages.md | 13 +++++ .../examples/messaging/list-provider-logs.md | 13 +++++ .../examples/messaging/list-providers.md | 13 +++++ .../messaging/list-subscriber-logs.md | 13 +++++ .../examples/messaging/list-subscribers.md | 14 +++++ .../examples/messaging/list-targets.md | 13 +++++ .../examples/messaging/list-topic-logs.md | 13 +++++ .../examples/messaging/list-topics.md | 13 +++++ .../messaging/update-apns-provider.md | 19 +++++++ .../examples/messaging/update-email.md | 23 ++++++++ .../examples/messaging/update-fcm-provider.md | 15 +++++ .../messaging/update-mailgun-provider.md | 21 +++++++ .../messaging/update-msg91provider.md | 17 ++++++ .../examples/messaging/update-push.md | 27 +++++++++ .../messaging/update-sendgrid-provider.md | 19 +++++++ .../examples/messaging/update-sms.md | 18 ++++++ .../messaging/update-smtp-provider.md | 25 ++++++++ .../messaging/update-telesign-provider.md | 17 ++++++ .../messaging/update-textmagic-provider.md | 17 ++++++ .../examples/messaging/update-topic.md | 14 +++++ .../messaging/update-twilio-provider.md | 17 ++++++ .../messaging/update-vonage-provider.md | 17 ++++++ .../examples/storage/create-bucket.md | 21 +++++++ .../examples/storage/create-file.md | 16 ++++++ .../examples/storage/delete-bucket.md | 12 ++++ .../examples/storage/delete-file.md | 13 +++++ .../examples/storage/get-bucket.md | 12 ++++ .../examples/storage/get-file-download.md | 13 +++++ .../examples/storage/get-file-preview.md | 24 ++++++++ .../examples/storage/get-file-view.md | 13 +++++ .../examples/storage/get-file.md | 13 +++++ .../examples/storage/list-buckets.md | 13 +++++ .../examples/storage/list-files.md | 14 +++++ .../examples/storage/update-bucket.md | 21 +++++++ .../examples/storage/update-file.md | 15 +++++ .../examples/teams/create-membership.md | 18 ++++++ .../server-nodejs/examples/teams/create.md | 14 +++++ .../examples/teams/delete-membership.md | 13 +++++ .../server-nodejs/examples/teams/delete.md | 12 ++++ .../examples/teams/get-membership.md | 13 +++++ .../server-nodejs/examples/teams/get-prefs.md | 12 ++++ .../1.6.x/server-nodejs/examples/teams/get.md | 12 ++++ .../examples/teams/list-memberships.md | 14 +++++ .../server-nodejs/examples/teams/list.md | 13 +++++ .../teams/update-membership-status.md | 15 +++++ .../examples/teams/update-membership.md | 14 +++++ .../examples/teams/update-name.md | 13 +++++ .../examples/teams/update-prefs.md | 13 +++++ .../examples/users/create-argon2user.md | 15 +++++ .../examples/users/create-bcrypt-user.md | 15 +++++ .../examples/users/create-j-w-t.md | 14 +++++ .../examples/users/create-m-d5user.md | 15 +++++ .../users/create-mfa-recovery-codes.md | 12 ++++ .../examples/users/create-p-h-pass-user.md | 15 +++++ .../examples/users/create-s-h-a-user.md | 16 ++++++ .../users/create-scrypt-modified-user.md | 18 ++++++ .../examples/users/create-scrypt-user.md | 20 +++++++ .../examples/users/create-session.md | 12 ++++ .../examples/users/create-target.md | 17 ++++++ .../examples/users/create-token.md | 14 +++++ .../server-nodejs/examples/users/create.md | 16 ++++++ .../examples/users/delete-identity.md | 12 ++++ .../users/delete-mfa-authenticator.md | 13 +++++ .../examples/users/delete-session.md | 13 +++++ .../examples/users/delete-sessions.md | 12 ++++ .../examples/users/delete-target.md | 13 +++++ .../server-nodejs/examples/users/delete.md | 12 ++++ .../examples/users/get-mfa-recovery-codes.md | 12 ++++ .../server-nodejs/examples/users/get-prefs.md | 12 ++++ .../examples/users/get-target.md | 13 +++++ .../1.6.x/server-nodejs/examples/users/get.md | 12 ++++ .../examples/users/list-identities.md | 13 +++++ .../server-nodejs/examples/users/list-logs.md | 13 +++++ .../examples/users/list-memberships.md | 12 ++++ .../examples/users/list-mfa-factors.md | 12 ++++ .../examples/users/list-sessions.md | 12 ++++ .../examples/users/list-targets.md | 13 +++++ .../server-nodejs/examples/users/list.md | 13 +++++ .../users/update-email-verification.md | 13 +++++ .../examples/users/update-email.md | 13 +++++ .../examples/users/update-labels.md | 13 +++++ .../users/update-mfa-recovery-codes.md | 12 ++++ .../examples/users/update-mfa.md | 13 +++++ .../examples/users/update-name.md | 13 +++++ .../examples/users/update-password.md | 13 +++++ .../users/update-phone-verification.md | 13 +++++ .../examples/users/update-phone.md | 13 +++++ .../examples/users/update-prefs.md | 13 +++++ .../examples/users/update-status.md | 13 +++++ .../examples/users/update-target.md | 16 ++++++ .../account/create-anonymous-session.md | 12 ++++ .../account/create-email-password-session.md | 15 +++++ .../examples/account/create-email-token.md | 16 ++++++ .../examples/account/create-j-w-t.md | 12 ++++ .../account/create-magic-u-r-l-token.md | 17 ++++++ .../account/create-mfa-authenticator.md | 16 ++++++ .../examples/account/create-mfa-challenge.md | 15 +++++ .../account/create-mfa-recovery-codes.md | 13 +++++ .../examples/account/create-o-auth2token.md | 18 ++++++ .../examples/account/create-phone-token.md | 15 +++++ .../account/create-phone-verification.md | 13 +++++ .../examples/account/create-recovery.md | 16 ++++++ .../examples/account/create-session.md | 15 +++++ .../examples/account/create-verification.md | 15 +++++ .../server-php/examples/account/create.md | 17 ++++++ .../examples/account/delete-identity.md | 15 +++++ .../account/delete-mfa-authenticator.md | 16 ++++++ .../examples/account/delete-session.md | 15 +++++ .../examples/account/delete-sessions.md | 13 +++++ .../account/get-mfa-recovery-codes.md | 13 +++++ .../server-php/examples/account/get-prefs.md | 13 +++++ .../examples/account/get-session.md | 15 +++++ .../1.6.x/server-php/examples/account/get.md | 13 +++++ .../examples/account/list-identities.md | 15 +++++ .../server-php/examples/account/list-logs.md | 15 +++++ .../examples/account/list-mfa-factors.md | 13 +++++ .../examples/account/list-sessions.md | 13 +++++ .../examples/account/update-email.md | 16 ++++++ .../examples/account/update-m-f-a.md | 15 +++++ .../account/update-magic-u-r-l-session.md | 15 +++++ .../account/update-mfa-authenticator.md | 17 ++++++ .../examples/account/update-mfa-challenge.md | 16 ++++++ .../account/update-mfa-recovery-codes.md | 13 +++++ .../examples/account/update-name.md | 15 +++++ .../examples/account/update-password.md | 16 ++++++ .../examples/account/update-phone-session.md | 15 +++++ .../account/update-phone-verification.md | 16 ++++++ .../examples/account/update-phone.md | 16 ++++++ .../examples/account/update-prefs.md | 15 +++++ .../examples/account/update-recovery.md | 17 ++++++ .../examples/account/update-session.md | 15 +++++ .../examples/account/update-status.md | 13 +++++ .../examples/account/update-verification.md | 16 ++++++ .../examples/avatars/get-browser.md | 19 +++++++ .../examples/avatars/get-credit-card.md | 19 +++++++ .../examples/avatars/get-favicon.md | 15 +++++ .../server-php/examples/avatars/get-flag.md | 19 +++++++ .../server-php/examples/avatars/get-image.md | 17 ++++++ .../examples/avatars/get-initials.md | 18 ++++++ .../server-php/examples/avatars/get-q-r.md | 18 ++++++ .../databases/create-boolean-attribute.md | 20 +++++++ .../examples/databases/create-collection.md | 20 +++++++ .../databases/create-datetime-attribute.md | 20 +++++++ .../examples/databases/create-document.md | 19 +++++++ .../databases/create-email-attribute.md | 20 +++++++ .../databases/create-enum-attribute.md | 21 +++++++ .../databases/create-float-attribute.md | 22 +++++++ .../examples/databases/create-index.md | 21 +++++++ .../databases/create-integer-attribute.md | 22 +++++++ .../examples/databases/create-ip-attribute.md | 20 +++++++ .../create-relationship-attribute.md | 23 ++++++++ .../databases/create-string-attribute.md | 22 +++++++ .../databases/create-url-attribute.md | 20 +++++++ .../server-php/examples/databases/create.md | 17 ++++++ .../examples/databases/delete-attribute.md | 17 ++++++ .../examples/databases/delete-collection.md | 16 ++++++ .../examples/databases/delete-document.md | 17 ++++++ .../examples/databases/delete-index.md | 17 ++++++ .../server-php/examples/databases/delete.md | 15 +++++ .../examples/databases/get-attribute.md | 17 ++++++ .../examples/databases/get-collection.md | 16 ++++++ .../examples/databases/get-document.md | 18 ++++++ .../examples/databases/get-index.md | 17 ++++++ .../server-php/examples/databases/get.md | 15 +++++ .../examples/databases/list-attributes.md | 17 ++++++ .../examples/databases/list-collections.md | 17 ++++++ .../examples/databases/list-documents.md | 17 ++++++ .../examples/databases/list-indexes.md | 17 ++++++ .../server-php/examples/databases/list.md | 16 ++++++ .../databases/update-boolean-attribute.md | 19 +++++++ .../examples/databases/update-collection.md | 20 +++++++ .../databases/update-datetime-attribute.md | 19 +++++++ .../examples/databases/update-document.md | 19 +++++++ .../databases/update-email-attribute.md | 19 +++++++ .../databases/update-enum-attribute.md | 20 +++++++ .../databases/update-float-attribute.md | 21 +++++++ .../databases/update-integer-attribute.md | 21 +++++++ .../examples/databases/update-ip-attribute.md | 19 +++++++ .../update-relationship-attribute.md | 18 ++++++ .../databases/update-string-attribute.md | 19 +++++++ .../databases/update-url-attribute.md | 19 +++++++ .../server-php/examples/databases/update.md | 17 ++++++ .../examples/functions/create-build.md | 17 ++++++ .../examples/functions/create-deployment.md | 20 +++++++ .../examples/functions/create-execution.md | 21 +++++++ .../examples/functions/create-variable.md | 17 ++++++ .../server-php/examples/functions/create.md | 36 ++++++++++++ .../examples/functions/delete-deployment.md | 16 ++++++ .../examples/functions/delete-execution.md | 16 ++++++ .../examples/functions/delete-variable.md | 16 ++++++ .../server-php/examples/functions/delete.md | 15 +++++ .../examples/functions/download-deployment.md | 16 ++++++ .../examples/functions/get-deployment.md | 16 ++++++ .../examples/functions/get-execution.md | 16 ++++++ .../examples/functions/get-variable.md | 16 ++++++ .../server-php/examples/functions/get.md | 15 +++++ .../examples/functions/list-deployments.md | 17 ++++++ .../examples/functions/list-executions.md | 17 ++++++ .../examples/functions/list-runtimes.md | 13 +++++ .../examples/functions/list-variables.md | 15 +++++ .../server-php/examples/functions/list.md | 16 ++++++ .../functions/update-deployment-build.md | 16 ++++++ .../examples/functions/update-deployment.md | 16 ++++++ .../examples/functions/update-variable.md | 18 ++++++ .../server-php/examples/functions/update.md | 31 ++++++++++ .../server-php/examples/graphql/mutation.md | 15 +++++ .../server-php/examples/graphql/query.md | 15 +++++ .../examples/health/get-antivirus.md | 13 +++++ .../server-php/examples/health/get-cache.md | 13 +++++ .../examples/health/get-certificate.md | 15 +++++ .../server-php/examples/health/get-d-b.md | 13 +++++ .../examples/health/get-failed-jobs.md | 17 ++++++ .../server-php/examples/health/get-pub-sub.md | 13 +++++ .../examples/health/get-queue-builds.md | 15 +++++ .../examples/health/get-queue-certificates.md | 15 +++++ .../examples/health/get-queue-databases.md | 16 ++++++ .../examples/health/get-queue-deletes.md | 15 +++++ .../examples/health/get-queue-functions.md | 15 +++++ .../examples/health/get-queue-logs.md | 15 +++++ .../examples/health/get-queue-mails.md | 15 +++++ .../examples/health/get-queue-messaging.md | 15 +++++ .../examples/health/get-queue-migrations.md | 15 +++++ .../examples/health/get-queue-usage-dump.md | 15 +++++ .../examples/health/get-queue-usage.md | 15 +++++ .../examples/health/get-queue-webhooks.md | 15 +++++ .../server-php/examples/health/get-queue.md | 13 +++++ .../examples/health/get-storage-local.md | 13 +++++ .../server-php/examples/health/get-storage.md | 13 +++++ .../server-php/examples/health/get-time.md | 13 +++++ .../1.6.x/server-php/examples/health/get.md | 13 +++++ .../1.6.x/server-php/examples/locale/get.md | 13 +++++ .../server-php/examples/locale/list-codes.md | 13 +++++ .../examples/locale/list-continents.md | 13 +++++ .../examples/locale/list-countries-e-u.md | 13 +++++ .../examples/locale/list-countries-phones.md | 13 +++++ .../examples/locale/list-countries.md | 13 +++++ .../examples/locale/list-currencies.md | 13 +++++ .../examples/locale/list-languages.md | 13 +++++ .../messaging/create-apns-provider.md | 22 +++++++ .../examples/messaging/create-email.md | 26 +++++++++ .../examples/messaging/create-fcm-provider.md | 18 ++++++ .../messaging/create-mailgun-provider.md | 24 ++++++++ .../messaging/create-msg91provider.md | 20 +++++++ .../examples/messaging/create-push.md | 30 ++++++++++ .../messaging/create-sendgrid-provider.md | 22 +++++++ .../examples/messaging/create-sms.md | 21 +++++++ .../messaging/create-smtp-provider.md | 28 +++++++++ .../examples/messaging/create-subscriber.md | 17 ++++++ .../messaging/create-telesign-provider.md | 20 +++++++ .../messaging/create-textmagic-provider.md | 20 +++++++ .../examples/messaging/create-topic.md | 17 ++++++ .../messaging/create-twilio-provider.md | 20 +++++++ .../messaging/create-vonage-provider.md | 20 +++++++ .../examples/messaging/delete-provider.md | 15 +++++ .../examples/messaging/delete-subscriber.md | 16 ++++++ .../examples/messaging/delete-topic.md | 15 +++++ .../server-php/examples/messaging/delete.md | 15 +++++ .../examples/messaging/get-message.md | 15 +++++ .../examples/messaging/get-provider.md | 15 +++++ .../examples/messaging/get-subscriber.md | 16 ++++++ .../examples/messaging/get-topic.md | 15 +++++ .../examples/messaging/list-message-logs.md | 16 ++++++ .../examples/messaging/list-messages.md | 16 ++++++ .../examples/messaging/list-provider-logs.md | 16 ++++++ .../examples/messaging/list-providers.md | 16 ++++++ .../messaging/list-subscriber-logs.md | 16 ++++++ .../examples/messaging/list-subscribers.md | 17 ++++++ .../examples/messaging/list-targets.md | 16 ++++++ .../examples/messaging/list-topic-logs.md | 16 ++++++ .../examples/messaging/list-topics.md | 16 ++++++ .../messaging/update-apns-provider.md | 22 +++++++ .../examples/messaging/update-email.md | 26 +++++++++ .../examples/messaging/update-fcm-provider.md | 18 ++++++ .../messaging/update-mailgun-provider.md | 24 ++++++++ .../messaging/update-msg91provider.md | 20 +++++++ .../examples/messaging/update-push.md | 30 ++++++++++ .../messaging/update-sendgrid-provider.md | 22 +++++++ .../examples/messaging/update-sms.md | 21 +++++++ .../messaging/update-smtp-provider.md | 28 +++++++++ .../messaging/update-telesign-provider.md | 20 +++++++ .../messaging/update-textmagic-provider.md | 20 +++++++ .../examples/messaging/update-topic.md | 17 ++++++ .../messaging/update-twilio-provider.md | 20 +++++++ .../messaging/update-vonage-provider.md | 20 +++++++ .../examples/storage/create-bucket.md | 24 ++++++++ .../examples/storage/create-file.md | 19 +++++++ .../examples/storage/delete-bucket.md | 15 +++++ .../examples/storage/delete-file.md | 16 ++++++ .../server-php/examples/storage/get-bucket.md | 15 +++++ .../examples/storage/get-file-download.md | 16 ++++++ .../examples/storage/get-file-preview.md | 27 +++++++++ .../examples/storage/get-file-view.md | 16 ++++++ .../server-php/examples/storage/get-file.md | 16 ++++++ .../examples/storage/list-buckets.md | 16 ++++++ .../server-php/examples/storage/list-files.md | 17 ++++++ .../examples/storage/update-bucket.md | 24 ++++++++ .../examples/storage/update-file.md | 18 ++++++ .../examples/teams/create-membership.md | 21 +++++++ .../1.6.x/server-php/examples/teams/create.md | 17 ++++++ .../examples/teams/delete-membership.md | 16 ++++++ .../1.6.x/server-php/examples/teams/delete.md | 15 +++++ .../examples/teams/get-membership.md | 16 ++++++ .../server-php/examples/teams/get-prefs.md | 15 +++++ .../1.6.x/server-php/examples/teams/get.md | 15 +++++ .../examples/teams/list-memberships.md | 17 ++++++ .../1.6.x/server-php/examples/teams/list.md | 16 ++++++ .../teams/update-membership-status.md | 18 ++++++ .../examples/teams/update-membership.md | 17 ++++++ .../server-php/examples/teams/update-name.md | 16 ++++++ .../server-php/examples/teams/update-prefs.md | 16 ++++++ .../examples/users/create-argon2user.md | 18 ++++++ .../examples/users/create-bcrypt-user.md | 18 ++++++ .../server-php/examples/users/create-j-w-t.md | 17 ++++++ .../examples/users/create-m-d5user.md | 18 ++++++ .../users/create-mfa-recovery-codes.md | 15 +++++ .../examples/users/create-p-h-pass-user.md | 18 ++++++ .../examples/users/create-s-h-a-user.md | 19 +++++++ .../users/create-scrypt-modified-user.md | 21 +++++++ .../examples/users/create-scrypt-user.md | 23 ++++++++ .../examples/users/create-session.md | 15 +++++ .../examples/users/create-target.md | 21 +++++++ .../server-php/examples/users/create-token.md | 17 ++++++ .../1.6.x/server-php/examples/users/create.md | 19 +++++++ .../examples/users/delete-identity.md | 15 +++++ .../users/delete-mfa-authenticator.md | 17 ++++++ .../examples/users/delete-session.md | 16 ++++++ .../examples/users/delete-sessions.md | 15 +++++ .../examples/users/delete-target.md | 16 ++++++ .../1.6.x/server-php/examples/users/delete.md | 15 +++++ .../examples/users/get-mfa-recovery-codes.md | 15 +++++ .../server-php/examples/users/get-prefs.md | 15 +++++ .../server-php/examples/users/get-target.md | 16 ++++++ .../1.6.x/server-php/examples/users/get.md | 15 +++++ .../examples/users/list-identities.md | 16 ++++++ .../server-php/examples/users/list-logs.md | 16 ++++++ .../examples/users/list-memberships.md | 15 +++++ .../examples/users/list-mfa-factors.md | 15 +++++ .../examples/users/list-sessions.md | 15 +++++ .../server-php/examples/users/list-targets.md | 16 ++++++ .../1.6.x/server-php/examples/users/list.md | 16 ++++++ .../users/update-email-verification.md | 16 ++++++ .../server-php/examples/users/update-email.md | 16 ++++++ .../examples/users/update-labels.md | 16 ++++++ .../users/update-mfa-recovery-codes.md | 15 +++++ .../server-php/examples/users/update-mfa.md | 16 ++++++ .../server-php/examples/users/update-name.md | 16 ++++++ .../examples/users/update-password.md | 16 ++++++ .../users/update-phone-verification.md | 16 ++++++ .../server-php/examples/users/update-phone.md | 16 ++++++ .../server-php/examples/users/update-prefs.md | 16 ++++++ .../examples/users/update-status.md | 16 ++++++ .../examples/users/update-target.md | 19 +++++++ .../account/create-anonymous-session.md | 9 +++ .../account/create-email-password-session.md | 12 ++++ .../examples/account/create-email-token.md | 13 +++++ .../examples/account/create-j-w-t.md | 9 +++ .../account/create-magic-u-r-l-token.md | 14 +++++ .../account/create-mfa-authenticator.md | 13 +++++ .../examples/account/create-mfa-challenge.md | 12 ++++ .../account/create-mfa-recovery-codes.md | 10 ++++ .../examples/account/create-o-auth2token.md | 15 +++++ .../examples/account/create-phone-token.md | 12 ++++ .../account/create-phone-verification.md | 10 ++++ .../examples/account/create-recovery.md | 13 +++++ .../examples/account/create-session.md | 12 ++++ .../examples/account/create-verification.md | 12 ++++ .../server-python/examples/account/create.md | 14 +++++ .../examples/account/delete-identity.md | 12 ++++ .../account/delete-mfa-authenticator.md | 13 +++++ .../examples/account/delete-session.md | 12 ++++ .../examples/account/delete-sessions.md | 10 ++++ .../account/get-mfa-recovery-codes.md | 10 ++++ .../examples/account/get-prefs.md | 10 ++++ .../examples/account/get-session.md | 12 ++++ .../server-python/examples/account/get.md | 10 ++++ .../examples/account/list-identities.md | 12 ++++ .../examples/account/list-logs.md | 12 ++++ .../examples/account/list-mfa-factors.md | 10 ++++ .../examples/account/list-sessions.md | 10 ++++ .../examples/account/update-email.md | 13 +++++ .../examples/account/update-m-f-a.md | 12 ++++ .../account/update-magic-u-r-l-session.md | 12 ++++ .../account/update-mfa-authenticator.md | 14 +++++ .../examples/account/update-mfa-challenge.md | 13 +++++ .../account/update-mfa-recovery-codes.md | 10 ++++ .../examples/account/update-name.md | 12 ++++ .../examples/account/update-password.md | 13 +++++ .../examples/account/update-phone-session.md | 12 ++++ .../account/update-phone-verification.md | 13 +++++ .../examples/account/update-phone.md | 13 +++++ .../examples/account/update-prefs.md | 12 ++++ .../examples/account/update-recovery.md | 14 +++++ .../examples/account/update-session.md | 12 ++++ .../examples/account/update-status.md | 10 ++++ .../examples/account/update-verification.md | 13 +++++ .../examples/avatars/get-browser.md | 16 ++++++ .../examples/avatars/get-credit-card.md | 16 ++++++ .../examples/avatars/get-favicon.md | 12 ++++ .../examples/avatars/get-flag.md | 16 ++++++ .../examples/avatars/get-image.md | 14 +++++ .../examples/avatars/get-initials.md | 15 +++++ .../server-python/examples/avatars/get-q-r.md | 15 +++++ .../databases/create-boolean-attribute.md | 17 ++++++ .../examples/databases/create-collection.md | 17 ++++++ .../databases/create-datetime-attribute.md | 17 ++++++ .../examples/databases/create-document.md | 16 ++++++ .../databases/create-email-attribute.md | 17 ++++++ .../databases/create-enum-attribute.md | 18 ++++++ .../databases/create-float-attribute.md | 19 +++++++ .../examples/databases/create-index.md | 18 ++++++ .../databases/create-integer-attribute.md | 19 +++++++ .../examples/databases/create-ip-attribute.md | 17 ++++++ .../create-relationship-attribute.md | 20 +++++++ .../databases/create-string-attribute.md | 19 +++++++ .../databases/create-url-attribute.md | 17 ++++++ .../examples/databases/create.md | 14 +++++ .../examples/databases/delete-attribute.md | 14 +++++ .../examples/databases/delete-collection.md | 13 +++++ .../examples/databases/delete-document.md | 14 +++++ .../examples/databases/delete-index.md | 14 +++++ .../examples/databases/delete.md | 12 ++++ .../examples/databases/get-attribute.md | 14 +++++ .../examples/databases/get-collection.md | 13 +++++ .../examples/databases/get-document.md | 15 +++++ .../examples/databases/get-index.md | 14 +++++ .../server-python/examples/databases/get.md | 12 ++++ .../examples/databases/list-attributes.md | 14 +++++ .../examples/databases/list-collections.md | 14 +++++ .../examples/databases/list-documents.md | 14 +++++ .../examples/databases/list-indexes.md | 14 +++++ .../server-python/examples/databases/list.md | 13 +++++ .../databases/update-boolean-attribute.md | 16 ++++++ .../examples/databases/update-collection.md | 17 ++++++ .../databases/update-datetime-attribute.md | 16 ++++++ .../examples/databases/update-document.md | 16 ++++++ .../databases/update-email-attribute.md | 16 ++++++ .../databases/update-enum-attribute.md | 17 ++++++ .../databases/update-float-attribute.md | 18 ++++++ .../databases/update-integer-attribute.md | 18 ++++++ .../examples/databases/update-ip-attribute.md | 16 ++++++ .../update-relationship-attribute.md | 15 +++++ .../databases/update-string-attribute.md | 16 ++++++ .../databases/update-url-attribute.md | 16 ++++++ .../examples/databases/update.md | 14 +++++ .../examples/functions/create-build.md | 14 +++++ .../examples/functions/create-deployment.md | 17 ++++++ .../examples/functions/create-execution.md | 18 ++++++ .../examples/functions/create-variable.md | 14 +++++ .../examples/functions/create.md | 33 +++++++++++ .../examples/functions/delete-deployment.md | 13 +++++ .../examples/functions/delete-execution.md | 13 +++++ .../examples/functions/delete-variable.md | 13 +++++ .../examples/functions/delete.md | 12 ++++ .../examples/functions/download-deployment.md | 13 +++++ .../examples/functions/get-deployment.md | 13 +++++ .../examples/functions/get-execution.md | 13 +++++ .../examples/functions/get-variable.md | 13 +++++ .../server-python/examples/functions/get.md | 12 ++++ .../examples/functions/list-deployments.md | 14 +++++ .../examples/functions/list-executions.md | 14 +++++ .../examples/functions/list-runtimes.md | 10 ++++ .../examples/functions/list-variables.md | 12 ++++ .../server-python/examples/functions/list.md | 13 +++++ .../functions/update-deployment-build.md | 13 +++++ .../examples/functions/update-deployment.md | 13 +++++ .../examples/functions/update-variable.md | 15 +++++ .../examples/functions/update.md | 28 +++++++++ .../examples/graphql/mutation.md | 12 ++++ .../server-python/examples/graphql/query.md | 12 ++++ .../examples/health/get-antivirus.md | 10 ++++ .../examples/health/get-cache.md | 10 ++++ .../examples/health/get-certificate.md | 12 ++++ .../server-python/examples/health/get-d-b.md | 10 ++++ .../examples/health/get-failed-jobs.md | 14 +++++ .../examples/health/get-pub-sub.md | 10 ++++ .../examples/health/get-queue-builds.md | 12 ++++ .../examples/health/get-queue-certificates.md | 12 ++++ .../examples/health/get-queue-databases.md | 13 +++++ .../examples/health/get-queue-deletes.md | 12 ++++ .../examples/health/get-queue-functions.md | 12 ++++ .../examples/health/get-queue-logs.md | 12 ++++ .../examples/health/get-queue-mails.md | 12 ++++ .../examples/health/get-queue-messaging.md | 12 ++++ .../examples/health/get-queue-migrations.md | 12 ++++ .../examples/health/get-queue-usage-dump.md | 12 ++++ .../examples/health/get-queue-usage.md | 12 ++++ .../examples/health/get-queue-webhooks.md | 12 ++++ .../examples/health/get-queue.md | 10 ++++ .../examples/health/get-storage-local.md | 10 ++++ .../examples/health/get-storage.md | 10 ++++ .../server-python/examples/health/get-time.md | 10 ++++ .../server-python/examples/health/get.md | 10 ++++ .../server-python/examples/locale/get.md | 10 ++++ .../examples/locale/list-codes.md | 10 ++++ .../examples/locale/list-continents.md | 10 ++++ .../examples/locale/list-countries-e-u.md | 10 ++++ .../examples/locale/list-countries-phones.md | 10 ++++ .../examples/locale/list-countries.md | 10 ++++ .../examples/locale/list-currencies.md | 10 ++++ .../examples/locale/list-languages.md | 10 ++++ .../messaging/create-apns-provider.md | 19 +++++++ .../examples/messaging/create-email.md | 23 ++++++++ .../examples/messaging/create-fcm-provider.md | 15 +++++ .../messaging/create-mailgun-provider.md | 21 +++++++ .../messaging/create-msg91provider.md | 17 ++++++ .../examples/messaging/create-push.md | 27 +++++++++ .../messaging/create-sendgrid-provider.md | 19 +++++++ .../examples/messaging/create-sms.md | 18 ++++++ .../messaging/create-smtp-provider.md | 25 ++++++++ .../examples/messaging/create-subscriber.md | 14 +++++ .../messaging/create-telesign-provider.md | 17 ++++++ .../messaging/create-textmagic-provider.md | 17 ++++++ .../examples/messaging/create-topic.md | 14 +++++ .../messaging/create-twilio-provider.md | 17 ++++++ .../messaging/create-vonage-provider.md | 17 ++++++ .../examples/messaging/delete-provider.md | 12 ++++ .../examples/messaging/delete-subscriber.md | 13 +++++ .../examples/messaging/delete-topic.md | 12 ++++ .../examples/messaging/delete.md | 12 ++++ .../examples/messaging/get-message.md | 12 ++++ .../examples/messaging/get-provider.md | 12 ++++ .../examples/messaging/get-subscriber.md | 13 +++++ .../examples/messaging/get-topic.md | 12 ++++ .../examples/messaging/list-message-logs.md | 13 +++++ .../examples/messaging/list-messages.md | 13 +++++ .../examples/messaging/list-provider-logs.md | 13 +++++ .../examples/messaging/list-providers.md | 13 +++++ .../messaging/list-subscriber-logs.md | 13 +++++ .../examples/messaging/list-subscribers.md | 14 +++++ .../examples/messaging/list-targets.md | 13 +++++ .../examples/messaging/list-topic-logs.md | 13 +++++ .../examples/messaging/list-topics.md | 13 +++++ .../messaging/update-apns-provider.md | 19 +++++++ .../examples/messaging/update-email.md | 23 ++++++++ .../examples/messaging/update-fcm-provider.md | 15 +++++ .../messaging/update-mailgun-provider.md | 21 +++++++ .../messaging/update-msg91provider.md | 17 ++++++ .../examples/messaging/update-push.md | 27 +++++++++ .../messaging/update-sendgrid-provider.md | 19 +++++++ .../examples/messaging/update-sms.md | 18 ++++++ .../messaging/update-smtp-provider.md | 25 ++++++++ .../messaging/update-telesign-provider.md | 17 ++++++ .../messaging/update-textmagic-provider.md | 17 ++++++ .../examples/messaging/update-topic.md | 14 +++++ .../messaging/update-twilio-provider.md | 17 ++++++ .../messaging/update-vonage-provider.md | 17 ++++++ .../examples/storage/create-bucket.md | 21 +++++++ .../examples/storage/create-file.md | 16 ++++++ .../examples/storage/delete-bucket.md | 12 ++++ .../examples/storage/delete-file.md | 13 +++++ .../examples/storage/get-bucket.md | 12 ++++ .../examples/storage/get-file-download.md | 13 +++++ .../examples/storage/get-file-preview.md | 24 ++++++++ .../examples/storage/get-file-view.md | 13 +++++ .../examples/storage/get-file.md | 13 +++++ .../examples/storage/list-buckets.md | 13 +++++ .../examples/storage/list-files.md | 14 +++++ .../examples/storage/update-bucket.md | 21 +++++++ .../examples/storage/update-file.md | 15 +++++ .../examples/teams/create-membership.md | 18 ++++++ .../server-python/examples/teams/create.md | 14 +++++ .../examples/teams/delete-membership.md | 13 +++++ .../server-python/examples/teams/delete.md | 12 ++++ .../examples/teams/get-membership.md | 13 +++++ .../server-python/examples/teams/get-prefs.md | 12 ++++ .../1.6.x/server-python/examples/teams/get.md | 12 ++++ .../examples/teams/list-memberships.md | 14 +++++ .../server-python/examples/teams/list.md | 13 +++++ .../teams/update-membership-status.md | 15 +++++ .../examples/teams/update-membership.md | 14 +++++ .../examples/teams/update-name.md | 13 +++++ .../examples/teams/update-prefs.md | 13 +++++ .../examples/users/create-argon2user.md | 15 +++++ .../examples/users/create-bcrypt-user.md | 15 +++++ .../examples/users/create-j-w-t.md | 14 +++++ .../examples/users/create-m-d5user.md | 15 +++++ .../users/create-mfa-recovery-codes.md | 12 ++++ .../examples/users/create-p-h-pass-user.md | 15 +++++ .../examples/users/create-s-h-a-user.md | 16 ++++++ .../users/create-scrypt-modified-user.md | 18 ++++++ .../examples/users/create-scrypt-user.md | 20 +++++++ .../examples/users/create-session.md | 12 ++++ .../examples/users/create-target.md | 18 ++++++ .../examples/users/create-token.md | 14 +++++ .../server-python/examples/users/create.md | 16 ++++++ .../examples/users/delete-identity.md | 12 ++++ .../users/delete-mfa-authenticator.md | 14 +++++ .../examples/users/delete-session.md | 13 +++++ .../examples/users/delete-sessions.md | 12 ++++ .../examples/users/delete-target.md | 13 +++++ .../server-python/examples/users/delete.md | 12 ++++ .../examples/users/get-mfa-recovery-codes.md | 12 ++++ .../server-python/examples/users/get-prefs.md | 12 ++++ .../examples/users/get-target.md | 13 +++++ .../1.6.x/server-python/examples/users/get.md | 12 ++++ .../examples/users/list-identities.md | 13 +++++ .../server-python/examples/users/list-logs.md | 13 +++++ .../examples/users/list-memberships.md | 12 ++++ .../examples/users/list-mfa-factors.md | 12 ++++ .../examples/users/list-sessions.md | 12 ++++ .../examples/users/list-targets.md | 13 +++++ .../server-python/examples/users/list.md | 13 +++++ .../users/update-email-verification.md | 13 +++++ .../examples/users/update-email.md | 13 +++++ .../examples/users/update-labels.md | 13 +++++ .../users/update-mfa-recovery-codes.md | 12 ++++ .../examples/users/update-mfa.md | 13 +++++ .../examples/users/update-name.md | 13 +++++ .../examples/users/update-password.md | 13 +++++ .../users/update-phone-verification.md | 13 +++++ .../examples/users/update-phone.md | 13 +++++ .../examples/users/update-prefs.md | 13 +++++ .../examples/users/update-status.md | 13 +++++ .../examples/users/update-target.md | 16 ++++++ .../account/create-anonymous-session.md | 6 ++ .../account/create-email-password-session.md | 10 ++++ .../examples/account/create-email-token.md | 11 ++++ .../examples/account/create-j-w-t.md | 6 ++ .../account/create-magic-u-r-l-token.md | 12 ++++ .../account/create-mfa-authenticator.md | 8 +++ .../examples/account/create-mfa-challenge.md | 9 +++ .../account/create-mfa-recovery-codes.md | 8 +++ .../examples/account/create-o-auth2token.md | 6 ++ .../examples/account/create-phone-token.md | 10 ++++ .../account/create-phone-verification.md | 8 +++ .../examples/account/create-recovery.md | 12 ++++ .../examples/account/create-session.md | 10 ++++ .../examples/account/create-verification.md | 11 ++++ .../server-rest/examples/account/create.md | 12 ++++ .../examples/account/delete-identity.md | 8 +++ .../account/delete-mfa-authenticator.md | 8 +++ .../examples/account/delete-session.md | 8 +++ .../examples/account/delete-sessions.md | 8 +++ .../account/get-mfa-recovery-codes.md | 8 +++ .../server-rest/examples/account/get-prefs.md | 8 +++ .../examples/account/get-session.md | 8 +++ .../1.6.x/server-rest/examples/account/get.md | 8 +++ .../examples/account/list-identities.md | 8 +++ .../server-rest/examples/account/list-logs.md | 8 +++ .../examples/account/list-mfa-factors.md | 8 +++ .../examples/account/list-sessions.md | 8 +++ .../examples/account/update-email.md | 12 ++++ .../examples/account/update-m-f-a.md | 11 ++++ .../account/update-magic-u-r-l-session.md | 10 ++++ .../account/update-mfa-authenticator.md | 11 ++++ .../examples/account/update-mfa-challenge.md | 12 ++++ .../account/update-mfa-recovery-codes.md | 8 +++ .../examples/account/update-name.md | 11 ++++ .../examples/account/update-password.md | 12 ++++ .../examples/account/update-phone-session.md | 10 ++++ .../account/update-phone-verification.md | 12 ++++ .../examples/account/update-phone.md | 12 ++++ .../examples/account/update-prefs.md | 11 ++++ .../examples/account/update-recovery.md | 13 +++++ .../examples/account/update-session.md | 8 +++ .../examples/account/update-status.md | 8 +++ .../examples/account/update-verification.md | 12 ++++ .../examples/avatars/get-browser.md | 9 +++ .../examples/avatars/get-credit-card.md | 9 +++ .../examples/avatars/get-favicon.md | 9 +++ .../server-rest/examples/avatars/get-flag.md | 9 +++ .../server-rest/examples/avatars/get-image.md | 9 +++ .../examples/avatars/get-initials.md | 9 +++ .../server-rest/examples/avatars/get-q-r.md | 9 +++ .../databases/create-boolean-attribute.md | 13 +++++ .../examples/databases/create-collection.md | 14 +++++ .../databases/create-datetime-attribute.md | 13 +++++ .../examples/databases/create-document.md | 14 +++++ .../databases/create-email-attribute.md | 13 +++++ .../databases/create-enum-attribute.md | 14 +++++ .../databases/create-float-attribute.md | 15 +++++ .../examples/databases/create-index.md | 13 +++++ .../databases/create-integer-attribute.md | 15 +++++ .../examples/databases/create-ip-attribute.md | 13 +++++ .../create-relationship-attribute.md | 15 +++++ .../databases/create-string-attribute.md | 15 +++++ .../databases/create-url-attribute.md | 13 +++++ .../server-rest/examples/databases/create.md | 12 ++++ .../examples/databases/delete-attribute.md | 7 +++ .../examples/databases/delete-collection.md | 7 +++ .../examples/databases/delete-document.md | 9 +++ .../examples/databases/delete-index.md | 7 +++ .../server-rest/examples/databases/delete.md | 7 +++ .../examples/databases/get-attribute.md | 7 +++ .../examples/databases/get-collection.md | 7 +++ .../examples/databases/get-document.md | 9 +++ .../examples/databases/get-index.md | 7 +++ .../server-rest/examples/databases/get.md | 7 +++ .../examples/databases/list-attributes.md | 7 +++ .../examples/databases/list-collections.md | 7 +++ .../examples/databases/list-documents.md | 9 +++ .../examples/databases/list-indexes.md | 7 +++ .../server-rest/examples/databases/list.md | 7 +++ .../databases/update-boolean-attribute.md | 11 ++++ .../examples/databases/update-collection.md | 13 +++++ .../databases/update-datetime-attribute.md | 11 ++++ .../examples/databases/update-document.md | 13 +++++ .../databases/update-email-attribute.md | 11 ++++ .../databases/update-enum-attribute.md | 12 ++++ .../databases/update-float-attribute.md | 13 +++++ .../databases/update-integer-attribute.md | 13 +++++ .../examples/databases/update-ip-attribute.md | 11 ++++ .../update-relationship-attribute.md | 10 ++++ .../databases/update-string-attribute.md | 11 ++++ .../databases/update-url-attribute.md | 11 ++++ .../server-rest/examples/databases/update.md | 11 ++++ .../examples/functions/create-build.md | 10 ++++ .../examples/functions/create-deployment.md | 30 ++++++++++ .../examples/functions/create-execution.md | 17 ++++++ .../examples/functions/create-variable.md | 11 ++++ .../server-rest/examples/functions/create.md | 30 ++++++++++ .../examples/functions/delete-deployment.md | 7 +++ .../examples/functions/delete-execution.md | 7 +++ .../examples/functions/delete-variable.md | 7 +++ .../server-rest/examples/functions/delete.md | 7 +++ .../examples/functions/download-deployment.md | 7 +++ .../examples/functions/get-deployment.md | 7 +++ .../examples/functions/get-execution.md | 9 +++ .../examples/functions/get-variable.md | 7 +++ .../server-rest/examples/functions/get.md | 7 +++ .../examples/functions/list-deployments.md | 7 +++ .../examples/functions/list-executions.md | 9 +++ .../examples/functions/list-runtimes.md | 7 +++ .../examples/functions/list-variables.md | 7 +++ .../server-rest/examples/functions/list.md | 7 +++ .../functions/update-deployment-build.md | 7 +++ .../examples/functions/update-deployment.md | 7 +++ .../examples/functions/update-variable.md | 11 ++++ .../server-rest/examples/functions/update.md | 25 ++++++++ .../server-rest/examples/graphql/mutation.md | 13 +++++ .../server-rest/examples/graphql/query.md | 13 +++++ .../examples/health/get-antivirus.md | 7 +++ .../server-rest/examples/health/get-cache.md | 7 +++ .../examples/health/get-certificate.md | 7 +++ .../server-rest/examples/health/get-d-b.md | 7 +++ .../examples/health/get-failed-jobs.md | 7 +++ .../examples/health/get-pub-sub.md | 7 +++ .../examples/health/get-queue-builds.md | 7 +++ .../examples/health/get-queue-certificates.md | 7 +++ .../examples/health/get-queue-databases.md | 7 +++ .../examples/health/get-queue-deletes.md | 7 +++ .../examples/health/get-queue-functions.md | 7 +++ .../examples/health/get-queue-logs.md | 7 +++ .../examples/health/get-queue-mails.md | 7 +++ .../examples/health/get-queue-messaging.md | 7 +++ .../examples/health/get-queue-migrations.md | 7 +++ .../examples/health/get-queue-usage-dump.md | 7 +++ .../examples/health/get-queue-usage.md | 7 +++ .../examples/health/get-queue-webhooks.md | 7 +++ .../server-rest/examples/health/get-queue.md | 7 +++ .../examples/health/get-storage-local.md | 7 +++ .../examples/health/get-storage.md | 7 +++ .../server-rest/examples/health/get-time.md | 7 +++ .../1.6.x/server-rest/examples/health/get.md | 7 +++ .../1.6.x/server-rest/examples/locale/get.md | 9 +++ .../server-rest/examples/locale/list-codes.md | 9 +++ .../examples/locale/list-continents.md | 9 +++ .../examples/locale/list-countries-e-u.md | 9 +++ .../examples/locale/list-countries-phones.md | 9 +++ .../examples/locale/list-countries.md | 9 +++ .../examples/locale/list-currencies.md | 9 +++ .../examples/locale/list-languages.md | 9 +++ .../messaging/create-apns-provider.md | 17 ++++++ .../examples/messaging/create-email.md | 21 +++++++ .../examples/messaging/create-fcm-provider.md | 13 +++++ .../messaging/create-mailgun-provider.md | 19 +++++++ .../messaging/create-msg91provider.md | 15 +++++ .../examples/messaging/create-push.md | 25 ++++++++ .../messaging/create-sendgrid-provider.md | 17 ++++++ .../examples/messaging/create-sms.md | 16 ++++++ .../messaging/create-smtp-provider.md | 23 ++++++++ .../examples/messaging/create-subscriber.md | 13 +++++ .../messaging/create-telesign-provider.md | 15 +++++ .../messaging/create-textmagic-provider.md | 15 +++++ .../examples/messaging/create-topic.md | 12 ++++ .../messaging/create-twilio-provider.md | 15 +++++ .../messaging/create-vonage-provider.md | 15 +++++ .../examples/messaging/delete-provider.md | 7 +++ .../examples/messaging/delete-subscriber.md | 9 +++ .../examples/messaging/delete-topic.md | 7 +++ .../server-rest/examples/messaging/delete.md | 7 +++ .../examples/messaging/get-message.md | 7 +++ .../examples/messaging/get-provider.md | 7 +++ .../examples/messaging/get-subscriber.md | 7 +++ .../examples/messaging/get-topic.md | 7 +++ .../examples/messaging/list-message-logs.md | 7 +++ .../examples/messaging/list-messages.md | 7 +++ .../examples/messaging/list-provider-logs.md | 7 +++ .../examples/messaging/list-providers.md | 7 +++ .../messaging/list-subscriber-logs.md | 7 +++ .../examples/messaging/list-subscribers.md | 7 +++ .../examples/messaging/list-targets.md | 7 +++ .../examples/messaging/list-topic-logs.md | 7 +++ .../examples/messaging/list-topics.md | 7 +++ .../messaging/update-apns-provider.md | 16 ++++++ .../examples/messaging/update-email.md | 20 +++++++ .../examples/messaging/update-fcm-provider.md | 12 ++++ .../messaging/update-mailgun-provider.md | 18 ++++++ .../messaging/update-msg91provider.md | 14 +++++ .../examples/messaging/update-push.md | 24 ++++++++ .../messaging/update-sendgrid-provider.md | 16 ++++++ .../examples/messaging/update-sms.md | 15 +++++ .../messaging/update-smtp-provider.md | 22 +++++++ .../messaging/update-telesign-provider.md | 14 +++++ .../messaging/update-textmagic-provider.md | 14 +++++ .../examples/messaging/update-topic.md | 11 ++++ .../messaging/update-twilio-provider.md | 14 +++++ .../messaging/update-vonage-provider.md | 14 +++++ .../examples/storage/create-bucket.md | 19 +++++++ .../examples/storage/create-file.md | 27 +++++++++ .../examples/storage/delete-bucket.md | 7 +++ .../examples/storage/delete-file.md | 9 +++ .../examples/storage/get-bucket.md | 7 +++ .../examples/storage/get-file-download.md | 9 +++ .../examples/storage/get-file-preview.md | 9 +++ .../examples/storage/get-file-view.md | 9 +++ .../server-rest/examples/storage/get-file.md | 9 +++ .../examples/storage/list-buckets.md | 7 +++ .../examples/storage/list-files.md | 9 +++ .../examples/storage/update-bucket.md | 18 ++++++ .../examples/storage/update-file.md | 13 +++++ .../examples/teams/create-membership.md | 17 ++++++ .../server-rest/examples/teams/create.md | 14 +++++ .../examples/teams/delete-membership.md | 9 +++ .../server-rest/examples/teams/delete.md | 9 +++ .../examples/teams/get-membership.md | 9 +++ .../server-rest/examples/teams/get-prefs.md | 8 +++ .../1.6.x/server-rest/examples/teams/get.md | 9 +++ .../examples/teams/list-memberships.md | 9 +++ .../1.6.x/server-rest/examples/teams/list.md | 9 +++ .../teams/update-membership-status.md | 12 ++++ .../examples/teams/update-membership.md | 12 ++++ .../server-rest/examples/teams/update-name.md | 12 ++++ .../examples/teams/update-prefs.md | 11 ++++ .../examples/users/create-argon2user.md | 13 +++++ .../examples/users/create-bcrypt-user.md | 13 +++++ .../examples/users/create-j-w-t.md | 11 ++++ .../examples/users/create-m-d5user.md | 13 +++++ .../users/create-mfa-recovery-codes.md | 7 +++ .../examples/users/create-p-h-pass-user.md | 13 +++++ .../examples/users/create-s-h-a-user.md | 14 +++++ .../users/create-scrypt-modified-user.md | 16 ++++++ .../examples/users/create-scrypt-user.md | 18 ++++++ .../examples/users/create-session.md | 7 +++ .../examples/users/create-target.md | 14 +++++ .../examples/users/create-token.md | 11 ++++ .../server-rest/examples/users/create.md | 14 +++++ .../examples/users/delete-identity.md | 7 +++ .../users/delete-mfa-authenticator.md | 7 +++ .../examples/users/delete-session.md | 7 +++ .../examples/users/delete-sessions.md | 7 +++ .../examples/users/delete-target.md | 7 +++ .../server-rest/examples/users/delete.md | 7 +++ .../examples/users/get-mfa-recovery-codes.md | 7 +++ .../server-rest/examples/users/get-prefs.md | 7 +++ .../server-rest/examples/users/get-target.md | 7 +++ .../1.6.x/server-rest/examples/users/get.md | 7 +++ .../examples/users/list-identities.md | 7 +++ .../server-rest/examples/users/list-logs.md | 7 +++ .../examples/users/list-memberships.md | 7 +++ .../examples/users/list-mfa-factors.md | 7 +++ .../examples/users/list-sessions.md | 7 +++ .../examples/users/list-targets.md | 7 +++ .../1.6.x/server-rest/examples/users/list.md | 7 +++ .../users/update-email-verification.md | 10 ++++ .../examples/users/update-email.md | 10 ++++ .../examples/users/update-labels.md | 10 ++++ .../users/update-mfa-recovery-codes.md | 7 +++ .../server-rest/examples/users/update-mfa.md | 10 ++++ .../server-rest/examples/users/update-name.md | 10 ++++ .../examples/users/update-password.md | 10 ++++ .../users/update-phone-verification.md | 10 ++++ .../examples/users/update-phone.md | 10 ++++ .../examples/users/update-prefs.md | 10 ++++ .../examples/users/update-status.md | 10 ++++ .../examples/users/update-target.md | 12 ++++ .../account/create-anonymous-session.md | 11 ++++ .../account/create-email-password-session.md | 14 +++++ .../examples/account/create-email-token.md | 15 +++++ .../examples/account/create-j-w-t.md | 11 ++++ .../account/create-magic-u-r-l-token.md | 16 ++++++ .../account/create-mfa-authenticator.md | 15 +++++ .../examples/account/create-mfa-challenge.md | 14 +++++ .../account/create-mfa-recovery-codes.md | 12 ++++ .../examples/account/create-o-auth2token.md | 17 ++++++ .../examples/account/create-phone-token.md | 14 +++++ .../account/create-phone-verification.md | 12 ++++ .../examples/account/create-recovery.md | 15 +++++ .../examples/account/create-session.md | 14 +++++ .../examples/account/create-verification.md | 14 +++++ .../server-ruby/examples/account/create.md | 16 ++++++ .../examples/account/delete-identity.md | 14 +++++ .../account/delete-mfa-authenticator.md | 15 +++++ .../examples/account/delete-session.md | 14 +++++ .../examples/account/delete-sessions.md | 12 ++++ .../account/get-mfa-recovery-codes.md | 12 ++++ .../server-ruby/examples/account/get-prefs.md | 12 ++++ .../examples/account/get-session.md | 14 +++++ .../1.6.x/server-ruby/examples/account/get.md | 12 ++++ .../examples/account/list-identities.md | 14 +++++ .../server-ruby/examples/account/list-logs.md | 14 +++++ .../examples/account/list-mfa-factors.md | 12 ++++ .../examples/account/list-sessions.md | 12 ++++ .../examples/account/update-email.md | 15 +++++ .../examples/account/update-m-f-a.md | 14 +++++ .../account/update-magic-u-r-l-session.md | 14 +++++ .../account/update-mfa-authenticator.md | 16 ++++++ .../examples/account/update-mfa-challenge.md | 15 +++++ .../account/update-mfa-recovery-codes.md | 12 ++++ .../examples/account/update-name.md | 14 +++++ .../examples/account/update-password.md | 15 +++++ .../examples/account/update-phone-session.md | 14 +++++ .../account/update-phone-verification.md | 15 +++++ .../examples/account/update-phone.md | 15 +++++ .../examples/account/update-prefs.md | 14 +++++ .../examples/account/update-recovery.md | 16 ++++++ .../examples/account/update-session.md | 14 +++++ .../examples/account/update-status.md | 12 ++++ .../examples/account/update-verification.md | 15 +++++ .../examples/avatars/get-browser.md | 18 ++++++ .../examples/avatars/get-credit-card.md | 18 ++++++ .../examples/avatars/get-favicon.md | 14 +++++ .../server-ruby/examples/avatars/get-flag.md | 18 ++++++ .../server-ruby/examples/avatars/get-image.md | 16 ++++++ .../examples/avatars/get-initials.md | 17 ++++++ .../server-ruby/examples/avatars/get-q-r.md | 17 ++++++ .../databases/create-boolean-attribute.md | 19 +++++++ .../examples/databases/create-collection.md | 19 +++++++ .../databases/create-datetime-attribute.md | 19 +++++++ .../examples/databases/create-document.md | 18 ++++++ .../databases/create-email-attribute.md | 19 +++++++ .../databases/create-enum-attribute.md | 20 +++++++ .../databases/create-float-attribute.md | 21 +++++++ .../examples/databases/create-index.md | 20 +++++++ .../databases/create-integer-attribute.md | 21 +++++++ .../examples/databases/create-ip-attribute.md | 19 +++++++ .../create-relationship-attribute.md | 22 +++++++ .../databases/create-string-attribute.md | 21 +++++++ .../databases/create-url-attribute.md | 19 +++++++ .../server-ruby/examples/databases/create.md | 16 ++++++ .../examples/databases/delete-attribute.md | 16 ++++++ .../examples/databases/delete-collection.md | 15 +++++ .../examples/databases/delete-document.md | 16 ++++++ .../examples/databases/delete-index.md | 16 ++++++ .../server-ruby/examples/databases/delete.md | 14 +++++ .../examples/databases/get-attribute.md | 16 ++++++ .../examples/databases/get-collection.md | 15 +++++ .../examples/databases/get-document.md | 17 ++++++ .../examples/databases/get-index.md | 16 ++++++ .../server-ruby/examples/databases/get.md | 14 +++++ .../examples/databases/list-attributes.md | 16 ++++++ .../examples/databases/list-collections.md | 16 ++++++ .../examples/databases/list-documents.md | 16 ++++++ .../examples/databases/list-indexes.md | 16 ++++++ .../server-ruby/examples/databases/list.md | 15 +++++ .../databases/update-boolean-attribute.md | 18 ++++++ .../examples/databases/update-collection.md | 19 +++++++ .../databases/update-datetime-attribute.md | 18 ++++++ .../examples/databases/update-document.md | 18 ++++++ .../databases/update-email-attribute.md | 18 ++++++ .../databases/update-enum-attribute.md | 19 +++++++ .../databases/update-float-attribute.md | 20 +++++++ .../databases/update-integer-attribute.md | 20 +++++++ .../examples/databases/update-ip-attribute.md | 18 ++++++ .../update-relationship-attribute.md | 17 ++++++ .../databases/update-string-attribute.md | 18 ++++++ .../databases/update-url-attribute.md | 18 ++++++ .../server-ruby/examples/databases/update.md | 16 ++++++ .../examples/functions/create-build.md | 16 ++++++ .../examples/functions/create-deployment.md | 18 ++++++ .../examples/functions/create-execution.md | 20 +++++++ .../examples/functions/create-variable.md | 16 ++++++ .../server-ruby/examples/functions/create.md | 35 ++++++++++++ .../examples/functions/delete-deployment.md | 15 +++++ .../examples/functions/delete-execution.md | 15 +++++ .../examples/functions/delete-variable.md | 15 +++++ .../server-ruby/examples/functions/delete.md | 14 +++++ .../examples/functions/download-deployment.md | 15 +++++ .../examples/functions/get-deployment.md | 15 +++++ .../examples/functions/get-execution.md | 15 +++++ .../examples/functions/get-variable.md | 15 +++++ .../server-ruby/examples/functions/get.md | 14 +++++ .../examples/functions/list-deployments.md | 16 ++++++ .../examples/functions/list-executions.md | 16 ++++++ .../examples/functions/list-runtimes.md | 12 ++++ .../examples/functions/list-variables.md | 14 +++++ .../server-ruby/examples/functions/list.md | 15 +++++ .../functions/update-deployment-build.md | 15 +++++ .../examples/functions/update-deployment.md | 15 +++++ .../examples/functions/update-variable.md | 17 ++++++ .../server-ruby/examples/functions/update.md | 30 ++++++++++ .../server-ruby/examples/graphql/mutation.md | 14 +++++ .../server-ruby/examples/graphql/query.md | 14 +++++ .../examples/health/get-antivirus.md | 12 ++++ .../server-ruby/examples/health/get-cache.md | 12 ++++ .../examples/health/get-certificate.md | 14 +++++ .../server-ruby/examples/health/get-d-b.md | 12 ++++ .../examples/health/get-failed-jobs.md | 16 ++++++ .../examples/health/get-pub-sub.md | 12 ++++ .../examples/health/get-queue-builds.md | 14 +++++ .../examples/health/get-queue-certificates.md | 14 +++++ .../examples/health/get-queue-databases.md | 15 +++++ .../examples/health/get-queue-deletes.md | 14 +++++ .../examples/health/get-queue-functions.md | 14 +++++ .../examples/health/get-queue-logs.md | 14 +++++ .../examples/health/get-queue-mails.md | 14 +++++ .../examples/health/get-queue-messaging.md | 14 +++++ .../examples/health/get-queue-migrations.md | 14 +++++ .../examples/health/get-queue-usage-dump.md | 14 +++++ .../examples/health/get-queue-usage.md | 14 +++++ .../examples/health/get-queue-webhooks.md | 14 +++++ .../server-ruby/examples/health/get-queue.md | 12 ++++ .../examples/health/get-storage-local.md | 12 ++++ .../examples/health/get-storage.md | 12 ++++ .../server-ruby/examples/health/get-time.md | 12 ++++ .../1.6.x/server-ruby/examples/health/get.md | 12 ++++ .../1.6.x/server-ruby/examples/locale/get.md | 12 ++++ .../server-ruby/examples/locale/list-codes.md | 12 ++++ .../examples/locale/list-continents.md | 12 ++++ .../examples/locale/list-countries-e-u.md | 12 ++++ .../examples/locale/list-countries-phones.md | 12 ++++ .../examples/locale/list-countries.md | 12 ++++ .../examples/locale/list-currencies.md | 12 ++++ .../examples/locale/list-languages.md | 12 ++++ .../messaging/create-apns-provider.md | 21 +++++++ .../examples/messaging/create-email.md | 25 ++++++++ .../examples/messaging/create-fcm-provider.md | 17 ++++++ .../messaging/create-mailgun-provider.md | 23 ++++++++ .../messaging/create-msg91provider.md | 19 +++++++ .../examples/messaging/create-push.md | 29 ++++++++++ .../messaging/create-sendgrid-provider.md | 21 +++++++ .../examples/messaging/create-sms.md | 20 +++++++ .../messaging/create-smtp-provider.md | 27 +++++++++ .../examples/messaging/create-subscriber.md | 16 ++++++ .../messaging/create-telesign-provider.md | 19 +++++++ .../messaging/create-textmagic-provider.md | 19 +++++++ .../examples/messaging/create-topic.md | 16 ++++++ .../messaging/create-twilio-provider.md | 19 +++++++ .../messaging/create-vonage-provider.md | 19 +++++++ .../examples/messaging/delete-provider.md | 14 +++++ .../examples/messaging/delete-subscriber.md | 15 +++++ .../examples/messaging/delete-topic.md | 14 +++++ .../server-ruby/examples/messaging/delete.md | 14 +++++ .../examples/messaging/get-message.md | 14 +++++ .../examples/messaging/get-provider.md | 14 +++++ .../examples/messaging/get-subscriber.md | 15 +++++ .../examples/messaging/get-topic.md | 14 +++++ .../examples/messaging/list-message-logs.md | 15 +++++ .../examples/messaging/list-messages.md | 15 +++++ .../examples/messaging/list-provider-logs.md | 15 +++++ .../examples/messaging/list-providers.md | 15 +++++ .../messaging/list-subscriber-logs.md | 15 +++++ .../examples/messaging/list-subscribers.md | 16 ++++++ .../examples/messaging/list-targets.md | 15 +++++ .../examples/messaging/list-topic-logs.md | 15 +++++ .../examples/messaging/list-topics.md | 15 +++++ .../messaging/update-apns-provider.md | 21 +++++++ .../examples/messaging/update-email.md | 25 ++++++++ .../examples/messaging/update-fcm-provider.md | 17 ++++++ .../messaging/update-mailgun-provider.md | 23 ++++++++ .../messaging/update-msg91provider.md | 19 +++++++ .../examples/messaging/update-push.md | 29 ++++++++++ .../messaging/update-sendgrid-provider.md | 21 +++++++ .../examples/messaging/update-sms.md | 20 +++++++ .../messaging/update-smtp-provider.md | 27 +++++++++ .../messaging/update-telesign-provider.md | 19 +++++++ .../messaging/update-textmagic-provider.md | 19 +++++++ .../examples/messaging/update-topic.md | 16 ++++++ .../messaging/update-twilio-provider.md | 19 +++++++ .../messaging/update-vonage-provider.md | 19 +++++++ .../examples/storage/create-bucket.md | 23 ++++++++ .../examples/storage/create-file.md | 17 ++++++ .../examples/storage/delete-bucket.md | 14 +++++ .../examples/storage/delete-file.md | 15 +++++ .../examples/storage/get-bucket.md | 14 +++++ .../examples/storage/get-file-download.md | 15 +++++ .../examples/storage/get-file-preview.md | 26 +++++++++ .../examples/storage/get-file-view.md | 15 +++++ .../server-ruby/examples/storage/get-file.md | 15 +++++ .../examples/storage/list-buckets.md | 15 +++++ .../examples/storage/list-files.md | 16 ++++++ .../examples/storage/update-bucket.md | 23 ++++++++ .../examples/storage/update-file.md | 17 ++++++ .../examples/teams/create-membership.md | 20 +++++++ .../server-ruby/examples/teams/create.md | 16 ++++++ .../examples/teams/delete-membership.md | 15 +++++ .../server-ruby/examples/teams/delete.md | 14 +++++ .../examples/teams/get-membership.md | 15 +++++ .../server-ruby/examples/teams/get-prefs.md | 14 +++++ .../1.6.x/server-ruby/examples/teams/get.md | 14 +++++ .../examples/teams/list-memberships.md | 16 ++++++ .../1.6.x/server-ruby/examples/teams/list.md | 15 +++++ .../teams/update-membership-status.md | 17 ++++++ .../examples/teams/update-membership.md | 16 ++++++ .../server-ruby/examples/teams/update-name.md | 15 +++++ .../examples/teams/update-prefs.md | 15 +++++ .../examples/users/create-argon2user.md | 17 ++++++ .../examples/users/create-bcrypt-user.md | 17 ++++++ .../examples/users/create-j-w-t.md | 16 ++++++ .../examples/users/create-m-d5user.md | 17 ++++++ .../users/create-mfa-recovery-codes.md | 14 +++++ .../examples/users/create-p-h-pass-user.md | 17 ++++++ .../examples/users/create-s-h-a-user.md | 18 ++++++ .../users/create-scrypt-modified-user.md | 20 +++++++ .../examples/users/create-scrypt-user.md | 22 +++++++ .../examples/users/create-session.md | 14 +++++ .../examples/users/create-target.md | 20 +++++++ .../examples/users/create-token.md | 16 ++++++ .../server-ruby/examples/users/create.md | 18 ++++++ .../examples/users/delete-identity.md | 14 +++++ .../users/delete-mfa-authenticator.md | 16 ++++++ .../examples/users/delete-session.md | 15 +++++ .../examples/users/delete-sessions.md | 14 +++++ .../examples/users/delete-target.md | 15 +++++ .../server-ruby/examples/users/delete.md | 14 +++++ .../examples/users/get-mfa-recovery-codes.md | 14 +++++ .../server-ruby/examples/users/get-prefs.md | 14 +++++ .../server-ruby/examples/users/get-target.md | 15 +++++ .../1.6.x/server-ruby/examples/users/get.md | 14 +++++ .../examples/users/list-identities.md | 15 +++++ .../server-ruby/examples/users/list-logs.md | 15 +++++ .../examples/users/list-memberships.md | 14 +++++ .../examples/users/list-mfa-factors.md | 14 +++++ .../examples/users/list-sessions.md | 14 +++++ .../examples/users/list-targets.md | 15 +++++ .../1.6.x/server-ruby/examples/users/list.md | 15 +++++ .../users/update-email-verification.md | 15 +++++ .../examples/users/update-email.md | 15 +++++ .../examples/users/update-labels.md | 15 +++++ .../users/update-mfa-recovery-codes.md | 14 +++++ .../server-ruby/examples/users/update-mfa.md | 15 +++++ .../server-ruby/examples/users/update-name.md | 15 +++++ .../examples/users/update-password.md | 15 +++++ .../users/update-phone-verification.md | 15 +++++ .../examples/users/update-phone.md | 15 +++++ .../examples/users/update-prefs.md | 15 +++++ .../examples/users/update-status.md | 15 +++++ .../examples/users/update-target.md | 18 ++++++ .../account/create-anonymous-session.md | 10 ++++ .../account/create-email-password-session.md | 13 +++++ .../examples/account/create-email-token.md | 14 +++++ .../examples/account/create-j-w-t.md | 10 ++++ .../account/create-magic-u-r-l-token.md | 15 +++++ .../account/create-mfa-authenticator.md | 14 +++++ .../examples/account/create-mfa-challenge.md | 13 +++++ .../account/create-mfa-recovery-codes.md | 11 ++++ .../examples/account/create-o-auth2token.md | 16 ++++++ .../examples/account/create-phone-token.md | 13 +++++ .../account/create-phone-verification.md | 11 ++++ .../examples/account/create-recovery.md | 14 +++++ .../examples/account/create-session.md | 13 +++++ .../examples/account/create-verification.md | 13 +++++ .../server-swift/examples/account/create.md | 15 +++++ .../examples/account/delete-identity.md | 13 +++++ .../account/delete-mfa-authenticator.md | 14 +++++ .../examples/account/delete-session.md | 13 +++++ .../examples/account/delete-sessions.md | 11 ++++ .../account/get-mfa-recovery-codes.md | 11 ++++ .../examples/account/get-prefs.md | 11 ++++ .../examples/account/get-session.md | 13 +++++ .../server-swift/examples/account/get.md | 11 ++++ .../examples/account/list-identities.md | 13 +++++ .../examples/account/list-logs.md | 13 +++++ .../examples/account/list-mfa-factors.md | 11 ++++ .../examples/account/list-sessions.md | 11 ++++ .../examples/account/update-email.md | 14 +++++ .../examples/account/update-m-f-a.md | 13 +++++ .../account/update-magic-u-r-l-session.md | 13 +++++ .../account/update-mfa-authenticator.md | 15 +++++ .../examples/account/update-mfa-challenge.md | 14 +++++ .../account/update-mfa-recovery-codes.md | 11 ++++ .../examples/account/update-name.md | 13 +++++ .../examples/account/update-password.md | 14 +++++ .../examples/account/update-phone-session.md | 13 +++++ .../account/update-phone-verification.md | 14 +++++ .../examples/account/update-phone.md | 14 +++++ .../examples/account/update-prefs.md | 13 +++++ .../examples/account/update-recovery.md | 15 +++++ .../examples/account/update-session.md | 13 +++++ .../examples/account/update-status.md | 11 ++++ .../examples/account/update-verification.md | 14 +++++ .../examples/avatars/get-browser.md | 17 ++++++ .../examples/avatars/get-credit-card.md | 17 ++++++ .../examples/avatars/get-favicon.md | 13 +++++ .../server-swift/examples/avatars/get-flag.md | 17 ++++++ .../examples/avatars/get-image.md | 15 +++++ .../examples/avatars/get-initials.md | 16 ++++++ .../server-swift/examples/avatars/get-q-r.md | 16 ++++++ .../databases/create-boolean-attribute.md | 18 ++++++ .../examples/databases/create-collection.md | 18 ++++++ .../databases/create-datetime-attribute.md | 18 ++++++ .../examples/databases/create-document.md | 17 ++++++ .../databases/create-email-attribute.md | 18 ++++++ .../databases/create-enum-attribute.md | 19 +++++++ .../databases/create-float-attribute.md | 20 +++++++ .../examples/databases/create-index.md | 19 +++++++ .../databases/create-integer-attribute.md | 20 +++++++ .../examples/databases/create-ip-attribute.md | 18 ++++++ .../create-relationship-attribute.md | 21 +++++++ .../databases/create-string-attribute.md | 20 +++++++ .../databases/create-url-attribute.md | 18 ++++++ .../server-swift/examples/databases/create.md | 15 +++++ .../examples/databases/delete-attribute.md | 15 +++++ .../examples/databases/delete-collection.md | 14 +++++ .../examples/databases/delete-document.md | 15 +++++ .../examples/databases/delete-index.md | 15 +++++ .../server-swift/examples/databases/delete.md | 13 +++++ .../examples/databases/get-attribute.md | 15 +++++ .../examples/databases/get-collection.md | 14 +++++ .../examples/databases/get-document.md | 16 ++++++ .../examples/databases/get-index.md | 15 +++++ .../server-swift/examples/databases/get.md | 13 +++++ .../examples/databases/list-attributes.md | 15 +++++ .../examples/databases/list-collections.md | 15 +++++ .../examples/databases/list-documents.md | 15 +++++ .../examples/databases/list-indexes.md | 15 +++++ .../server-swift/examples/databases/list.md | 14 +++++ .../databases/update-boolean-attribute.md | 17 ++++++ .../examples/databases/update-collection.md | 18 ++++++ .../databases/update-datetime-attribute.md | 17 ++++++ .../examples/databases/update-document.md | 17 ++++++ .../databases/update-email-attribute.md | 17 ++++++ .../databases/update-enum-attribute.md | 18 ++++++ .../databases/update-float-attribute.md | 19 +++++++ .../databases/update-integer-attribute.md | 19 +++++++ .../examples/databases/update-ip-attribute.md | 17 ++++++ .../update-relationship-attribute.md | 17 ++++++ .../databases/update-string-attribute.md | 17 ++++++ .../databases/update-url-attribute.md | 17 ++++++ .../server-swift/examples/databases/update.md | 15 +++++ .../examples/functions/create-build.md | 15 +++++ .../examples/functions/create-deployment.md | 17 ++++++ .../examples/functions/create-execution.md | 20 +++++++ .../examples/functions/create-variable.md | 15 +++++ .../server-swift/examples/functions/create.md | 34 +++++++++++ .../examples/functions/delete-deployment.md | 14 +++++ .../examples/functions/delete-execution.md | 14 +++++ .../examples/functions/delete-variable.md | 14 +++++ .../server-swift/examples/functions/delete.md | 13 +++++ .../examples/functions/download-deployment.md | 14 +++++ .../examples/functions/get-deployment.md | 14 +++++ .../examples/functions/get-execution.md | 14 +++++ .../examples/functions/get-variable.md | 14 +++++ .../server-swift/examples/functions/get.md | 13 +++++ .../examples/functions/list-deployments.md | 15 +++++ .../examples/functions/list-executions.md | 15 +++++ .../examples/functions/list-runtimes.md | 11 ++++ .../examples/functions/list-variables.md | 13 +++++ .../server-swift/examples/functions/list.md | 14 +++++ .../functions/update-deployment-build.md | 14 +++++ .../examples/functions/update-deployment.md | 14 +++++ .../examples/functions/update-variable.md | 16 ++++++ .../server-swift/examples/functions/update.md | 30 ++++++++++ .../server-swift/examples/graphql/mutation.md | 13 +++++ .../server-swift/examples/graphql/query.md | 13 +++++ .../examples/health/get-antivirus.md | 11 ++++ .../server-swift/examples/health/get-cache.md | 11 ++++ .../examples/health/get-certificate.md | 13 +++++ .../server-swift/examples/health/get-d-b.md | 11 ++++ .../examples/health/get-failed-jobs.md | 15 +++++ .../examples/health/get-pub-sub.md | 11 ++++ .../examples/health/get-queue-builds.md | 13 +++++ .../examples/health/get-queue-certificates.md | 13 +++++ .../examples/health/get-queue-databases.md | 14 +++++ .../examples/health/get-queue-deletes.md | 13 +++++ .../examples/health/get-queue-functions.md | 13 +++++ .../examples/health/get-queue-logs.md | 13 +++++ .../examples/health/get-queue-mails.md | 13 +++++ .../examples/health/get-queue-messaging.md | 13 +++++ .../examples/health/get-queue-migrations.md | 13 +++++ .../examples/health/get-queue-usage-dump.md | 13 +++++ .../examples/health/get-queue-usage.md | 13 +++++ .../examples/health/get-queue-webhooks.md | 13 +++++ .../server-swift/examples/health/get-queue.md | 11 ++++ .../examples/health/get-storage-local.md | 11 ++++ .../examples/health/get-storage.md | 11 ++++ .../server-swift/examples/health/get-time.md | 11 ++++ .../1.6.x/server-swift/examples/health/get.md | 11 ++++ .../1.6.x/server-swift/examples/locale/get.md | 11 ++++ .../examples/locale/list-codes.md | 11 ++++ .../examples/locale/list-continents.md | 11 ++++ .../examples/locale/list-countries-e-u.md | 11 ++++ .../examples/locale/list-countries-phones.md | 11 ++++ .../examples/locale/list-countries.md | 11 ++++ .../examples/locale/list-currencies.md | 11 ++++ .../examples/locale/list-languages.md | 11 ++++ .../messaging/create-apns-provider.md | 20 +++++++ .../examples/messaging/create-email.md | 24 ++++++++ .../examples/messaging/create-fcm-provider.md | 16 ++++++ .../messaging/create-mailgun-provider.md | 22 +++++++ .../messaging/create-msg91provider.md | 18 ++++++ .../examples/messaging/create-push.md | 28 +++++++++ .../messaging/create-sendgrid-provider.md | 20 +++++++ .../examples/messaging/create-sms.md | 19 +++++++ .../messaging/create-smtp-provider.md | 27 +++++++++ .../examples/messaging/create-subscriber.md | 15 +++++ .../messaging/create-telesign-provider.md | 18 ++++++ .../messaging/create-textmagic-provider.md | 18 ++++++ .../examples/messaging/create-topic.md | 15 +++++ .../messaging/create-twilio-provider.md | 18 ++++++ .../messaging/create-vonage-provider.md | 18 ++++++ .../examples/messaging/delete-provider.md | 13 +++++ .../examples/messaging/delete-subscriber.md | 14 +++++ .../examples/messaging/delete-topic.md | 13 +++++ .../server-swift/examples/messaging/delete.md | 13 +++++ .../examples/messaging/get-message.md | 13 +++++ .../examples/messaging/get-provider.md | 13 +++++ .../examples/messaging/get-subscriber.md | 14 +++++ .../examples/messaging/get-topic.md | 13 +++++ .../examples/messaging/list-message-logs.md | 14 +++++ .../examples/messaging/list-messages.md | 14 +++++ .../examples/messaging/list-provider-logs.md | 14 +++++ .../examples/messaging/list-providers.md | 14 +++++ .../messaging/list-subscriber-logs.md | 14 +++++ .../examples/messaging/list-subscribers.md | 15 +++++ .../examples/messaging/list-targets.md | 14 +++++ .../examples/messaging/list-topic-logs.md | 14 +++++ .../examples/messaging/list-topics.md | 14 +++++ .../messaging/update-apns-provider.md | 20 +++++++ .../examples/messaging/update-email.md | 24 ++++++++ .../examples/messaging/update-fcm-provider.md | 16 ++++++ .../messaging/update-mailgun-provider.md | 22 +++++++ .../messaging/update-msg91provider.md | 18 ++++++ .../examples/messaging/update-push.md | 28 +++++++++ .../messaging/update-sendgrid-provider.md | 20 +++++++ .../examples/messaging/update-sms.md | 19 +++++++ .../messaging/update-smtp-provider.md | 27 +++++++++ .../messaging/update-telesign-provider.md | 18 ++++++ .../messaging/update-textmagic-provider.md | 18 ++++++ .../examples/messaging/update-topic.md | 15 +++++ .../messaging/update-twilio-provider.md | 18 ++++++ .../messaging/update-vonage-provider.md | 18 ++++++ .../examples/storage/create-bucket.md | 23 ++++++++ .../examples/storage/create-file.md | 16 ++++++ .../examples/storage/delete-bucket.md | 13 +++++ .../examples/storage/delete-file.md | 14 +++++ .../examples/storage/get-bucket.md | 13 +++++ .../examples/storage/get-file-download.md | 14 +++++ .../examples/storage/get-file-preview.md | 26 +++++++++ .../examples/storage/get-file-view.md | 14 +++++ .../server-swift/examples/storage/get-file.md | 14 +++++ .../examples/storage/list-buckets.md | 14 +++++ .../examples/storage/list-files.md | 15 +++++ .../examples/storage/update-bucket.md | 23 ++++++++ .../examples/storage/update-file.md | 16 ++++++ .../examples/teams/create-membership.md | 19 +++++++ .../server-swift/examples/teams/create.md | 15 +++++ .../examples/teams/delete-membership.md | 14 +++++ .../server-swift/examples/teams/delete.md | 13 +++++ .../examples/teams/get-membership.md | 14 +++++ .../server-swift/examples/teams/get-prefs.md | 13 +++++ .../1.6.x/server-swift/examples/teams/get.md | 13 +++++ .../examples/teams/list-memberships.md | 15 +++++ .../1.6.x/server-swift/examples/teams/list.md | 14 +++++ .../teams/update-membership-status.md | 16 ++++++ .../examples/teams/update-membership.md | 15 +++++ .../examples/teams/update-name.md | 14 +++++ .../examples/teams/update-prefs.md | 14 +++++ .../examples/users/create-argon2user.md | 16 ++++++ .../examples/users/create-bcrypt-user.md | 16 ++++++ .../examples/users/create-j-w-t.md | 15 +++++ .../examples/users/create-m-d5user.md | 16 ++++++ .../users/create-mfa-recovery-codes.md | 13 +++++ .../examples/users/create-p-h-pass-user.md | 16 ++++++ .../examples/users/create-s-h-a-user.md | 18 ++++++ .../users/create-scrypt-modified-user.md | 19 +++++++ .../examples/users/create-scrypt-user.md | 21 +++++++ .../examples/users/create-session.md | 13 +++++ .../examples/users/create-target.md | 19 +++++++ .../examples/users/create-token.md | 15 +++++ .../server-swift/examples/users/create.md | 17 ++++++ .../examples/users/delete-identity.md | 13 +++++ .../users/delete-mfa-authenticator.md | 15 +++++ .../examples/users/delete-session.md | 14 +++++ .../examples/users/delete-sessions.md | 13 +++++ .../examples/users/delete-target.md | 14 +++++ .../server-swift/examples/users/delete.md | 13 +++++ .../examples/users/get-mfa-recovery-codes.md | 13 +++++ .../server-swift/examples/users/get-prefs.md | 13 +++++ .../server-swift/examples/users/get-target.md | 14 +++++ .../1.6.x/server-swift/examples/users/get.md | 13 +++++ .../examples/users/list-identities.md | 14 +++++ .../server-swift/examples/users/list-logs.md | 14 +++++ .../examples/users/list-memberships.md | 13 +++++ .../examples/users/list-mfa-factors.md | 13 +++++ .../examples/users/list-sessions.md | 13 +++++ .../examples/users/list-targets.md | 14 +++++ .../1.6.x/server-swift/examples/users/list.md | 14 +++++ .../users/update-email-verification.md | 14 +++++ .../examples/users/update-email.md | 14 +++++ .../examples/users/update-labels.md | 14 +++++ .../users/update-mfa-recovery-codes.md | 13 +++++ .../server-swift/examples/users/update-mfa.md | 14 +++++ .../examples/users/update-name.md | 14 +++++ .../examples/users/update-password.md | 14 +++++ .../users/update-phone-verification.md | 14 +++++ .../examples/users/update-phone.md | 14 +++++ .../examples/users/update-prefs.md | 14 +++++ .../examples/users/update-status.md | 14 +++++ .../examples/users/update-target.md | 17 ++++++ src/Appwrite/Platform/Tasks/SDKs.php | 2 +- 4627 files changed, 68174 insertions(+), 1 deletion(-) create mode 100644 app/config/specs/swagger2-1.6.X-client.json create mode 100644 app/config/specs/swagger2-1.6.X-console.json create mode 100644 app/config/specs/swagger2-1.6.x-server.json create mode 100644 docs/examples/1.6.x/client-android/java/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-email-token.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-o-auth2session.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-push-target.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-recovery.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-session.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create-verification.md create mode 100644 docs/examples/1.6.x/client-android/java/account/create.md create mode 100644 docs/examples/1.6.x/client-android/java/account/delete-identity.md create mode 100644 docs/examples/1.6.x/client-android/java/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-android/java/account/delete-push-target.md create mode 100644 docs/examples/1.6.x/client-android/java/account/delete-session.md create mode 100644 docs/examples/1.6.x/client-android/java/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/client-android/java/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-android/java/account/get-prefs.md create mode 100644 docs/examples/1.6.x/client-android/java/account/get-session.md create mode 100644 docs/examples/1.6.x/client-android/java/account/get.md create mode 100644 docs/examples/1.6.x/client-android/java/account/list-identities.md create mode 100644 docs/examples/1.6.x/client-android/java/account/list-logs.md create mode 100644 docs/examples/1.6.x/client-android/java/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/client-android/java/account/list-sessions.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-email.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-name.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-password.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-phone.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-prefs.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-push-target.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-recovery.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-session.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-status.md create mode 100644 docs/examples/1.6.x/client-android/java/account/update-verification.md create mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-image.md create mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/client-android/java/databases/create-document.md create mode 100644 docs/examples/1.6.x/client-android/java/databases/delete-document.md create mode 100644 docs/examples/1.6.x/client-android/java/databases/get-document.md create mode 100644 docs/examples/1.6.x/client-android/java/databases/list-documents.md create mode 100644 docs/examples/1.6.x/client-android/java/databases/update-document.md create mode 100644 docs/examples/1.6.x/client-android/java/functions/create-execution.md create mode 100644 docs/examples/1.6.x/client-android/java/functions/get-execution.md create mode 100644 docs/examples/1.6.x/client-android/java/functions/list-executions.md create mode 100644 docs/examples/1.6.x/client-android/java/graphql/mutation.md create mode 100644 docs/examples/1.6.x/client-android/java/graphql/query.md create mode 100644 docs/examples/1.6.x/client-android/java/locale/get.md create mode 100644 docs/examples/1.6.x/client-android/java/locale/list-codes.md create mode 100644 docs/examples/1.6.x/client-android/java/locale/list-continents.md create mode 100644 docs/examples/1.6.x/client-android/java/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/client-android/java/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/client-android/java/locale/list-countries.md create mode 100644 docs/examples/1.6.x/client-android/java/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/client-android/java/locale/list-languages.md create mode 100644 docs/examples/1.6.x/client-android/java/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/client-android/java/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/client-android/java/storage/create-file.md create mode 100644 docs/examples/1.6.x/client-android/java/storage/delete-file.md create mode 100644 docs/examples/1.6.x/client-android/java/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/client-android/java/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/client-android/java/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/client-android/java/storage/get-file.md create mode 100644 docs/examples/1.6.x/client-android/java/storage/list-files.md create mode 100644 docs/examples/1.6.x/client-android/java/storage/update-file.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/create-membership.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/create.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/delete.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/get-membership.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/get.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/list.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/update-membership.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/update-name.md create mode 100644 docs/examples/1.6.x/client-android/java/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-email-token.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2session.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-push-target.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-recovery.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-session.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-verification.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/delete-identity.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/delete-push-target.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/delete-session.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/get-prefs.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/get-session.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/get.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/list-identities.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/list-logs.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/list-sessions.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-email.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-name.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-password.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-phone.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-prefs.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-push-target.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-recovery.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-session.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-status.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-verification.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-image.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/databases/create-document.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/databases/delete-document.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/databases/get-document.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/databases/list-documents.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/databases/update-document.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/functions/create-execution.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/functions/get-execution.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/functions/list-executions.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/graphql/mutation.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/graphql/query.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/get.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-codes.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-continents.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-countries.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-languages.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/create-file.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/delete-file.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/get-file.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/list-files.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/update-file.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/create-membership.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/create.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/delete.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/get-membership.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/get.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/list.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/update-membership.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/update-name.md create mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-o-auth2session.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-push-target.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/create.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/delete-push-target.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/get.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-push-target.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/client-apple/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/client-apple/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/client-apple/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/client-apple/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/client-apple/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/client-apple/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/client-apple/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/client-apple/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/client-apple/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/client-apple/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/client-apple/examples/locale/get.md create mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/client-apple/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/client-apple/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/client-apple/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/client-apple/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/client-apple/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/client-apple/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/client-apple/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/client-apple/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/client-apple/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/client-apple/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/create.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/get.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/list.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/client-apple/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2session.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-push-target.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/delete-push-target.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/get.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-push-target.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/get.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/create.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/get.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/list.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-push-target.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/delete-push-target.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/get.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-push-target.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/get.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/create.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/get.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/list.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2session.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-push-target.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/delete-push-target.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/get.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-push-target.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/get.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/create.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/get.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/list.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-o-auth2session.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-push-target.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/create.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/delete-push-target.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/get.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-push-target.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/client-rest/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/client-rest/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/client-rest/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/client-rest/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/client-rest/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/client-rest/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/client-rest/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/client-rest/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/client-rest/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/client-rest/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/client-rest/examples/locale/get.md create mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/client-rest/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/client-rest/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/client-rest/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/client-rest/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/client-rest/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/client-rest/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/client-rest/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/client-rest/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/client-rest/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/client-rest/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/create.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/get.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/list.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/client-rest/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-o-auth2session.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-push-target.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/create.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/delete-push-target.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/get.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-push-target.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/client-web/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/client-web/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/client-web/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/client-web/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/client-web/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/client-web/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/client-web/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/client-web/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/client-web/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/client-web/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/client-web/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/client-web/examples/locale/get.md create mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/client-web/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/client-web/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/client-web/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/client-web/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/client-web/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/client-web/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/client-web/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/client-web/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/client-web/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/client-web/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/create.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/get.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/list.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/client-web/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-o-auth2session.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-push-target.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/create.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete-push-target.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/get.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-push-target.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/console-cli/examples/assistant/chat.md create mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/console-cli/examples/console/variables.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-collection-usage.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-database-usage.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-usage.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-collection-logs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-document-logs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-logs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/create.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get-function-usage.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get-usage.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/list.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/console-cli/examples/functions/update.md create mode 100644 docs/examples/1.6.x/console-cli/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/console-cli/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/console-cli/examples/health/get.md create mode 100644 docs/examples/1.6.x/console-cli/examples/locale/get.md create mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/create-appwrite-migration.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-migration.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-o-auth-migration.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/create-n-host-migration.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/create-supabase-migration.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/delete-firebase-auth.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/delete.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get-appwrite-report.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report-o-auth.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get-n-host-report.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get-supabase-report.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/list-firebase-projects.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/list.md create mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/retry.md create mode 100644 docs/examples/1.6.x/console-cli/examples/project/create-variable.md create mode 100644 docs/examples/1.6.x/console-cli/examples/project/delete-variable.md create mode 100644 docs/examples/1.6.x/console-cli/examples/project/get-usage.md create mode 100644 docs/examples/1.6.x/console-cli/examples/project/get-variable.md create mode 100644 docs/examples/1.6.x/console-cli/examples/project/list-variables.md create mode 100644 docs/examples/1.6.x/console-cli/examples/project/update-variable.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create-j-w-t.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create-key.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create-platform.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create-smtp-test.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create-webhook.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete-email-template.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete-key.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete-platform.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete-sms-template.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete-webhook.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get-email-template.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get-key.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get-platform.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get-sms-template.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get-webhook.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/list-keys.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/list-platforms.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/list-webhooks.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/list.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-api-status-all.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-api-status.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-duration.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-limit.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-dictionary.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-history.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-sessions-limit.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-status.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-email-template.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-key.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-mock-numbers.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-o-auth2.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-personal-data-check.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-platform.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-service-status-all.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-service-status.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-session-alerts.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-sms-template.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-smtp.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-team.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-webhook-signature.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-webhook.md create mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update.md create mode 100644 docs/examples/1.6.x/console-cli/examples/proxy/create-rule.md create mode 100644 docs/examples/1.6.x/console-cli/examples/proxy/delete-rule.md create mode 100644 docs/examples/1.6.x/console-cli/examples/proxy/get-rule.md create mode 100644 docs/examples/1.6.x/console-cli/examples/proxy/list-rules.md create mode 100644 docs/examples/1.6.x/console-cli/examples/proxy/update-rule-verification.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-bucket-usage.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-usage.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/console-cli/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/create.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/get.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/list-logs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/list.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/console-cli/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/create.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/get-usage.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/get.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/list.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-target.md create mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/create-repository-detection.md create mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/create-repository.md create mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/delete-installation.md create mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/get-installation.md create mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/get-repository-contents.md create mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/get-repository.md create mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/list-installations.md create mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/list-repositories.md create mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/list-repository-branches.md create mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/update-external-deployments.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-o-auth2session.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-push-target.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/create.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/delete-push-target.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/delete.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/get.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-push-target.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/console-web/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/console-web/examples/assistant/chat.md create mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/console-web/examples/console/variables.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/create.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-collection-usage.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-database-usage.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-usage.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/get.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-collection-logs.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-document-logs.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-logs.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/list.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/console-web/examples/databases/update.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/create.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/get-function-usage.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/get-usage.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/get.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/list.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/console-web/examples/functions/update.md create mode 100644 docs/examples/1.6.x/console-web/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/console-web/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/console-web/examples/health/get.md create mode 100644 docs/examples/1.6.x/console-web/examples/locale/get.md create mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/create-appwrite-migration.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/create-firebase-migration.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/create-firebase-o-auth-migration.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/create-n-host-migration.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/create-supabase-migration.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/delete-firebase-auth.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/delete.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get-appwrite-report.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report-o-auth.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get-n-host-report.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get-supabase-report.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/list-firebase-projects.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/list.md create mode 100644 docs/examples/1.6.x/console-web/examples/migrations/retry.md create mode 100644 docs/examples/1.6.x/console-web/examples/project/create-variable.md create mode 100644 docs/examples/1.6.x/console-web/examples/project/delete-variable.md create mode 100644 docs/examples/1.6.x/console-web/examples/project/get-usage.md create mode 100644 docs/examples/1.6.x/console-web/examples/project/get-variable.md create mode 100644 docs/examples/1.6.x/console-web/examples/project/list-variables.md create mode 100644 docs/examples/1.6.x/console-web/examples/project/update-variable.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/create-j-w-t.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/create-key.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/create-platform.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/create-smtp-test.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/create-webhook.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/create.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete-email-template.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete-key.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete-platform.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete-sms-template.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete-webhook.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/get-email-template.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/get-key.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/get-platform.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/get-sms-template.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/get-webhook.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/get.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/list-keys.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/list-platforms.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/list-webhooks.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/list.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-api-status-all.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-api-status.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-duration.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-limit.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-password-dictionary.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-password-history.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-sessions-limit.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-status.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-email-template.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-key.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-mock-numbers.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-o-auth2.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-personal-data-check.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-platform.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-service-status-all.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-service-status.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-session-alerts.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-sms-template.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-smtp.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-team.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-webhook-signature.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-webhook.md create mode 100644 docs/examples/1.6.x/console-web/examples/projects/update.md create mode 100644 docs/examples/1.6.x/console-web/examples/proxy/create-rule.md create mode 100644 docs/examples/1.6.x/console-web/examples/proxy/delete-rule.md create mode 100644 docs/examples/1.6.x/console-web/examples/proxy/get-rule.md create mode 100644 docs/examples/1.6.x/console-web/examples/proxy/list-rules.md create mode 100644 docs/examples/1.6.x/console-web/examples/proxy/update-rule-verification.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-bucket-usage.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-usage.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/console-web/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/create.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/get.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/list-logs.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/list.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/console-web/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/create.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/delete.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/get-usage.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/get.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/list.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/console-web/examples/users/update-target.md create mode 100644 docs/examples/1.6.x/console-web/examples/vcs/create-repository-detection.md create mode 100644 docs/examples/1.6.x/console-web/examples/vcs/create-repository.md create mode 100644 docs/examples/1.6.x/console-web/examples/vcs/delete-installation.md create mode 100644 docs/examples/1.6.x/console-web/examples/vcs/get-installation.md create mode 100644 docs/examples/1.6.x/console-web/examples/vcs/get-repository-contents.md create mode 100644 docs/examples/1.6.x/console-web/examples/vcs/get-repository.md create mode 100644 docs/examples/1.6.x/console-web/examples/vcs/list-installations.md create mode 100644 docs/examples/1.6.x/console-web/examples/vcs/list-repositories.md create mode 100644 docs/examples/1.6.x/console-web/examples/vcs/list-repository-branches.md create mode 100644 docs/examples/1.6.x/console-web/examples/vcs/update-external-deployments.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/create.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/get.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/get.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/list.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/create.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/get.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/list.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-dart/examples/functions/update.md create mode 100644 docs/examples/1.6.x/server-dart/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/server-dart/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/server-dart/examples/health/get.md create mode 100644 docs/examples/1.6.x/server-dart/examples/locale/get.md create mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-dart/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/create.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/get.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/list.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-dart/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/create.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/get.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/list.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-target.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/create.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/get.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/get.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/list.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/create.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/get.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/list.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-deno/examples/functions/update.md create mode 100644 docs/examples/1.6.x/server-deno/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/server-deno/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/server-deno/examples/health/get.md create mode 100644 docs/examples/1.6.x/server-deno/examples/locale/get.md create mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-deno/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/create.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/get.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/list.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-deno/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/create.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/get.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/list.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-target.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/get.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/get.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/list.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/create.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/get.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/list.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/update.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/get.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/create.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/get.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/list.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/get.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-target.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/get.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/get.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/list.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/create.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/get.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/list.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/update.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/get.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/create.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/get.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/list.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/get.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-target.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/get-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-email.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-name.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-password.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-status.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/delete.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/list.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/create.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/delete.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/list.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/update.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/graphql/mutation.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/graphql/query.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-time.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/create.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/delete.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/list.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-target.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-token.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/get-target.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-email.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-name.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-password.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-status.md create mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-target.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/get-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-email.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-name.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-password.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-status.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/delete.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/list.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/create.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/delete.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/list.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/update.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/graphql/mutation.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/graphql/query.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-time.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/create.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/delete.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/list.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-target.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-token.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/get-target.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/get.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-email.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-name.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-password.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-status.md create mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-target.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/get.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/get.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/list.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/create.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/get.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/list.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/update.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/get.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/create.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/get.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/list.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/get.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-target.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/create.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/get.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/server-php/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/create.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/get.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/list.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-php/examples/databases/update.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/create.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/get.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/list.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-php/examples/functions/update.md create mode 100644 docs/examples/1.6.x/server-php/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/server-php/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/server-php/examples/health/get.md create mode 100644 docs/examples/1.6.x/server-php/examples/locale/get.md create mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-php/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/create.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/get.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/list.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-php/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/create.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/delete.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/get.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/list.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/server-php/examples/users/update-target.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/create.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/get.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/server-python/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/create.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/get.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/list.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-python/examples/databases/update.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/create.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/get.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/list.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-python/examples/functions/update.md create mode 100644 docs/examples/1.6.x/server-python/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/server-python/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/server-python/examples/health/get.md create mode 100644 docs/examples/1.6.x/server-python/examples/locale/get.md create mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-python/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/create.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/get.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/list.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-python/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/create.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/delete.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/get.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/list.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/server-python/examples/users/update-target.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/create.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/get.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/get.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/list.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/create.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/get.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/list.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-rest/examples/functions/update.md create mode 100644 docs/examples/1.6.x/server-rest/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/server-rest/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/server-rest/examples/health/get.md create mode 100644 docs/examples/1.6.x/server-rest/examples/locale/get.md create mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-rest/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/create.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/get.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/list.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-rest/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/create.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/get.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/list.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-target.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/get.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/get.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/list.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/create.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/get.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/list.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/update.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/get.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/create.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/get.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/list.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/get.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-target.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-anonymous-session.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-email-password-session.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-email-token.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-magic-u-r-l-token.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-o-auth2token.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-phone-token.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-phone-verification.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-recovery.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-session.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-verification.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/create.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/delete-identity.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/delete-session.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/get-prefs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/get-session.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/get.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/list-identities.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/list-logs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/list-sessions.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-email.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-m-f-a.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-magic-u-r-l-session.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-mfa-challenge.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-name.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-password.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-phone-session.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-phone.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-prefs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-recovery.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-session.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-status.md create mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-verification.md create mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-browser.md create mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-credit-card.md create mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-favicon.md create mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-flag.md create mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-image.md create mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-initials.md create mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-q-r.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-collection.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-document.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-email-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-float-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-index.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-string-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-url-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/delete-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/delete-collection.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/delete-document.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/delete-index.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/delete.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/get-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/get-collection.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/get-document.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/get-index.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/get.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/list-attributes.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/list-collections.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/list-documents.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/list-indexes.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/list.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-boolean-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-collection.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-datetime-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-document.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-email-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-enum-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-float-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-integer-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-ip-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-relationship-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-string-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-url-attribute.md create mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/create-build.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/create-deployment.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/create-execution.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/create-variable.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/create.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/delete-deployment.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/delete-execution.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/delete-variable.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/delete.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/download-deployment.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/get-deployment.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/get-execution.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/get-variable.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/get.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/list-deployments.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/list-executions.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/list-runtimes.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/list-variables.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/list.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/update-deployment-build.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/update-deployment.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/update-variable.md create mode 100644 docs/examples/1.6.x/server-swift/examples/functions/update.md create mode 100644 docs/examples/1.6.x/server-swift/examples/graphql/mutation.md create mode 100644 docs/examples/1.6.x/server-swift/examples/graphql/query.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-antivirus.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-cache.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-certificate.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-d-b.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-failed-jobs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-pub-sub.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-builds.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-certificates.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-databases.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-deletes.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-functions.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-logs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-mails.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-messaging.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-migrations.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-usage-dump.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-usage.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-webhooks.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-storage-local.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-storage.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-time.md create mode 100644 docs/examples/1.6.x/server-swift/examples/health/get.md create mode 100644 docs/examples/1.6.x/server-swift/examples/locale/get.md create mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-codes.md create mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-continents.md create mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-countries-e-u.md create mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-countries-phones.md create mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-countries.md create mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-currencies.md create mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-languages.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-apns-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-email.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-msg91provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-push.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-sms.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-subscriber.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-topic.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/delete-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/delete-subscriber.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/delete-topic.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/delete.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/get-message.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/get-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/get-subscriber.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/get-topic.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-message-logs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-messages.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-provider-logs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-providers.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-subscriber-logs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-subscribers.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-targets.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-topic-logs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-topics.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-apns-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-email.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-fcm-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-mailgun-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-msg91provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-push.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-sendgrid-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-sms.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-smtp-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-telesign-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-textmagic-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-topic.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-twilio-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-vonage-provider.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/create-bucket.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/create-file.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/delete-bucket.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/delete-file.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/get-bucket.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/get-file-download.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/get-file-preview.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/get-file-view.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/get-file.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/list-buckets.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/list-files.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/update-bucket.md create mode 100644 docs/examples/1.6.x/server-swift/examples/storage/update-file.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/create-membership.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/create.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/delete-membership.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/delete.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/get-membership.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/get-prefs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/get.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/list-memberships.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/list.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/update-membership-status.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/update-membership.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/update-name.md create mode 100644 docs/examples/1.6.x/server-swift/examples/teams/update-prefs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-argon2user.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-bcrypt-user.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-j-w-t.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-m-d5user.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-p-h-pass-user.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-s-h-a-user.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-scrypt-modified-user.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-scrypt-user.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-session.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-target.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-token.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/create.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete-identity.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete-mfa-authenticator.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete-session.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete-sessions.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete-target.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/get-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/get-prefs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/get-target.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/get.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-identities.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-logs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-memberships.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-mfa-factors.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-sessions.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-targets.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/list.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-email-verification.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-email.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-labels.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-mfa-recovery-codes.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-mfa.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-name.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-password.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-phone-verification.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-phone.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-prefs.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-status.md create mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-target.md diff --git a/app/config/specs/swagger2-1.6.X-client.json b/app/config/specs/swagger2-1.6.X-client.json new file mode 100644 index 0000000000..20d8c0a6ff --- /dev/null +++ b/app/config/specs/swagger2-1.6.X-client.json @@ -0,0 +1 @@ +{"swagger":"2.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"host":"cloud.appwrite.io","basePath":"\/v1","schemes":["https"],"consumes":["application\/json","multipart\/form-data"],"produces":["application\/json"],"securityDefinitions":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header","x-appwrite":{"demo":"<YOUR_JWT>"}},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Session":{"type":"apiKey","name":"X-Appwrite-Session","description":"The user session to authenticate with","in":"header"}},"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","schema":{"$ref":"#\/definitions\/mfaType"}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","schema":{"$ref":"#\/definitions\/mfaChallenge"}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","default":null,"x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}]},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","default":null,"x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["challengeId","otp"]}}]}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","default":"","x-example":"password"}},"required":["password"]}}]}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["phone","password"]}}]}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["email","url"]}}]},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","default":null,"x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null}},"required":["userId","secret","password"]}}]}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 session","operationId":"accountCreateOAuth2Session","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Session","weight":18,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/targets\/push":{"post":{"summary":"Create push target","operationId":"accountCreatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createPushTarget","weight":53,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"}},"required":["targetId","identifier"]}}]}},"\/account\/targets\/{targetId}\/push":{"put":{"summary":"Update push target","operationId":"accountUpdatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updatePushTarget","weight":54,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"}},"required":["identifier"]}}]},"delete":{"summary":"Delete push target","operationId":"accountDeletePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deletePushTarget","weight":55,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","default":"","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"}},"required":["userId","phone"]}}]}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["url"]}}]},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"type":"string","x-example":"<NAME>","default":"","in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"type":"string","default":"","in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"type":"string","x-example":"<TEXT>","in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":1,"default":400,"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"type":"integer","format":"int32","x-example":0,"default":1,"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"type":"boolean","x-example":false,"default":false,"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","schema":{"$ref":"#\/definitions\/documentList"}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","default":{},"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","default":[],"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","schema":{"$ref":"#\/definitions\/executionList"}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","default":"","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","default":false,"x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","default":"\/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","default":"POST","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","default":[],"x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","schema":{"$ref":"#\/definitions\/locale"}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","schema":{"$ref":"#\/definitions\/localeCodeList"}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","schema":{"$ref":"#\/definitions\/continentList"}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","schema":{"$ref":"#\/definitions\/phoneList"}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","schema":{"$ref":"#\/definitions\/currencyList"}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","schema":{"$ref":"#\/definitions\/languageList"}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Session":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","default":null,"x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","default":null,"x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}]}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Session":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","schema":{"$ref":"#\/definitions\/fileList"}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"x-upload-id":true,"type":"string","x-example":"<FILE_ID>","in":"formData"},{"name":"file","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","required":true,"type":"file","in":"formData"},{"name":"permissions","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"x-example":"[\"read(\"any\")\"]","in":"formData"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","consumes":["application\/json"],"produces":["image\/*"],"tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center","in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"type":"number","format":"float","x-example":0,"default":1,"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"type":"integer","format":"int32","x-example":-360,"default":0,"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":"","in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","schema":{"$ref":"#\/definitions\/teamList"}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":["owner"],"x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}]}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]},"delete":{"summary":"Delete team","operationId":"teamsDelete","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","default":"","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","default":"","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","default":"","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["roles"]}}]}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["roles"]}}]},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"definitions":{"any":{"description":"Any","type":"object","additionalProperties":true},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"type":"object","$ref":"#\/definitions\/document"},"x-example":""}},"required":["total","documents"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"type":"object","$ref":"#\/definitions\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"type":"object","$ref":"#\/definitions\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"type":"object","$ref":"#\/definitions\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"type":"object","$ref":"#\/definitions\/file"},"x-example":""}},"required":["total","files"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"type":"object","$ref":"#\/definitions\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"type":"object","$ref":"#\/definitions\/membership"},"x-example":""}},"required":["total","memberships"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"type":"object","$ref":"#\/definitions\/execution"},"x-example":""}},"required":["total","executions"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"type":"object","$ref":"#\/definitions\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"type":"object","$ref":"#\/definitions\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"type":"object","$ref":"#\/definitions\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"type":"object","$ref":"#\/definitions\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"type":"object","$ref":"#\/definitions\/phone"},"x-example":""}},"required":["total","phones"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"type":"object","$ref":"#\/definitions\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","x-nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","x-nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"x-oneOf":[{"$ref":"#\/definitions\/algoArgon2"},{"$ref":"#\/definitions\/algoScrypt"},{"$ref":"#\/definitions\/algoScryptModified"},{"$ref":"#\/definitions\/algoBcrypt"},{"$ref":"#\/definitions\/algoPhpass"},{"$ref":"#\/definitions\/algoSha"},{"$ref":"#\/definitions\/algoMd5"}]},"x-nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"type":"object","$ref":"#\/definitions\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","x-nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file diff --git a/app/config/specs/swagger2-1.6.X-console.json b/app/config/specs/swagger2-1.6.X-console.json new file mode 100644 index 0000000000..61993ac308 --- /dev/null +++ b/app/config/specs/swagger2-1.6.X-console.json @@ -0,0 +1 @@ +{"swagger":"2.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"host":"cloud.appwrite.io","basePath":"\/v1","schemes":["https"],"consumes":["application\/json","multipart\/form-data"],"produces":["application\/json"],"securityDefinitions":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"Key":{"type":"apiKey","name":"X-Appwrite-Key","description":"Your secret API key","in":"header","x-appwrite":{"demo":"<YOUR_API_KEY>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header","x-appwrite":{"demo":"<YOUR_JWT>"}},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Mode":{"type":"apiKey","name":"X-Appwrite-Mode","description":"","in":"header","x-appwrite":{"demo":""}}},"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]},"delete":{"summary":"Delete account","operationId":"accountDelete","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete the currently logged in user.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":9,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","schema":{"$ref":"#\/definitions\/mfaType"}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","schema":{"$ref":"#\/definitions\/mfaChallenge"}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","default":null,"x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}]},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","default":null,"x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["challengeId","otp"]}}]}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","default":"","x-example":"password"}},"required":["password"]}}]}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["phone","password"]}}]}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["email","url"]}}]},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","default":null,"x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null}},"required":["userId","secret","password"]}}]}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 session","operationId":"accountCreateOAuth2Session","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Session","weight":18,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]}},"\/account\/targets\/push":{"post":{"summary":"Create push target","operationId":"accountCreatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createPushTarget","weight":53,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"}},"required":["targetId","identifier"]}}]}},"\/account\/targets\/{targetId}\/push":{"put":{"summary":"Update push target","operationId":"accountUpdatePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updatePushTarget","weight":54,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"}},"required":["identifier"]}}]},"delete":{"summary":"Delete push target","operationId":"accountDeletePushTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deletePushTarget","weight":55,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-push-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","default":"","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"}},"required":["userId","phone"]}}]}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["url"]}}]},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"type":"string","x-example":"<NAME>","default":"","in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"type":"string","default":"","in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"type":"string","x-example":"<TEXT>","in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":1,"default":400,"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"type":"integer","format":"int32","x-example":0,"default":1,"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"type":"boolean","x-example":false,"default":false,"in":"query"}]}},"\/console\/assistant":{"post":{"summary":"Ask Query","operationId":"assistantChat","consumes":["application\/json"],"produces":["text\/plain"],"tags":["assistant"],"description":"","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"chat","weight":328,"cookies":false,"type":"","deprecated":false,"demo":"assistant\/chat.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/assistant\/chat.md","rate-limit":15,"rate-time":3600,"rate-key":"userId:{userId}","scope":"assistant.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prompt":{"type":"string","description":"Prompt. A string containing questions asked to the AI assistant.","default":null,"x-example":"<PROMPT>"}},"required":["prompt"]}}]}},"\/console\/variables":{"get":{"summary":"Get variables","operationId":"consoleVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["console"],"description":"Get all Environment Variables that are relevant for the console.","responses":{"200":{"description":"Console Variables","schema":{"$ref":"#\/definitions\/consoleVariables"}}},"x-appwrite":{"method":"variables","weight":327,"cookies":false,"type":"","deprecated":false,"demo":"console\/variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/console\/variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/databases":{"get":{"summary":"List databases","operationId":"databasesList","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.","responses":{"200":{"description":"Databases List","schema":{"$ref":"#\/definitions\/databaseList"}}},"x-appwrite":{"method":"list","weight":69,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create database","operationId":"databasesCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Database.\n","responses":{"201":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"create","weight":68,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"databaseId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DATABASE_ID>"},"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["databaseId","name"]}}]}},"\/databases\/usage":{"get":{"summary":"Get databases usage stats","operationId":"databasesGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"","responses":{"200":{"description":"UsageDatabases","schema":{"$ref":"#\/definitions\/usageDatabases"}}},"x-appwrite":{"method":"getUsage","weight":113,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"`Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/databases\/{databaseId}":{"get":{"summary":"Get database","operationId":"databasesGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"get","weight":70,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]},"put":{"summary":"Update database","operationId":"databasesUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a database by its unique ID.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"update","weight":72,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete database","operationId":"databasesDelete","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":73,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections":{"get":{"summary":"List collections","operationId":"databasesListCollections","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.","responses":{"200":{"description":"Collections List","schema":{"$ref":"#\/definitions\/collectionList"}}},"x-appwrite":{"method":"listCollections","weight":75,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collections.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"queries","description":"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: name, enabled, documentSecurity","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create collection","operationId":"databasesCreateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"createCollection","weight":74,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"collectionId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<COLLECTION_ID>"},"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["collectionId","name"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}":{"get":{"summary":"Get collection","operationId":"databasesGetCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"getCollection","weight":76,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]},"put":{"summary":"Update collection","operationId":"databasesUpdateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a collection by its unique ID.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"updateCollection","weight":78,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete collection","operationId":"databasesDeleteCollection","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteCollection","weight":79,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes":{"get":{"summary":"List attributes","operationId":"databasesListAttributes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List attributes in the collection.","responses":{"200":{"description":"Attributes List","schema":{"$ref":"#\/definitions\/attributeList"}}},"x-appwrite":{"method":"listAttributes","weight":90,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-attributes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, size, required, array, status, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean":{"post":{"summary":"Create boolean attribute","operationId":"databasesCreateBooleanAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a boolean attribute.\n","responses":{"202":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"createBooleanAttribute","weight":87,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}":{"patch":{"summary":"Update boolean attribute","operationId":"databasesUpdateBooleanAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a boolean attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"updateBooleanAttribute","weight":99,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime":{"post":{"summary":"Create datetime attribute","operationId":"databasesCreateDatetimeAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a date time attribute according to the ISO 8601 standard.","responses":{"202":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"createDatetimeAttribute","weight":88,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}":{"patch":{"summary":"Update dateTime attribute","operationId":"databasesUpdateDatetimeAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a date time attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"updateDatetimeAttribute","weight":100,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email":{"post":{"summary":"Create email attribute","operationId":"databasesCreateEmailAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an email attribute.\n","responses":{"202":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"createEmailAttribute","weight":81,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}":{"patch":{"summary":"Update email attribute","operationId":"databasesUpdateEmailAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an email attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"updateEmailAttribute","weight":93,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum":{"post":{"summary":"Create enum attribute","operationId":"databasesCreateEnumAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n","responses":{"202":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"createEnumAttribute","weight":82,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","elements","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}":{"patch":{"summary":"Update enum attribute","operationId":"databasesUpdateEnumAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an enum attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"updateEnumAttribute","weight":94,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["elements","required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float":{"post":{"summary":"Create float attribute","operationId":"databasesCreateFloatAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a float attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"createFloatAttribute","weight":86,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float\/{key}":{"patch":{"summary":"Update float attribute","operationId":"databasesUpdateFloatAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a float attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"updateFloatAttribute","weight":98,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer":{"post":{"summary":"Create integer attribute","operationId":"databasesCreateIntegerAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an integer attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"createIntegerAttribute","weight":85,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer\/{key}":{"patch":{"summary":"Update integer attribute","operationId":"databasesUpdateIntegerAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an integer attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"updateIntegerAttribute","weight":97,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip":{"post":{"summary":"Create IP address attribute","operationId":"databasesCreateIpAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create IP address attribute.\n","responses":{"202":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"createIpAttribute","weight":83,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}":{"patch":{"summary":"Update IP address attribute","operationId":"databasesUpdateIpAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an ip attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"updateIpAttribute","weight":95,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship":{"post":{"summary":"Create relationship attribute","operationId":"databasesCreateRelationshipAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"202":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"createRelationshipAttribute","weight":89,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"relatedCollectionId":{"type":"string","description":"Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","default":null,"x-example":"<RELATED_COLLECTION_ID>"},"type":{"type":"string","description":"Relation type","default":null,"x-example":"oneToOne","enum":["oneToOne","manyToOne","manyToMany","oneToMany"],"x-enum-name":"RelationshipType","x-enum-keys":[]},"twoWay":{"type":"boolean","description":"Is Two Way?","default":false,"x-example":false},"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"twoWayKey":{"type":"string","description":"Two Way Attribute Key.","default":null,"x-example":null},"onDelete":{"type":"string","description":"Constraints option","default":"restrict","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}},"required":["relatedCollectionId","type"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string":{"post":{"summary":"Create string attribute","operationId":"databasesCreateStringAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a string attribute.\n","responses":{"202":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"createStringAttribute","weight":80,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"size":{"type":"integer","description":"Attribute size for text attributes, in number of characters.","default":null,"x-example":1},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false},"encrypt":{"type":"boolean","description":"Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.","default":false,"x-example":false}},"required":["key","size","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}":{"patch":{"summary":"Update string attribute","operationId":"databasesUpdateStringAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a string attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"updateStringAttribute","weight":92,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url":{"post":{"summary":"Create URL attribute","operationId":"databasesCreateUrlAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a URL attribute.\n","responses":{"202":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"createUrlAttribute","weight":84,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}":{"patch":{"summary":"Update URL attribute","operationId":"databasesUpdateUrlAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an url attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"updateUrlAttribute","weight":96,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}":{"get":{"summary":"Get attribute","operationId":"databasesGetAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get attribute by ID.","responses":{"200":{"description":"AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString","schema":{"x-oneOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]}}},"x-appwrite":{"method":"getAttribute","weight":91,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete attribute","operationId":"databasesDeleteAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Deletes an attribute.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteAttribute","weight":102,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship":{"patch":{"summary":"Update relationship attribute","operationId":"databasesUpdateRelationshipAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"200":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"updateRelationshipAttribute","weight":101,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"onDelete":{"type":"string","description":"Constraints option","default":null,"x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}}}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","schema":{"$ref":"#\/definitions\/documentList"}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","default":{},"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","default":[],"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs":{"get":{"summary":"List document logs","operationId":"databasesListDocumentLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get the document activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listDocumentLogs","weight":110,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-document-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes":{"get":{"summary":"List indexes","operationId":"databasesListIndexes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List indexes in the collection.","responses":{"200":{"description":"Indexes List","schema":{"$ref":"#\/definitions\/indexList"}}},"x-appwrite":{"method":"listIndexes","weight":104,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-indexes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, status, attributes, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create index","operationId":"databasesCreateIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.","responses":{"202":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"createIndex","weight":103,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Index Key.","default":null,"x-example":null},"type":{"type":"string","description":"Index type.","default":null,"x-example":"key","enum":["key","fulltext","unique"],"x-enum-name":"IndexType","x-enum-keys":[]},"attributes":{"type":"array","description":"Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"orders":{"type":"array","description":"Array of index orders. Maximum of 100 orders are allowed.","default":[],"x-example":null,"items":{"type":"string"}}},"required":["key","type","attributes"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}":{"get":{"summary":"Get index","operationId":"databasesGetIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get index by ID.","responses":{"200":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"getIndex","weight":105,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete index","operationId":"databasesDeleteIndex","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete an index.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIndex","weight":106,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/logs":{"get":{"summary":"List collection logs","operationId":"databasesListCollectionLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get the collection activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listCollectionLogs","weight":77,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collection-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/usage":{"get":{"summary":"Get collection usage stats","operationId":"databasesGetCollectionUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"","responses":{"200":{"description":"UsageCollection","schema":{"$ref":"#\/definitions\/usageCollection"}}},"x-appwrite":{"method":"getCollectionUsage","weight":115,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]}},"\/databases\/{databaseId}\/logs":{"get":{"summary":"List database logs","operationId":"databasesListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get the database activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":71,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/usage":{"get":{"summary":"Get database usage stats","operationId":"databasesGetDatabaseUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"","responses":{"200":{"description":"UsageDatabase","schema":{"$ref":"#\/definitions\/usageDatabase"}}},"x-appwrite":{"method":"getDatabaseUsage","weight":114,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-database-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"range","description":"`Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"DatabaseUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/functions":{"get":{"summary":"List functions","operationId":"functionsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's functions. You can use the query params to filter your results.","responses":{"200":{"description":"Functions List","schema":{"$ref":"#\/definitions\/functionList"}}},"x-appwrite":{"method":"list","weight":287,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create function","operationId":"functionsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.","responses":{"201":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"create","weight":286,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"functionId":{"type":"string","description":"Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<FUNCTION_ID>"},"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":null,"x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Function maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Control System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function.","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function.","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"},"templateRepository":{"type":"string","description":"Repository name of the template.","default":"","x-example":"<TEMPLATE_REPOSITORY>"},"templateOwner":{"type":"string","description":"The name of the owner of the template.","default":"","x-example":"<TEMPLATE_OWNER>"},"templateRootDirectory":{"type":"string","description":"Path to function code in the template repo.","default":"","x-example":"<TEMPLATE_ROOT_DIRECTORY>"},"templateBranch":{"type":"string","description":"Production branch for the repo linked to the function template.","default":"","x-example":"<TEMPLATE_BRANCH>"}},"required":["functionId","name","runtime"]}}]}},"\/functions\/runtimes":{"get":{"summary":"List runtimes","operationId":"functionsListRuntimes","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all runtimes that are currently active on your instance.","responses":{"200":{"description":"Runtimes List","schema":{"$ref":"#\/definitions\/runtimeList"}}},"x-appwrite":{"method":"listRuntimes","weight":288,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-runtimes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-runtimes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/functions\/usage":{"get":{"summary":"Get functions usage","operationId":"functionsGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"UsageFunctions","schema":{"$ref":"#\/definitions\/usageFunctions"}}},"x-appwrite":{"method":"getUsage","weight":291,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"FunctionUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/functions\/{functionId}":{"get":{"summary":"Get function","operationId":"functionsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"get","weight":289,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"put":{"summary":"Update function","operationId":"functionsUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"update","weight":292,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":"","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Controle System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"}},"required":["name"]}}]},"delete":{"summary":"Delete function","operationId":"functionsDelete","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":295,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments":{"get":{"summary":"List deployments","operationId":"functionsListDeployments","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's code deployments. You can use the query params to filter your results.","responses":{"200":{"description":"Deployments List","schema":{"$ref":"#\/definitions\/deploymentList"}}},"x-appwrite":{"method":"listDeployments","weight":297,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: size, buildId, activate, entrypoint, commands","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create deployment","operationId":"functionsCreateDeployment","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.","responses":{"202":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"createDeployment","weight":296,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":true,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"entrypoint","description":"Entrypoint File.","required":false,"type":"string","x-example":"<ENTRYPOINT>","in":"formData"},{"name":"commands","description":"Build Commands.","required":false,"type":"string","x-example":"<COMMANDS>","in":"formData"},{"name":"code","description":"Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.","required":true,"type":"file","in":"formData"},{"name":"activate","description":"Automatically activate the deployment when it is finished building.","required":true,"type":"boolean","x-example":false,"in":"formData"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}":{"get":{"summary":"Get deployment","operationId":"functionsGetDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a code deployment by its unique ID.","responses":{"200":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"getDeployment","weight":298,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"patch":{"summary":"Update function deployment","operationId":"functionsUpdateDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"updateDeployment","weight":294,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"delete":{"summary":"Delete deployment","operationId":"functionsDeleteDeployment","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a code deployment by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDeployment","weight":299,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/build":{"post":{"summary":"Rebuild deployment","operationId":"functionsCreateBuild","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createBuild","weight":300,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"buildId":{"type":"string","description":"Build unique ID.","default":"","x-example":"<BUILD_ID>"}}}}]},"patch":{"summary":"Cancel deployment","operationId":"functionsUpdateDeploymentBuild","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"Build","schema":{"$ref":"#\/definitions\/build"}}},"x-appwrite":{"method":"updateDeploymentBuild","weight":301,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/download":{"get":{"summary":"Download Deployment","operationId":"functionsDownloadDeployment","consumes":["application\/json"],"produces":["*\/*"],"tags":["functions"],"description":"Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"downloadDeployment","weight":293,"cookies":false,"type":"location","deprecated":false,"demo":"functions\/download-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/download-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","schema":{"$ref":"#\/definitions\/executionList"}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","default":"","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","default":false,"x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","default":"\/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","default":"POST","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","default":[],"x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]},"delete":{"summary":"Delete execution","operationId":"functionsDeleteExecution","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function execution by its unique ID.\n","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteExecution","weight":305,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/usage":{"get":{"summary":"Get function usage","operationId":"functionsGetFunctionUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"UsageFunction","schema":{"$ref":"#\/definitions\/usageFunction"}}},"x-appwrite":{"method":"getFunctionUsage","weight":290,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-function-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"FunctionUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/functions\/{functionId}\/variables":{"get":{"summary":"List variables","operationId":"functionsListVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all variables of a specific function.","responses":{"200":{"description":"Variables List","schema":{"$ref":"#\/definitions\/variableList"}}},"x-appwrite":{"method":"listVariables","weight":307,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"post":{"summary":"Create variable","operationId":"functionsCreateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.","responses":{"201":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"createVariable","weight":306,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key","value"]}}]}},"\/functions\/{functionId}\/variables\/{variableId}":{"get":{"summary":"Get variable","operationId":"functionsGetVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"getVariable","weight":308,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]},"put":{"summary":"Update variable","operationId":"functionsUpdateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"updateVariable","weight":309,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key"]}}]},"delete":{"summary":"Delete variable","operationId":"functionsDeleteVariable","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a variable by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":310,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/health":{"get":{"summary":"Get HTTP","operationId":"healthGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite HTTP server is up and responsive.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"get","weight":124,"cookies":false,"type":"","deprecated":false,"demo":"health\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/anti-virus":{"get":{"summary":"Get antivirus","operationId":"healthGetAntivirus","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite Antivirus server is up and connection is successful.","responses":{"200":{"description":"Health Antivirus","schema":{"$ref":"#\/definitions\/healthAntivirus"}}},"x-appwrite":{"method":"getAntivirus","weight":146,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-antivirus.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/cache":{"get":{"summary":"Get cache","operationId":"healthGetCache","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite in-memory cache servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getCache","weight":127,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-cache.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/certificate":{"get":{"summary":"Get the SSL certificate for a domain","operationId":"healthGetCertificate","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the SSL certificate for a domain","responses":{"200":{"description":"Health Certificate","schema":{"$ref":"#\/definitions\/healthCertificate"}}},"x-appwrite":{"method":"getCertificate","weight":133,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-certificate.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"domain","description":"string","required":false,"type":"string","in":"query"}]}},"\/health\/db":{"get":{"summary":"Get DB","operationId":"healthGetDB","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite database servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getDB","weight":126,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-d-b.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/pubsub":{"get":{"summary":"Get pubsub","operationId":"healthGetPubSub","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite pub-sub servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getPubSub","weight":129,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-pub-sub.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue":{"get":{"summary":"Get queue","operationId":"healthGetQueue","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite queue messaging servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getQueue","weight":128,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue\/builds":{"get":{"summary":"Get builds queue","operationId":"healthGetQueueBuilds","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of builds that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueBuilds","weight":135,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-builds.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/certificates":{"get":{"summary":"Get certificates queue","operationId":"healthGetQueueCertificates","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of certificates that are waiting to be issued against [Letsencrypt](https:\/\/letsencrypt.org\/) in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueCertificates","weight":134,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-certificates.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/databases":{"get":{"summary":"Get databases queue","operationId":"healthGetQueueDatabases","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDatabases","weight":136,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-databases.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"Queue name for which to check the queue size","required":false,"type":"string","x-example":"<NAME>","default":"database_db_main","in":"query"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/deletes":{"get":{"summary":"Get deletes queue","operationId":"healthGetQueueDeletes","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDeletes","weight":137,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-deletes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/failed\/{name}":{"get":{"summary":"Get number of failed queue jobs","operationId":"healthGetFailedJobs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Returns the amount of failed jobs in a given queue.\n","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getFailedJobs","weight":147,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-failed-jobs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"The name of the queue","required":true,"type":"string","x-example":"v1-database","enum":["v1-database","v1-deletes","v1-audits","v1-mails","v1-functions","v1-usage","v1-usage-dump","v1-webhooks","v1-certificates","v1-builds","v1-messaging","v1-migrations"],"x-enum-name":null,"x-enum-keys":[],"in":"path"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/functions":{"get":{"summary":"Get functions queue","operationId":"healthGetQueueFunctions","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueFunctions","weight":141,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-functions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/logs":{"get":{"summary":"Get logs queue","operationId":"healthGetQueueLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of logs that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueLogs","weight":132,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/mails":{"get":{"summary":"Get mails queue","operationId":"healthGetQueueMails","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of mails that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMails","weight":138,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-mails.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/messaging":{"get":{"summary":"Get messaging queue","operationId":"healthGetQueueMessaging","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of messages that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMessaging","weight":139,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-messaging.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/migrations":{"get":{"summary":"Get migrations queue","operationId":"healthGetQueueMigrations","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMigrations","weight":140,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-migrations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage":{"get":{"summary":"Get usage queue","operationId":"healthGetQueueUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsage","weight":142,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage-dump":{"get":{"summary":"Get usage dump queue","operationId":"healthGetQueueUsageDump","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsageDump","weight":143,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage-dump.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage-dump.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/webhooks":{"get":{"summary":"Get webhooks queue","operationId":"healthGetQueueWebhooks","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueWebhooks","weight":131,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/storage":{"get":{"summary":"Get storage","operationId":"healthGetStorage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorage","weight":145,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/storage\/local":{"get":{"summary":"Get local storage","operationId":"healthGetStorageLocal","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite local storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorageLocal","weight":144,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage-local.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/time":{"get":{"summary":"Get time","operationId":"healthGetTime","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https:\/\/en.wikipedia.org\/wiki\/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.","responses":{"200":{"description":"Health Time","schema":{"$ref":"#\/definitions\/healthTime"}}},"x-appwrite":{"method":"getTime","weight":130,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-time.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","schema":{"$ref":"#\/definitions\/locale"}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","schema":{"$ref":"#\/definitions\/localeCodeList"}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","schema":{"$ref":"#\/definitions\/continentList"}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","schema":{"$ref":"#\/definitions\/phoneList"}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","schema":{"$ref":"#\/definitions\/currencyList"}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","schema":{"$ref":"#\/definitions\/languageList"}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}]}},"\/messaging\/messages":{"get":{"summary":"List messages","operationId":"messagingListMessages","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all messages from the current Appwrite project.","responses":{"200":{"description":"Message list","schema":{"$ref":"#\/definitions\/messageList"}}},"x-appwrite":{"method":"listMessages","weight":385,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-messages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/messages\/email":{"post":{"summary":"Create email","operationId":"messagingCreateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new email message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createEmail","weight":382,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":[],"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":[],"x-example":null,"items":{"type":"string"}},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","subject","content"]}}]}},"\/messaging\/messages\/email\/{messageId}":{"patch":{"summary":"Update email","operationId":"messagingUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateEmail","weight":389,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":null,"x-example":false},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":null,"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":null,"x-example":null,"items":{"type":"string"}},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":null,"items":{"type":"string"}}}}}]}},"\/messaging\/messages\/push":{"post":{"summary":"Create push notification","operationId":"messagingCreatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new push notification.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createPush","weight":384,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":"","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":"","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web Platform.","default":"","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and IOS Platform.","default":"","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android Platform.","default":"","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android Platform.","default":"","x-example":"<TAG>"},"badge":{"type":"string","description":"Badge for push notification. Available only for IOS Platform.","default":"","x-example":"<BADGE>"},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","title","body"]}}]}},"\/messaging\/messages\/push\/{messageId}":{"patch":{"summary":"Update push notification","operationId":"messagingUpdatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a push notification by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updatePush","weight":391,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":null,"x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web platforms.","default":null,"x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and iOS platforms.","default":null,"x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android platforms.","default":null,"x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android platforms.","default":null,"x-example":"<TAG>"},"badge":{"type":"integer","description":"Badge for push notification. Available only for iOS platforms.","default":null,"x-example":null},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/sms":{"post":{"summary":"Create SMS","operationId":"messagingCreateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMS message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createSms","weight":383,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"content":{"type":"string","description":"SMS Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","content"]}}]}},"\/messaging\/messages\/sms\/{messageId}":{"patch":{"summary":"Update SMS","operationId":"messagingUpdateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateSms","weight":390,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/{messageId}":{"get":{"summary":"Get message","operationId":"messagingGetMessage","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"getMessage","weight":388,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-message.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]},"delete":{"summary":"Delete message","operationId":"messagingDelete","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":392,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]}},"\/messaging\/messages\/{messageId}\/logs":{"get":{"summary":"List message logs","operationId":"messagingListMessageLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the message activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listMessageLogs","weight":386,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-message-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/messages\/{messageId}\/targets":{"get":{"summary":"List message targets","operationId":"messagingListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of the targets associated with a message.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":387,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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, providerId, identifier, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/providers":{"get":{"summary":"List providers","operationId":"messagingListProviders","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all providers from the current Appwrite project.","responses":{"200":{"description":"Provider list","schema":{"$ref":"#\/definitions\/providerList"}}},"x-appwrite":{"method":"listProviders","weight":357,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-providers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/providers\/apns":{"post":{"summary":"Create APNS provider","operationId":"messagingCreateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Apple Push Notification service provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createApnsProvider","weight":356,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/apns\/{providerId}":{"patch":{"summary":"Update APNS provider","operationId":"messagingUpdateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Apple Push Notification service provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateApnsProvider","weight":369,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/fcm":{"post":{"summary":"Create FCM provider","operationId":"messagingCreateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Firebase Cloud Messaging provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createFcmProvider","weight":355,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/fcm\/{providerId}":{"patch":{"summary":"Update FCM provider","operationId":"messagingUpdateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Firebase Cloud Messaging provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateFcmProvider","weight":368,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"}}}}]}},"\/messaging\/providers\/mailgun":{"post":{"summary":"Create Mailgun provider","operationId":"messagingCreateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Mailgun provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMailgunProvider","weight":347,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/mailgun\/{providerId}":{"patch":{"summary":"Update Mailgun provider","operationId":"messagingUpdateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Mailgun provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMailgunProvider","weight":360,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/msg91":{"post":{"summary":"Create Msg91 provider","operationId":"messagingCreateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new MSG91 provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMsg91Provider","weight":350,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"templateId":{"type":"string","description":"Msg91 template ID","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/msg91\/{providerId}":{"patch":{"summary":"Update Msg91 provider","operationId":"messagingUpdateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a MSG91 provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMsg91Provider","weight":363,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"templateId":{"type":"string","description":"Msg91 template ID.","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"}}}}]}},"\/messaging\/providers\/sendgrid":{"post":{"summary":"Create Sendgrid provider","operationId":"messagingCreateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Sendgrid provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSendgridProvider","weight":348,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/sendgrid\/{providerId}":{"patch":{"summary":"Update Sendgrid provider","operationId":"messagingUpdateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Sendgrid provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSendgridProvider","weight":361,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/smtp":{"post":{"summary":"Create SMTP provider","operationId":"messagingCreateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMTP provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSmtpProvider","weight":349,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":null,"x-example":"<HOST>"},"port":{"type":"integer","description":"The default SMTP server port.","default":587,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be omitted, 'ssl', or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":true,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name","host"]}}]}},"\/messaging\/providers\/smtp\/{providerId}":{"patch":{"summary":"Update SMTP provider","operationId":"messagingUpdateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a SMTP provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSmtpProvider","weight":362,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":"","x-example":"<HOST>"},"port":{"type":"integer","description":"SMTP port.","default":null,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be 'ssl' or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":null,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/telesign":{"post":{"summary":"Create Telesign provider","operationId":"messagingCreateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Telesign provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTelesignProvider","weight":351,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/telesign\/{providerId}":{"patch":{"summary":"Update Telesign provider","operationId":"messagingUpdateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Telesign provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTelesignProvider","weight":364,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/textmagic":{"post":{"summary":"Create Textmagic provider","operationId":"messagingCreateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Textmagic provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTextmagicProvider","weight":352,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/textmagic\/{providerId}":{"patch":{"summary":"Update Textmagic provider","operationId":"messagingUpdateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Textmagic provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTextmagicProvider","weight":365,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/twilio":{"post":{"summary":"Create Twilio provider","operationId":"messagingCreateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Twilio provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTwilioProvider","weight":353,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/twilio\/{providerId}":{"patch":{"summary":"Update Twilio provider","operationId":"messagingUpdateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Twilio provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTwilioProvider","weight":366,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/vonage":{"post":{"summary":"Create Vonage provider","operationId":"messagingCreateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Vonage provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createVonageProvider","weight":354,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/vonage\/{providerId}":{"patch":{"summary":"Update Vonage provider","operationId":"messagingUpdateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Vonage provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateVonageProvider","weight":367,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/{providerId}":{"get":{"summary":"Get provider","operationId":"messagingGetProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a provider by its unique ID.\n","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"getProvider","weight":359,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]},"delete":{"summary":"Delete provider","operationId":"messagingDeleteProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a provider by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteProvider","weight":370,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]}},"\/messaging\/providers\/{providerId}\/logs":{"get":{"summary":"List provider logs","operationId":"messagingListProviderLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the provider activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listProviderLogs","weight":358,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-provider-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/subscribers\/{subscriberId}\/logs":{"get":{"summary":"List subscriber logs","operationId":"messagingListSubscriberLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the subscriber activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listSubscriberLogs","weight":379,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscriber-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics":{"get":{"summary":"List topics","operationId":"messagingListTopics","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all topics from the current Appwrite project.","responses":{"200":{"description":"Topic list","schema":{"$ref":"#\/definitions\/topicList"}}},"x-appwrite":{"method":"listTopics","weight":372,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topics.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, description, emailTotal, smsTotal, pushTotal","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create topic","operationId":"messagingCreateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new topic.","responses":{"201":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"createTopic","weight":371,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"topicId":{"type":"string","description":"Topic ID. Choose a custom Topic ID or a new Topic ID.","default":null,"x-example":"<TOPIC_ID>"},"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":["users"],"x-example":"[\"any\"]","items":{"type":"string"}}},"required":["topicId","name"]}}]}},"\/messaging\/topics\/{topicId}":{"get":{"summary":"Get topic","operationId":"messagingGetTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"getTopic","weight":374,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]},"patch":{"summary":"Update topic","operationId":"messagingUpdateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"updateTopic","weight":375,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":null,"x-example":"[\"any\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete topic","operationId":"messagingDeleteTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a topic by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTopic","weight":376,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]}},"\/messaging\/topics\/{topicId}\/logs":{"get":{"summary":"List topic logs","operationId":"messagingListTopicLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the topic activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listTopicLogs","weight":373,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topic-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"get":{"summary":"List subscribers","operationId":"messagingListSubscribers","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all subscribers from the current Appwrite project.","responses":{"200":{"description":"Subscriber list","schema":{"$ref":"#\/definitions\/subscriberList"}}},"x-appwrite":{"method":"listSubscribers","weight":378,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscribers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","default":null,"x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","default":null,"x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}]}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"get":{"summary":"Get subscriber","operationId":"messagingGetSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a subscriber by its unique ID.\n","responses":{"200":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"getSubscriber","weight":380,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]},"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]}},"\/migrations":{"get":{"summary":"List Migrations","operationId":"migrationsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migrations List","schema":{"$ref":"#\/definitions\/migrationList"}}},"x-appwrite":{"method":"list","weight":334,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/list-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, resources, statusCounters, resourceData, errors","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/migrations\/appwrite":{"post":{"summary":"Migrate Appwrite Data","operationId":"migrationsCreateAppwriteMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createAppwriteMigration","weight":329,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-appwrite-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"endpoint":{"type":"string","description":"Source's Appwrite Endpoint","default":null,"x-example":"https:\/\/example.com"},"projectId":{"type":"string","description":"Source's Project ID","default":null,"x-example":"<PROJECT_ID>"},"apiKey":{"type":"string","description":"Source's API Key","default":null,"x-example":"<API_KEY>"}},"required":["resources","endpoint","projectId","apiKey"]}}]}},"\/migrations\/appwrite\/report":{"get":{"summary":"Generate a report on Appwrite Data","operationId":"migrationsGetAppwriteReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getAppwriteReport","weight":336,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-appwrite-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"endpoint","description":"Source's Appwrite Endpoint","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"projectID","description":"Source's Project ID","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"query"},{"name":"key","description":"Source's API Key","required":true,"type":"string","x-example":"<KEY>","in":"query"}]}},"\/migrations\/firebase":{"post":{"summary":"Migrate Firebase Data (Service Account)","operationId":"migrationsCreateFirebaseMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createFirebaseMigration","weight":331,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-firebase-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"serviceAccount":{"type":"string","description":"JSON of the Firebase service account credentials","default":null,"x-example":"<SERVICE_ACCOUNT>"}},"required":["resources","serviceAccount"]}}]}},"\/migrations\/firebase\/deauthorize":{"get":{"summary":"Revoke Appwrite's authorization to access Firebase Projects","operationId":"migrationsDeleteFirebaseAuth","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"deleteFirebaseAuth","weight":342,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/delete-firebase-auth.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/migrations\/firebase\/oauth":{"post":{"summary":"Migrate Firebase Data (OAuth)","operationId":"migrationsCreateFirebaseOAuthMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createFirebaseOAuthMigration","weight":330,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-firebase-o-auth-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"projectId":{"type":"string","description":"Project ID of the Firebase Project","default":null,"x-example":"<PROJECT_ID>"}},"required":["resources","projectId"]}}]}},"\/migrations\/firebase\/projects":{"get":{"summary":"List Firebase Projects","operationId":"migrationsListFirebaseProjects","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migrations Firebase Projects List","schema":{"$ref":"#\/definitions\/firebaseProjectList"}}},"x-appwrite":{"method":"listFirebaseProjects","weight":341,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/list-firebase-projects.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/migrations\/firebase\/report":{"get":{"summary":"Generate a report on Firebase Data","operationId":"migrationsGetFirebaseReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getFirebaseReport","weight":337,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-firebase-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"serviceAccount","description":"JSON of the Firebase service account credentials","required":true,"type":"string","x-example":"<SERVICE_ACCOUNT>","in":"query"}]}},"\/migrations\/firebase\/report\/oauth":{"get":{"summary":"Generate a report on Firebase Data using OAuth","operationId":"migrationsGetFirebaseReportOAuth","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getFirebaseReportOAuth","weight":338,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-firebase-report-o-auth.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"projectId","description":"Project ID","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"query"}]}},"\/migrations\/nhost":{"post":{"summary":"Migrate NHost Data","operationId":"migrationsCreateNHostMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createNHostMigration","weight":333,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-n-host-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"subdomain":{"type":"string","description":"Source's Subdomain","default":null,"x-example":"<SUBDOMAIN>"},"region":{"type":"string","description":"Source's Region","default":null,"x-example":"<REGION>"},"adminSecret":{"type":"string","description":"Source's Admin Secret","default":null,"x-example":"<ADMIN_SECRET>"},"database":{"type":"string","description":"Source's Database Name","default":null,"x-example":"<DATABASE>"},"username":{"type":"string","description":"Source's Database Username","default":null,"x-example":"<USERNAME>"},"password":{"type":"string","description":"Source's Database Password","default":null,"x-example":"<PASSWORD>"},"port":{"type":"integer","description":"Source's Database Port","default":5432,"x-example":null}},"required":["resources","subdomain","region","adminSecret","database","username","password"]}}]}},"\/migrations\/nhost\/report":{"get":{"summary":"Generate a report on NHost Data","operationId":"migrationsGetNHostReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getNHostReport","weight":344,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-n-host-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate.","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"subdomain","description":"Source's Subdomain.","required":true,"type":"string","x-example":"<SUBDOMAIN>","in":"query"},{"name":"region","description":"Source's Region.","required":true,"type":"string","x-example":"<REGION>","in":"query"},{"name":"adminSecret","description":"Source's Admin Secret.","required":true,"type":"string","x-example":"<ADMIN_SECRET>","in":"query"},{"name":"database","description":"Source's Database Name.","required":true,"type":"string","x-example":"<DATABASE>","in":"query"},{"name":"username","description":"Source's Database Username.","required":true,"type":"string","x-example":"<USERNAME>","in":"query"},{"name":"password","description":"Source's Database Password.","required":true,"type":"string","x-example":"<PASSWORD>","in":"query"},{"name":"port","description":"Source's Database Port.","required":false,"type":"integer","format":"int32","default":5432,"in":"query"}]}},"\/migrations\/supabase":{"post":{"summary":"Migrate Supabase Data","operationId":"migrationsCreateSupabaseMigration","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"createSupabaseMigration","weight":332,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/create-supabase-migration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"resources":{"type":"array","description":"List of resources to migrate","default":null,"x-example":null,"items":{"type":"string"}},"endpoint":{"type":"string","description":"Source's Supabase Endpoint","default":null,"x-example":"https:\/\/example.com"},"apiKey":{"type":"string","description":"Source's API Key","default":null,"x-example":"<API_KEY>"},"databaseHost":{"type":"string","description":"Source's Database Host","default":null,"x-example":"<DATABASE_HOST>"},"username":{"type":"string","description":"Source's Database Username","default":null,"x-example":"<USERNAME>"},"password":{"type":"string","description":"Source's Database Password","default":null,"x-example":"<PASSWORD>"},"port":{"type":"integer","description":"Source's Database Port","default":5432,"x-example":null}},"required":["resources","endpoint","apiKey","databaseHost","username","password"]}}]}},"\/migrations\/supabase\/report":{"get":{"summary":"Generate a report on Supabase Data","operationId":"migrationsGetSupabaseReport","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration Report","schema":{"$ref":"#\/definitions\/migrationReport"}}},"x-appwrite":{"method":"getSupabaseReport","weight":343,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get-supabase-report.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase-report.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"resources","description":"List of resources to migrate","required":true,"type":"array","collectionFormat":"multi","items":{"type":"string"},"in":"query"},{"name":"endpoint","description":"Source's Supabase Endpoint.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"apiKey","description":"Source's API Key.","required":true,"type":"string","x-example":"<API_KEY>","in":"query"},{"name":"databaseHost","description":"Source's Database Host.","required":true,"type":"string","x-example":"<DATABASE_HOST>","in":"query"},{"name":"username","description":"Source's Database Username.","required":true,"type":"string","x-example":"<USERNAME>","in":"query"},{"name":"password","description":"Source's Database Password.","required":true,"type":"string","x-example":"<PASSWORD>","in":"query"},{"name":"port","description":"Source's Database Port.","required":false,"type":"integer","format":"int32","default":5432,"in":"query"}]}},"\/migrations\/{migrationId}":{"get":{"summary":"Get Migration","operationId":"migrationsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"200":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"get","weight":335,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/get-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration unique ID.","required":true,"type":"string","x-example":"<MIGRATION_ID>","in":"path"}]},"patch":{"summary":"Retry Migration","operationId":"migrationsRetry","consumes":["application\/json"],"produces":["application\/json"],"tags":["migrations"],"description":"","responses":{"202":{"description":"Migration","schema":{"$ref":"#\/definitions\/migration"}}},"x-appwrite":{"method":"retry","weight":345,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/retry.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/retry-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration unique ID.","required":true,"type":"string","x-example":"<MIGRATION_ID>","in":"path"}]},"delete":{"summary":"Delete Migration","operationId":"migrationsDelete","consumes":["application\/json"],"produces":[],"tags":["migrations"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":346,"cookies":false,"type":"","deprecated":false,"demo":"migrations\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/delete-migration.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"migrations.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"migrationId","description":"Migration ID.","required":true,"type":"string","x-example":"<MIGRATION_ID>","in":"path"}]}},"\/project\/usage":{"get":{"summary":"Get project usage stats","operationId":"projectGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"","responses":{"200":{"description":"UsageProject","schema":{"$ref":"#\/definitions\/usageProject"}}},"x-appwrite":{"method":"getUsage","weight":194,"cookies":false,"type":"","deprecated":false,"demo":"project\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"startDate","description":"Starting date for the usage","required":true,"type":"string","in":"query"},{"name":"endDate","description":"End date for the usage","required":true,"type":"string","in":"query"},{"name":"period","description":"Period used","required":false,"type":"string","x-example":"1h","enum":["1h","1d"],"x-enum-name":"ProjectUsageRange","x-enum-keys":["One Hour","One Day"],"default":"1d","in":"query"}]}},"\/project\/variables":{"get":{"summary":"List Variables","operationId":"projectListVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Get a list of all project variables. These variables will be accessible in all Appwrite Functions at runtime.","responses":{"200":{"description":"Variables List","schema":{"$ref":"#\/definitions\/variableList"}}},"x-appwrite":{"method":"listVariables","weight":196,"cookies":false,"type":"","deprecated":false,"demo":"project\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]},"post":{"summary":"Create Variable","operationId":"projectCreateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.","responses":{"201":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"createVariable","weight":195,"cookies":false,"type":"","deprecated":false,"demo":"project\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key","value"]}}]}},"\/project\/variables\/{variableId}":{"get":{"summary":"Get Variable","operationId":"projectGetVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Get a project variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"getVariable","weight":197,"cookies":false,"type":"","deprecated":false,"demo":"project\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]},"put":{"summary":"Update Variable","operationId":"projectUpdateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["project"],"description":"Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"updateVariable","weight":198,"cookies":false,"type":"","deprecated":false,"demo":"project\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key"]}}]},"delete":{"summary":"Delete Variable","operationId":"projectDeleteVariable","consumes":["application\/json"],"produces":[],"tags":["project"],"description":"Delete a project variable by its unique ID. ","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":199,"cookies":false,"type":"","deprecated":false,"demo":"project\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]}},"\/projects":{"get":{"summary":"List projects","operationId":"projectsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Projects List","schema":{"$ref":"#\/definitions\/projectList"}}},"x-appwrite":{"method":"list","weight":150,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"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: name, teamId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create project","operationId":"projectsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"create","weight":149,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"projectId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":null},"name":{"type":"string","description":"Project name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"teamId":{"type":"string","description":"Team unique ID.","default":null,"x-example":"<TEAM_ID>"},"region":{"type":"string","description":"Project Region.","default":"default","x-example":"default","enum":["default","fra"],"x-enum-name":null,"x-enum-keys":[]},"description":{"type":"string","description":"Project description. Max length: 256 chars.","default":"","x-example":"<DESCRIPTION>"},"logo":{"type":"string","description":"Project logo.","default":"","x-example":"<LOGO>"},"url":{"type":"string","description":"Project URL.","default":"","x-example":"https:\/\/example.com"},"legalName":{"type":"string","description":"Project legal Name. Max length: 256 chars.","default":"","x-example":"<LEGAL_NAME>"},"legalCountry":{"type":"string","description":"Project legal Country. Max length: 256 chars.","default":"","x-example":"<LEGAL_COUNTRY>"},"legalState":{"type":"string","description":"Project legal State. Max length: 256 chars.","default":"","x-example":"<LEGAL_STATE>"},"legalCity":{"type":"string","description":"Project legal City. Max length: 256 chars.","default":"","x-example":"<LEGAL_CITY>"},"legalAddress":{"type":"string","description":"Project legal Address. Max length: 256 chars.","default":"","x-example":"<LEGAL_ADDRESS>"},"legalTaxId":{"type":"string","description":"Project legal Tax ID. Max length: 256 chars.","default":"","x-example":"<LEGAL_TAX_ID>"}},"required":["projectId","name","teamId"]}}]}},"\/projects\/{projectId}":{"get":{"summary":"Get project","operationId":"projectsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"get","weight":151,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"patch":{"summary":"Update project","operationId":"projectsUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"update","weight":152,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Project name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"description":{"type":"string","description":"Project description. Max length: 256 chars.","default":"","x-example":"<DESCRIPTION>"},"logo":{"type":"string","description":"Project logo.","default":"","x-example":"<LOGO>"},"url":{"type":"string","description":"Project URL.","default":"","x-example":"https:\/\/example.com"},"legalName":{"type":"string","description":"Project legal name. Max length: 256 chars.","default":"","x-example":"<LEGAL_NAME>"},"legalCountry":{"type":"string","description":"Project legal country. Max length: 256 chars.","default":"","x-example":"<LEGAL_COUNTRY>"},"legalState":{"type":"string","description":"Project legal state. Max length: 256 chars.","default":"","x-example":"<LEGAL_STATE>"},"legalCity":{"type":"string","description":"Project legal city. Max length: 256 chars.","default":"","x-example":"<LEGAL_CITY>"},"legalAddress":{"type":"string","description":"Project legal address. Max length: 256 chars.","default":"","x-example":"<LEGAL_ADDRESS>"},"legalTaxId":{"type":"string","description":"Project legal tax ID. Max length: 256 chars.","default":"","x-example":"<LEGAL_TAX_ID>"}},"required":["name"]}}]},"delete":{"summary":"Delete project","operationId":"projectsDelete","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":168,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]}},"\/projects\/{projectId}\/api":{"patch":{"summary":"Update API status","operationId":"projectsUpdateApiStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateApiStatus","weight":156,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-api-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"api":{"type":"string","description":"API name.","default":null,"x-example":"rest","enum":["rest","graphql","realtime"],"x-enum-name":null,"x-enum-keys":[]},"status":{"type":"boolean","description":"API status.","default":null,"x-example":false}},"required":["api","status"]}}]}},"\/projects\/{projectId}\/api\/all":{"patch":{"summary":"Update all API status","operationId":"projectsUpdateApiStatusAll","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateApiStatusAll","weight":157,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-api-status-all.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"API status.","default":null,"x-example":false}},"required":["status"]}}]}},"\/projects\/{projectId}\/auth\/duration":{"patch":{"summary":"Update project authentication duration","operationId":"projectsUpdateAuthDuration","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthDuration","weight":161,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-duration.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"duration":{"type":"integer","description":"Project session length in seconds. Max length: 31536000 seconds.","default":null,"x-example":0}},"required":["duration"]}}]}},"\/projects\/{projectId}\/auth\/limit":{"patch":{"summary":"Update project users limit","operationId":"projectsUpdateAuthLimit","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthLimit","weight":160,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-limit.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of users allowed in this project. Use 0 for unlimited.","default":null,"x-example":0}},"required":["limit"]}}]}},"\/projects\/{projectId}\/auth\/max-sessions":{"patch":{"summary":"Update project user sessions limit","operationId":"projectsUpdateAuthSessionsLimit","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthSessionsLimit","weight":166,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-sessions-limit.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10","default":null,"x-example":1}},"required":["limit"]}}]}},"\/projects\/{projectId}\/auth\/mock-numbers":{"patch":{"summary":"Update the mock numbers for the project","operationId":"projectsUpdateMockNumbers","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateMockNumbers","weight":167,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-mock-numbers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"numbers":{"type":"array","description":"An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.","default":null,"x-example":null,"items":{"type":"object"}}},"required":["numbers"]}}]}},"\/projects\/{projectId}\/auth\/password-dictionary":{"patch":{"summary":"Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password","operationId":"projectsUpdateAuthPasswordDictionary","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthPasswordDictionary","weight":164,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-password-dictionary.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Set whether or not to enable checking user's password against most commonly used passwords. Default is false.","default":null,"x-example":false}},"required":["enabled"]}}]}},"\/projects\/{projectId}\/auth\/password-history":{"patch":{"summary":"Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.","operationId":"projectsUpdateAuthPasswordHistory","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthPasswordHistory","weight":163,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-password-history.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"limit":{"type":"integer","description":"Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0","default":null,"x-example":0}},"required":["limit"]}}]}},"\/projects\/{projectId}\/auth\/personal-data":{"patch":{"summary":"Enable or disable checking user passwords for similarity with their personal data.","operationId":"projectsUpdatePersonalDataCheck","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updatePersonalDataCheck","weight":165,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-personal-data-check.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Set whether or not to check a password for similarity with personal data. Default is false.","default":null,"x-example":false}},"required":["enabled"]}}]}},"\/projects\/{projectId}\/auth\/session-alerts":{"patch":{"summary":"Update project sessions emails","operationId":"projectsUpdateSessionAlerts","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateSessionAlerts","weight":159,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-session-alerts.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"alerts":{"type":"boolean","description":"Set to true to enable session emails.","default":null,"x-example":false}},"required":["alerts"]}}]}},"\/projects\/{projectId}\/auth\/{method}":{"patch":{"summary":"Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.","operationId":"projectsUpdateAuthStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateAuthStatus","weight":162,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-auth-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"method","description":"Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone","required":true,"type":"string","x-example":"email-password","enum":["email-password","magic-url","email-otp","anonymous","invites","jwt","phone"],"x-enum-name":"AuthMethod","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"Set the status of this auth method.","default":null,"x-example":false}},"required":["status"]}}]}},"\/projects\/{projectId}\/jwts":{"post":{"summary":"Create JWT","operationId":"projectsCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":180,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"scopes":{"type":"array","description":"List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","default":900,"x-example":0}},"required":["scopes"]}}]}},"\/projects\/{projectId}\/keys":{"get":{"summary":"List keys","operationId":"projectsListKeys","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"API Keys List","schema":{"$ref":"#\/definitions\/keyList"}}},"x-appwrite":{"method":"listKeys","weight":176,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-keys.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"post":{"summary":"Create key","operationId":"projectsCreateKey","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Key","schema":{"$ref":"#\/definitions\/key"}}},"x-appwrite":{"method":"createKey","weight":175,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Key name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"scopes":{"type":"array","description":"Key scopes list. Maximum of 100 scopes are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"expire":{"type":"string","description":"Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.","default":null,"x-example":null}},"required":["name","scopes"]}}]}},"\/projects\/{projectId}\/keys\/{keyId}":{"get":{"summary":"Get key","operationId":"projectsGetKey","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Key","schema":{"$ref":"#\/definitions\/key"}}},"x-appwrite":{"method":"getKey","weight":177,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"type":"string","x-example":"<KEY_ID>","in":"path"}]},"put":{"summary":"Update key","operationId":"projectsUpdateKey","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Key","schema":{"$ref":"#\/definitions\/key"}}},"x-appwrite":{"method":"updateKey","weight":178,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"type":"string","x-example":"<KEY_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Key name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"scopes":{"type":"array","description":"Key scopes list. Maximum of 100 events are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"expire":{"type":"string","description":"Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.","default":null,"x-example":null}},"required":["name","scopes"]}}]},"delete":{"summary":"Delete key","operationId":"projectsDeleteKey","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteKey","weight":179,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-key.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"keyId","description":"Key unique ID.","required":true,"type":"string","x-example":"<KEY_ID>","in":"path"}]}},"\/projects\/{projectId}\/oauth2":{"patch":{"summary":"Update project OAuth2","operationId":"projectsUpdateOAuth2","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateOAuth2","weight":158,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-o-auth2.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"provider":{"type":"string","description":"Provider Name","default":null,"x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[]},"appId":{"type":"string","description":"Provider app ID. Max length: 256 chars.","default":null,"x-example":"<APP_ID>"},"secret":{"type":"string","description":"Provider secret key. Max length: 512 chars.","default":null,"x-example":"<SECRET>"},"enabled":{"type":"boolean","description":"Provider status. Set to 'false' to disable new session creation.","default":null,"x-example":false}},"required":["provider"]}}]}},"\/projects\/{projectId}\/platforms":{"get":{"summary":"List platforms","operationId":"projectsListPlatforms","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Platforms List","schema":{"$ref":"#\/definitions\/platformList"}}},"x-appwrite":{"method":"listPlatforms","weight":182,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-platforms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"post":{"summary":"Create platform","operationId":"projectsCreatePlatform","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Platform","schema":{"$ref":"#\/definitions\/platform"}}},"x-appwrite":{"method":"createPlatform","weight":181,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"type":{"type":"string","description":"Platform type.","default":null,"x-example":"web","enum":["web","flutter-web","flutter-ios","flutter-android","flutter-linux","flutter-macos","flutter-windows","apple-ios","apple-macos","apple-watchos","apple-tvos","android","unity"],"x-enum-name":"PlatformType","x-enum-keys":[]},"name":{"type":"string","description":"Platform name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"key":{"type":"string","description":"Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.","default":"","x-example":"<KEY>"},"store":{"type":"string","description":"App store or Google Play store ID. Max length: 256 chars.","default":"","x-example":"<STORE>"},"hostname":{"type":"string","description":"Platform client hostname. Max length: 256 chars.","default":"","x-example":null}},"required":["type","name"]}}]}},"\/projects\/{projectId}\/platforms\/{platformId}":{"get":{"summary":"Get platform","operationId":"projectsGetPlatform","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Platform","schema":{"$ref":"#\/definitions\/platform"}}},"x-appwrite":{"method":"getPlatform","weight":183,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"type":"string","x-example":"<PLATFORM_ID>","in":"path"}]},"put":{"summary":"Update platform","operationId":"projectsUpdatePlatform","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Platform","schema":{"$ref":"#\/definitions\/platform"}}},"x-appwrite":{"method":"updatePlatform","weight":184,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"type":"string","x-example":"<PLATFORM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Platform name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"key":{"type":"string","description":"Package name for android or bundle ID for iOS. Max length: 256 chars.","default":"","x-example":"<KEY>"},"store":{"type":"string","description":"App store or Google Play store ID. Max length: 256 chars.","default":"","x-example":"<STORE>"},"hostname":{"type":"string","description":"Platform client URL. Max length: 256 chars.","default":"","x-example":null}},"required":["name"]}}]},"delete":{"summary":"Delete platform","operationId":"projectsDeletePlatform","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deletePlatform","weight":185,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-platform.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"platformId","description":"Platform unique ID.","required":true,"type":"string","x-example":"<PLATFORM_ID>","in":"path"}]}},"\/projects\/{projectId}\/service":{"patch":{"summary":"Update service status","operationId":"projectsUpdateServiceStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateServiceStatus","weight":154,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-service-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"service":{"type":"string","description":"Service name.","default":null,"x-example":"account","enum":["account","avatars","databases","locale","health","storage","teams","users","functions","graphql","messaging"],"x-enum-name":"ApiService","x-enum-keys":[]},"status":{"type":"boolean","description":"Service status.","default":null,"x-example":false}},"required":["service","status"]}}]}},"\/projects\/{projectId}\/service\/all":{"patch":{"summary":"Update all service status","operationId":"projectsUpdateServiceStatusAll","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateServiceStatusAll","weight":155,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-service-status-all.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"Service status.","default":null,"x-example":false}},"required":["status"]}}]}},"\/projects\/{projectId}\/smtp":{"patch":{"summary":"Update SMTP","operationId":"projectsUpdateSmtp","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateSmtp","weight":186,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-smtp.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Enable custom SMTP service","default":null,"x-example":false},"senderName":{"type":"string","description":"Name of the email sender","default":"","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","default":"","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","default":"","x-example":"email@example.com"},"host":{"type":"string","description":"SMTP server host name","default":"","x-example":null},"port":{"type":"integer","description":"SMTP server port","default":587,"x-example":null},"username":{"type":"string","description":"SMTP server username","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"SMTP server password","default":"","x-example":"<PASSWORD>"},"secure":{"type":"string","description":"Does SMTP server use secure connection","default":"","x-example":"tls","enum":["tls","ssl"],"x-enum-name":"SMTPSecure","x-enum-keys":[]}},"required":["enabled"]}}]}},"\/projects\/{projectId}\/smtp\/tests":{"post":{"summary":"Create SMTP test","operationId":"projectsCreateSmtpTest","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createSmtpTest","weight":187,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-smtp-test.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"emails":{"type":"array","description":"Array of emails to send test email to. Maximum of 10 emails are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"senderName":{"type":"string","description":"Name of the email sender","default":null,"x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","default":null,"x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","default":"","x-example":"email@example.com"},"host":{"type":"string","description":"SMTP server host name","default":null,"x-example":null},"port":{"type":"integer","description":"SMTP server port","default":587,"x-example":null},"username":{"type":"string","description":"SMTP server username","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"SMTP server password","default":"","x-example":"<PASSWORD>"},"secure":{"type":"string","description":"Does SMTP server use secure connection","default":"","x-example":"tls","enum":["tls"],"x-enum-name":"SMTPSecure","x-enum-keys":[]}},"required":["emails","senderName","senderEmail","host"]}}]}},"\/projects\/{projectId}\/team":{"patch":{"summary":"Update project team","operationId":"projectsUpdateTeam","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateTeam","weight":153,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-team.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID of the team to transfer project to.","default":null,"x-example":"<TEAM_ID>"}},"required":["teamId"]}}]}},"\/projects\/{projectId}\/templates\/email\/{type}\/{locale}":{"get":{"summary":"Get custom email template","operationId":"projectsGetEmailTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"EmailTemplate","schema":{"$ref":"#\/definitions\/emailTemplate"}}},"x-appwrite":{"method":"getEmailTemplate","weight":189,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[],"in":"path"}]},"patch":{"summary":"Update custom email templates","operationId":"projectsUpdateEmailTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Project","schema":{"$ref":"#\/definitions\/project"}}},"x-appwrite":{"method":"updateEmailTemplate","weight":191,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subject":{"type":"string","description":"Email Subject","default":null,"x-example":"<SUBJECT>"},"message":{"type":"string","description":"Template message","default":null,"x-example":"<MESSAGE>"},"senderName":{"type":"string","description":"Name of the email sender","default":"","x-example":"<SENDER_NAME>"},"senderEmail":{"type":"string","description":"Email of the sender","default":"","x-example":"email@example.com"},"replyTo":{"type":"string","description":"Reply to email","default":"","x-example":"email@example.com"}},"required":["subject","message"]}}]},"delete":{"summary":"Reset custom email template","operationId":"projectsDeleteEmailTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"EmailTemplate","schema":{"$ref":"#\/definitions\/emailTemplate"}}},"x-appwrite":{"method":"deleteEmailTemplate","weight":193,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-email-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","magicsession","recovery","invitation","mfachallenge"],"x-enum-name":"EmailTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"EmailTemplateLocale","x-enum-keys":[],"in":"path"}]}},"\/projects\/{projectId}\/templates\/sms\/{type}\/{locale}":{"get":{"summary":"Get custom SMS template","operationId":"projectsGetSmsTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","schema":{"$ref":"#\/definitions\/smsTemplate"}}},"x-appwrite":{"method":"getSmsTemplate","weight":188,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[],"in":"path"}]},"patch":{"summary":"Update custom SMS template","operationId":"projectsUpdateSmsTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","schema":{"$ref":"#\/definitions\/smsTemplate"}}},"x-appwrite":{"method":"updateSmsTemplate","weight":190,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"message":{"type":"string","description":"Template message","default":null,"x-example":"<MESSAGE>"}},"required":["message"]}}]},"delete":{"summary":"Reset custom SMS template","operationId":"projectsDeleteSmsTemplate","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"SmsTemplate","schema":{"$ref":"#\/definitions\/smsTemplate"}}},"x-appwrite":{"method":"deleteSmsTemplate","weight":192,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-sms-template.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"type","description":"Template type","required":true,"type":"string","x-example":"verification","enum":["verification","login","invitation","mfachallenge"],"x-enum-name":"SmsTemplateType","x-enum-keys":[],"in":"path"},{"name":"locale","description":"Template locale","required":true,"type":"string","x-example":"af","enum":["af","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","as","az","be","bg","bh","bn","bs","ca","cs","cy","da","de","de-at","de-ch","de-li","de-lu","el","en","en-au","en-bz","en-ca","en-gb","en-ie","en-jm","en-nz","en-tt","en-us","en-za","eo","es","es-ar","es-bo","es-cl","es-co","es-cr","es-do","es-ec","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-pr","es-py","es-sv","es-uy","es-ve","et","eu","fa","fi","fo","fr","fr-be","fr-ca","fr-ch","fr-lu","ga","gd","he","hi","hr","hu","id","is","it","it-ch","ja","ji","ko","ku","lt","lv","mk","ml","ms","mt","nb","ne","nl","nl-be","nn","no","pa","pl","pt","pt-br","rm","ro","ro-md","ru","ru-md","sb","sk","sl","sq","sr","sv","sv-fi","th","tn","tr","ts","ua","ur","ve","vi","xh","zh-cn","zh-hk","zh-sg","zh-tw","zu"],"x-enum-name":"SmsTemplateLocale","x-enum-keys":[],"in":"path"}]}},"\/projects\/{projectId}\/webhooks":{"get":{"summary":"List webhooks","operationId":"projectsListWebhooks","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhooks List","schema":{"$ref":"#\/definitions\/webhookList"}}},"x-appwrite":{"method":"listWebhooks","weight":170,"cookies":false,"type":"","deprecated":false,"demo":"projects\/list-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"}]},"post":{"summary":"Create webhook","operationId":"projectsCreateWebhook","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"201":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"createWebhook","weight":169,"cookies":false,"type":"","deprecated":false,"demo":"projects\/create-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Webhook name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Enable or disable a webhook.","default":true,"x-example":false},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"Webhook URL.","default":null,"x-example":null},"security":{"type":"boolean","description":"Certificate verification, false for disabled or true for enabled.","default":null,"x-example":false},"httpUser":{"type":"string","description":"Webhook HTTP user. Max length: 256 chars.","default":"","x-example":"<HTTP_USER>"},"httpPass":{"type":"string","description":"Webhook HTTP password. Max length: 256 chars.","default":"","x-example":"<HTTP_PASS>"}},"required":["name","events","url","security"]}}]}},"\/projects\/{projectId}\/webhooks\/{webhookId}":{"get":{"summary":"Get webhook","operationId":"projectsGetWebhook","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"getWebhook","weight":171,"cookies":false,"type":"","deprecated":false,"demo":"projects\/get-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"}]},"put":{"summary":"Update webhook","operationId":"projectsUpdateWebhook","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"updateWebhook","weight":172,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Webhook name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Enable or disable a webhook.","default":true,"x-example":false},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"Webhook URL.","default":null,"x-example":null},"security":{"type":"boolean","description":"Certificate verification, false for disabled or true for enabled.","default":null,"x-example":false},"httpUser":{"type":"string","description":"Webhook HTTP user. Max length: 256 chars.","default":"","x-example":"<HTTP_USER>"},"httpPass":{"type":"string","description":"Webhook HTTP password. Max length: 256 chars.","default":"","x-example":"<HTTP_PASS>"}},"required":["name","events","url","security"]}}]},"delete":{"summary":"Delete webhook","operationId":"projectsDeleteWebhook","consumes":["application\/json"],"produces":[],"tags":["projects"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteWebhook","weight":174,"cookies":false,"type":"","deprecated":false,"demo":"projects\/delete-webhook.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"}]}},"\/projects\/{projectId}\/webhooks\/{webhookId}\/signature":{"patch":{"summary":"Update webhook signature key","operationId":"projectsUpdateWebhookSignature","consumes":["application\/json"],"produces":["application\/json"],"tags":["projects"],"description":"","responses":{"200":{"description":"Webhook","schema":{"$ref":"#\/definitions\/webhook"}}},"x-appwrite":{"method":"updateWebhookSignature","weight":173,"cookies":false,"type":"","deprecated":false,"demo":"projects\/update-webhook-signature.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"projects.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"projectId","description":"Project unique ID.","required":true,"type":"string","x-example":"<PROJECT_ID>","in":"path"},{"name":"webhookId","description":"Webhook unique ID.","required":true,"type":"string","x-example":"<WEBHOOK_ID>","in":"path"}]}},"\/proxy\/rules":{"get":{"summary":"List Rules","operationId":"proxyListRules","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"Get a list of all the proxy rules. You can use the query params to filter your results.","responses":{"200":{"description":"Rule List","schema":{"$ref":"#\/definitions\/proxyRuleList"}}},"x-appwrite":{"method":"listRules","weight":312,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/list-rules.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/list-rules.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, resourceType, resourceId, url","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create Rule","operationId":"proxyCreateRule","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"Create a new proxy rule.","responses":{"201":{"description":"Rule","schema":{"$ref":"#\/definitions\/proxyRule"}}},"x-appwrite":{"method":"createRule","weight":311,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/create-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/create-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"domain":{"type":"string","description":"Domain name.","default":null,"x-example":null},"resourceType":{"type":"string","description":"Action definition for the rule. Possible values are \"api\", \"function\"","default":null,"x-example":"api","enum":["api","function"],"x-enum-name":null,"x-enum-keys":[]},"resourceId":{"type":"string","description":"ID of resource for the action type. If resourceType is \"api\", leave empty. If resourceType is \"function\", provide ID of the function.","default":"","x-example":"<RESOURCE_ID>"}},"required":["domain","resourceType"]}}]}},"\/proxy\/rules\/{ruleId}":{"get":{"summary":"Get Rule","operationId":"proxyGetRule","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"Get a proxy rule by its unique ID.","responses":{"200":{"description":"Rule","schema":{"$ref":"#\/definitions\/proxyRule"}}},"x-appwrite":{"method":"getRule","weight":313,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/get-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/get-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"type":"string","x-example":"<RULE_ID>","in":"path"}]},"delete":{"summary":"Delete Rule","operationId":"proxyDeleteRule","consumes":["application\/json"],"produces":[],"tags":["proxy"],"description":"Delete a proxy rule by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteRule","weight":314,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/delete-rule.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/delete-rule.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"type":"string","x-example":"<RULE_ID>","in":"path"}]}},"\/proxy\/rules\/{ruleId}\/verification":{"patch":{"summary":"Update Rule Verification Status","operationId":"proxyUpdateRuleVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["proxy"],"description":"","responses":{"200":{"description":"Rule","schema":{"$ref":"#\/definitions\/proxyRule"}}},"x-appwrite":{"method":"updateRuleVerification","weight":315,"cookies":false,"type":"","deprecated":false,"demo":"proxy\/update-rule-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"rules.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"ruleId","description":"Rule ID.","required":true,"type":"string","x-example":"<RULE_ID>","in":"path"}]}},"\/storage\/buckets":{"get":{"summary":"List buckets","operationId":"storageListBuckets","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the storage buckets. You can use the query params to filter your results.","responses":{"200":{"description":"Buckets List","schema":{"$ref":"#\/definitions\/bucketList"}}},"x-appwrite":{"method":"listBuckets","weight":201,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-buckets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create bucket","operationId":"storageCreateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new storage bucket.","responses":{"201":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"createBucket","weight":200,"cookies":false,"type":"","deprecated":false,"demo":"storage\/create-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"bucketId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<BUCKET_ID>"},"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["bucketId","name"]}}]}},"\/storage\/buckets\/{bucketId}":{"get":{"summary":"Get bucket","operationId":"storageGetBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"getBucket","weight":202,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]},"put":{"summary":"Update bucket","operationId":"storageUpdateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a storage bucket by its unique ID.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"updateBucket","weight":203,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete bucket","operationId":"storageDeleteBucket","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a storage bucket by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteBucket","weight":204,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","schema":{"$ref":"#\/definitions\/fileList"}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"x-upload-id":true,"type":"string","x-example":"<FILE_ID>","in":"formData"},{"name":"file","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","required":true,"type":"file","in":"formData"},{"name":"permissions","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"x-example":"[\"read(\"any\")\"]","in":"formData"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","consumes":["application\/json"],"produces":["image\/*"],"tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center","in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"type":"number","format":"float","x-example":0,"default":1,"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"type":"integer","format":"int32","x-example":-360,"default":0,"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":"","in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/usage":{"get":{"summary":"Get storage usage stats","operationId":"storageGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"","responses":{"200":{"description":"StorageUsage","schema":{"$ref":"#\/definitions\/usageStorage"}}},"x-appwrite":{"method":"getUsage","weight":214,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"StorageUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/storage\/{bucketId}\/usage":{"get":{"summary":"Get bucket usage stats","operationId":"storageGetBucketUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"","responses":{"200":{"description":"UsageBuckets","schema":{"$ref":"#\/definitions\/usageBuckets"}}},"x-appwrite":{"method":"getBucketUsage","weight":215,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"bucketId","description":"Bucket ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"StorageUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","schema":{"$ref":"#\/definitions\/teamList"}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":["owner"],"x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}]}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]},"delete":{"summary":"Delete team","operationId":"teamsDelete","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]}},"\/teams\/{teamId}\/logs":{"get":{"summary":"List team logs","operationId":"teamsListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":229,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","default":"","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","default":"","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","default":"","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["roles"]}}]}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["roles"]}}]},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users":{"get":{"summary":"List users","operationId":"usersList","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a list of all the project's users. You can use the query params to filter your results.","responses":{"200":{"description":"Users List","schema":{"$ref":"#\/definitions\/userList"}}},"x-appwrite":{"method":"list","weight":239,"cookies":false,"type":"","deprecated":false,"demo":"users\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create user","operationId":"usersCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":230,"cookies":false,"type":"","deprecated":false,"demo":"users\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"Plain text user password. Must be at least 8 chars.","default":"","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId"]}}]}},"\/users\/argon2":{"post":{"summary":"Create user with Argon2 password","operationId":"usersCreateArgon2User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createArgon2User","weight":233,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-argon2user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Argon2.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/bcrypt":{"post":{"summary":"Create user with bcrypt password","operationId":"usersCreateBcryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createBcryptUser","weight":231,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-bcrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Bcrypt.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/identities":{"get":{"summary":"List Identities","operationId":"usersListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get identities for all users.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":247,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/users\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"usersDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":270,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/users\/md5":{"post":{"summary":"Create user with MD5 password","operationId":"usersCreateMD5User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createMD5User","weight":232,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-m-d5user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using MD5.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/phpass":{"post":{"summary":"Create user with PHPass password","operationId":"usersCreatePHPassUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createPHPassUser","weight":235,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-p-h-pass-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using PHPass.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/scrypt":{"post":{"summary":"Create user with Scrypt password","operationId":"usersCreateScryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptUser","weight":236,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Optional salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordCpu":{"type":"integer","description":"Optional CPU cost used to hash password.","default":null,"x-example":null},"passwordMemory":{"type":"integer","description":"Optional memory cost used to hash password.","default":null,"x-example":null},"passwordParallel":{"type":"integer","description":"Optional parallelization cost used to hash password.","default":null,"x-example":null},"passwordLength":{"type":"integer","description":"Optional hash length used to hash password.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordCpu","passwordMemory","passwordParallel","passwordLength"]}}]}},"\/users\/scrypt-modified":{"post":{"summary":"Create user with Scrypt modified password","operationId":"usersCreateScryptModifiedUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptModifiedUser","weight":237,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-modified-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt Modified.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordSaltSeparator":{"type":"string","description":"Salt separator used to hash password.","default":null,"x-example":"<PASSWORD_SALT_SEPARATOR>"},"passwordSignerKey":{"type":"string","description":"Signer key used to hash password.","default":null,"x-example":"<PASSWORD_SIGNER_KEY>"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordSaltSeparator","passwordSignerKey"]}}]}},"\/users\/sha":{"post":{"summary":"Create user with SHA password","operationId":"usersCreateSHAUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createSHAUser","weight":234,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-s-h-a-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using SHA.","default":null,"x-example":"password"},"passwordVersion":{"type":"string","description":"Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'","default":"","x-example":"sha1","enum":["sha1","sha224","sha256","sha384","sha512\/224","sha512\/256","sha512","sha3-224","sha3-256","sha3-384","sha3-512"],"x-enum-name":"PasswordHash","x-enum-keys":[]},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/usage":{"get":{"summary":"Get users usage stats","operationId":"usersGetUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"","responses":{"200":{"description":"UsageUsers","schema":{"$ref":"#\/definitions\/usageUsers"}}},"x-appwrite":{"method":"getUsage","weight":272,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"range","description":"Date range.","required":false,"type":"string","x-example":"24h","enum":["24h","30d","90d"],"x-enum-name":"UserUsageRange","x-enum-keys":["Twenty Four Hours","Thirty Days","Ninety Days"],"default":"30d","in":"query"}]}},"\/users\/{userId}":{"get":{"summary":"Get user","operationId":"usersGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":240,"cookies":false,"type":"","deprecated":false,"demo":"users\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user","operationId":"usersDelete","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":268,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/email":{"patch":{"summary":"Update email","operationId":"usersUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":253,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"}},"required":["email"]}}]}},"\/users\/{userId}\/jwts":{"post":{"summary":"Create user JWT","operationId":"usersCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":271,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.","default":"recent","x-example":"<SESSION_ID>"},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","default":900,"x-example":0}}}}]}},"\/users\/{userId}\/labels":{"put":{"summary":"Update user labels","operationId":"usersUpdateLabels","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateLabels","weight":249,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-labels.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"labels":{"type":"array","description":"Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["labels"]}}]}},"\/users\/{userId}\/logs":{"get":{"summary":"List user logs","operationId":"usersListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":245,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/users\/{userId}\/memberships":{"get":{"summary":"List user memberships","operationId":"usersListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user membership list by its unique ID.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":244,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa":{"patch":{"summary":"Update MFA","operationId":"usersUpdateMfa","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Enable or disable MFA on a user account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfa","weight":258,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/users\/{userId}\/mfa\/authenticators\/{type}":{"delete":{"summary":"Delete Authenticator","operationId":"usersDeleteMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete an authenticator app.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":263,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/users\/{userId}\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"usersListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":259,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"usersGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":260,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"put":{"summary":"Regenerate MFA Recovery Codes","operationId":"usersUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":262,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Create MFA Recovery Codes","operationId":"usersCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":261,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/name":{"patch":{"summary":"Update name","operationId":"usersUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user name by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":251,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/users\/{userId}\/password":{"patch":{"summary":"Update password","operationId":"usersUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user password by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":252,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null}},"required":["password"]}}]}},"\/users\/{userId}\/phone":{"patch":{"summary":"Update phone","operationId":"usersUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":254,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"number":{"type":"string","description":"User phone number.","default":null,"x-example":"+12065550100"}},"required":["number"]}}]}},"\/users\/{userId}\/prefs":{"get":{"summary":"Get user preferences","operationId":"usersGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user preferences by its unique ID.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":241,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Update user preferences","operationId":"usersUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user preferences by its unique ID. 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.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":256,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users\/{userId}\/sessions":{"get":{"summary":"List user sessions","operationId":"usersListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user sessions list by its unique ID.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":243,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"post":{"summary":"Create session","operationId":"usersCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":264,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user sessions","operationId":"usersDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete all user's sessions by using the user's unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":267,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/sessions\/{sessionId}":{"delete":{"summary":"Delete user session","operationId":"usersDeleteSession","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user sessions by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":266,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"sessionId","description":"Session ID.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/users\/{userId}\/status":{"patch":{"summary":"Update user status","operationId":"usersUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":248,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"User Status. To activate the user pass `true` and to block the user pass `false`.","default":null,"x-example":false}},"required":["status"]}}]}},"\/users\/{userId}\/targets":{"get":{"summary":"List User Targets","operationId":"usersListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the messaging targets that are associated with a user.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":246,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create User Target","operationId":"usersCreateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a messaging target.","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createTarget","weight":238,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","default":null,"x-example":"email","enum":["email","sms","push"],"x-enum-name":"MessagingProviderType","x-enum-keys":[]},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}},"required":["targetId","providerType","identifier"]}}]}},"\/users\/{userId}\/targets\/{targetId}":{"get":{"summary":"Get User Target","operationId":"usersGetTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user's push notification target by ID.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"getTarget","weight":242,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]},"patch":{"summary":"Update User target","operationId":"usersUpdateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update a messaging target.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updateTarget","weight":257,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":"","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}}}}]},"delete":{"summary":"Delete user target","operationId":"usersDeleteTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete a messaging target.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTarget","weight":269,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/users\/{userId}\/tokens":{"post":{"summary":"Create token","operationId":"usersCreateToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createToken","weight":265,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"length":{"type":"integer","description":"Token length in characters. The default length is 6 characters","default":6,"x-example":4},"expire":{"type":"integer","description":"Token expiration period in seconds. The default expiration is 15 minutes.","default":900,"x-example":60}}}}]}},"\/users\/{userId}\/verification":{"patch":{"summary":"Update email verification","operationId":"usersUpdateEmailVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmailVerification","weight":255,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"emailVerification":{"type":"boolean","description":"User email verification status.","default":null,"x-example":false}},"required":["emailVerification"]}}]}},"\/users\/{userId}\/verification\/phone":{"patch":{"summary":"Update phone verification","operationId":"usersUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":250,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"phoneVerification":{"type":"boolean","description":"User phone verification status.","default":null,"x-example":false}},"required":["phoneVerification"]}}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories":{"get":{"summary":"List Repositories","operationId":"vcsListRepositories","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Provider Repositories List","schema":{"$ref":"#\/definitions\/providerRepositoryList"}}},"x-appwrite":{"method":"listRepositories","weight":277,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-repositories.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create repository","operationId":"vcsCreateRepository","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"ProviderRepository","schema":{"$ref":"#\/definitions\/providerRepository"}}},"x-appwrite":{"method":"createRepository","weight":278,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/create-repository.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Repository name (slug)","default":null,"x-example":"<NAME>"},"private":{"type":"boolean","description":"Mark repository public or private","default":null,"x-example":false}},"required":["name","private"]}}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}":{"get":{"summary":"Get repository","operationId":"vcsGetRepository","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"ProviderRepository","schema":{"$ref":"#\/definitions\/providerRepository"}}},"x-appwrite":{"method":"getRepository","weight":279,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-repository.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/branches":{"get":{"summary":"List Repository Branches","operationId":"vcsListRepositoryBranches","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Branches List","schema":{"$ref":"#\/definitions\/branchList"}}},"x-appwrite":{"method":"listRepositoryBranches","weight":280,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-repository-branches.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/contents":{"get":{"summary":"Get files and directories of a VCS repository","operationId":"vcsGetRepositoryContents","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"VCS Content List","schema":{"$ref":"#\/definitions\/vcsContentList"}}},"x-appwrite":{"method":"getRepositoryContents","weight":275,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-repository-contents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"},{"name":"providerRootDirectory","description":"Path to get contents of nested directory","required":false,"type":"string","x-example":"<PROVIDER_ROOT_DIRECTORY>","default":"","in":"query"}]}},"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/detection":{"post":{"summary":"Detect runtime settings from source code","operationId":"vcsCreateRepositoryDetection","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Detection","schema":{"$ref":"#\/definitions\/detection"}}},"x-appwrite":{"method":"createRepositoryDetection","weight":276,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/create-repository-detection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"providerRepositoryId","description":"Repository Id","required":true,"type":"string","x-example":"<PROVIDER_REPOSITORY_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerRootDirectory":{"type":"string","description":"Path to Root Directory","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"}}}}]}},"\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}":{"patch":{"summary":"Authorize external deployment","operationId":"vcsUpdateExternalDeployments","consumes":["application\/json"],"produces":[],"tags":["vcs"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateExternalDeployments","weight":285,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/update-external-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"},{"name":"repositoryId","description":"VCS Repository Id","required":true,"type":"string","x-example":"<REPOSITORY_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerPullRequestId":{"type":"string","description":"GitHub Pull Request Id","default":null,"x-example":"<PROVIDER_PULL_REQUEST_ID>"}},"required":["providerPullRequestId"]}}]}},"\/vcs\/installations":{"get":{"summary":"List installations","operationId":"vcsListInstallations","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Installations List","schema":{"$ref":"#\/definitions\/installationList"}}},"x-appwrite":{"method":"listInstallations","weight":282,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/list-installations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-installations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"queries","description":"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: provider, organization","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/vcs\/installations\/{installationId}":{"get":{"summary":"Get installation","operationId":"vcsGetInstallation","consumes":["application\/json"],"produces":["application\/json"],"tags":["vcs"],"description":"","responses":{"200":{"description":"Installation","schema":{"$ref":"#\/definitions\/installation"}}},"x-appwrite":{"method":"getInstallation","weight":283,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/get-installation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-installation.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.read","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"}]},"delete":{"summary":"Delete Installation","operationId":"vcsDeleteInstallation","consumes":["application\/json"],"produces":[],"tags":["vcs"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteInstallation","weight":284,"cookies":false,"type":"","deprecated":false,"demo":"vcs\/delete-installation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/delete-installation.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"vcs.write","platforms":["console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"installationId","description":"Installation Id","required":true,"type":"string","x-example":"<INSTALLATION_ID>","in":"path"}]}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"definitions":{"any":{"description":"Any","type":"object","additionalProperties":true},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"type":"object","$ref":"#\/definitions\/document"},"x-example":""}},"required":["total","documents"]},"collectionList":{"description":"Collections List","type":"object","properties":{"total":{"type":"integer","description":"Total number of collections documents that matched your query.","x-example":5,"format":"int32"},"collections":{"type":"array","description":"List of collections.","items":{"type":"object","$ref":"#\/definitions\/collection"},"x-example":""}},"required":["total","collections"]},"databaseList":{"description":"Databases List","type":"object","properties":{"total":{"type":"integer","description":"Total number of databases documents that matched your query.","x-example":5,"format":"int32"},"databases":{"type":"array","description":"List of databases.","items":{"type":"object","$ref":"#\/definitions\/database"},"x-example":""}},"required":["total","databases"]},"indexList":{"description":"Indexes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of indexes documents that matched your query.","x-example":5,"format":"int32"},"indexes":{"type":"array","description":"List of indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":""}},"required":["total","indexes"]},"userList":{"description":"Users List","type":"object","properties":{"total":{"type":"integer","description":"Total number of users documents that matched your query.","x-example":5,"format":"int32"},"users":{"type":"array","description":"List of users.","items":{"type":"object","$ref":"#\/definitions\/user"},"x-example":""}},"required":["total","users"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"type":"object","$ref":"#\/definitions\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"type":"object","$ref":"#\/definitions\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"type":"object","$ref":"#\/definitions\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"type":"object","$ref":"#\/definitions\/file"},"x-example":""}},"required":["total","files"]},"bucketList":{"description":"Buckets List","type":"object","properties":{"total":{"type":"integer","description":"Total number of buckets documents that matched your query.","x-example":5,"format":"int32"},"buckets":{"type":"array","description":"List of buckets.","items":{"type":"object","$ref":"#\/definitions\/bucket"},"x-example":""}},"required":["total","buckets"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"type":"object","$ref":"#\/definitions\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"type":"object","$ref":"#\/definitions\/membership"},"x-example":""}},"required":["total","memberships"]},"functionList":{"description":"Functions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of functions documents that matched your query.","x-example":5,"format":"int32"},"functions":{"type":"array","description":"List of functions.","items":{"type":"object","$ref":"#\/definitions\/function"},"x-example":""}},"required":["total","functions"]},"installationList":{"description":"Installations List","type":"object","properties":{"total":{"type":"integer","description":"Total number of installations documents that matched your query.","x-example":5,"format":"int32"},"installations":{"type":"array","description":"List of installations.","items":{"type":"object","$ref":"#\/definitions\/installation"},"x-example":""}},"required":["total","installations"]},"providerRepositoryList":{"description":"Provider Repositories List","type":"object","properties":{"total":{"type":"integer","description":"Total number of providerRepositories documents that matched your query.","x-example":5,"format":"int32"},"providerRepositories":{"type":"array","description":"List of providerRepositories.","items":{"type":"object","$ref":"#\/definitions\/providerRepository"},"x-example":""}},"required":["total","providerRepositories"]},"branchList":{"description":"Branches List","type":"object","properties":{"total":{"type":"integer","description":"Total number of branches documents that matched your query.","x-example":5,"format":"int32"},"branches":{"type":"array","description":"List of branches.","items":{"type":"object","$ref":"#\/definitions\/branch"},"x-example":""}},"required":["total","branches"]},"runtimeList":{"description":"Runtimes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of runtimes documents that matched your query.","x-example":5,"format":"int32"},"runtimes":{"type":"array","description":"List of runtimes.","items":{"type":"object","$ref":"#\/definitions\/runtime"},"x-example":""}},"required":["total","runtimes"]},"deploymentList":{"description":"Deployments List","type":"object","properties":{"total":{"type":"integer","description":"Total number of deployments documents that matched your query.","x-example":5,"format":"int32"},"deployments":{"type":"array","description":"List of deployments.","items":{"type":"object","$ref":"#\/definitions\/deployment"},"x-example":""}},"required":["total","deployments"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"type":"object","$ref":"#\/definitions\/execution"},"x-example":""}},"required":["total","executions"]},"projectList":{"description":"Projects List","type":"object","properties":{"total":{"type":"integer","description":"Total number of projects documents that matched your query.","x-example":5,"format":"int32"},"projects":{"type":"array","description":"List of projects.","items":{"type":"object","$ref":"#\/definitions\/project"},"x-example":""}},"required":["total","projects"]},"webhookList":{"description":"Webhooks List","type":"object","properties":{"total":{"type":"integer","description":"Total number of webhooks documents that matched your query.","x-example":5,"format":"int32"},"webhooks":{"type":"array","description":"List of webhooks.","items":{"type":"object","$ref":"#\/definitions\/webhook"},"x-example":""}},"required":["total","webhooks"]},"keyList":{"description":"API Keys List","type":"object","properties":{"total":{"type":"integer","description":"Total number of keys documents that matched your query.","x-example":5,"format":"int32"},"keys":{"type":"array","description":"List of keys.","items":{"type":"object","$ref":"#\/definitions\/key"},"x-example":""}},"required":["total","keys"]},"platformList":{"description":"Platforms List","type":"object","properties":{"total":{"type":"integer","description":"Total number of platforms documents that matched your query.","x-example":5,"format":"int32"},"platforms":{"type":"array","description":"List of platforms.","items":{"type":"object","$ref":"#\/definitions\/platform"},"x-example":""}},"required":["total","platforms"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"type":"object","$ref":"#\/definitions\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"type":"object","$ref":"#\/definitions\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"type":"object","$ref":"#\/definitions\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"type":"object","$ref":"#\/definitions\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"type":"object","$ref":"#\/definitions\/phone"},"x-example":""}},"required":["total","phones"]},"variableList":{"description":"Variables List","type":"object","properties":{"total":{"type":"integer","description":"Total number of variables documents that matched your query.","x-example":5,"format":"int32"},"variables":{"type":"array","description":"List of variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":""}},"required":["total","variables"]},"proxyRuleList":{"description":"Rule List","type":"object","properties":{"total":{"type":"integer","description":"Total number of rules documents that matched your query.","x-example":5,"format":"int32"},"rules":{"type":"array","description":"List of rules.","items":{"type":"object","$ref":"#\/definitions\/proxyRule"},"x-example":""}},"required":["total","rules"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"type":"object","$ref":"#\/definitions\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"providerList":{"description":"Provider list","type":"object","properties":{"total":{"type":"integer","description":"Total number of providers documents that matched your query.","x-example":5,"format":"int32"},"providers":{"type":"array","description":"List of providers.","items":{"type":"object","$ref":"#\/definitions\/provider"},"x-example":""}},"required":["total","providers"]},"messageList":{"description":"Message list","type":"object","properties":{"total":{"type":"integer","description":"Total number of messages documents that matched your query.","x-example":5,"format":"int32"},"messages":{"type":"array","description":"List of messages.","items":{"type":"object","$ref":"#\/definitions\/message"},"x-example":""}},"required":["total","messages"]},"topicList":{"description":"Topic list","type":"object","properties":{"total":{"type":"integer","description":"Total number of topics documents that matched your query.","x-example":5,"format":"int32"},"topics":{"type":"array","description":"List of topics.","items":{"type":"object","$ref":"#\/definitions\/topic"},"x-example":""}},"required":["total","topics"]},"subscriberList":{"description":"Subscriber list","type":"object","properties":{"total":{"type":"integer","description":"Total number of subscribers documents that matched your query.","x-example":5,"format":"int32"},"subscribers":{"type":"array","description":"List of subscribers.","items":{"type":"object","$ref":"#\/definitions\/subscriber"},"x-example":""}},"required":["total","subscribers"]},"targetList":{"description":"Target list","type":"object","properties":{"total":{"type":"integer","description":"Total number of targets documents that matched your query.","x-example":5,"format":"int32"},"targets":{"type":"array","description":"List of targets.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":""}},"required":["total","targets"]},"migrationList":{"description":"Migrations List","type":"object","properties":{"total":{"type":"integer","description":"Total number of migrations documents that matched your query.","x-example":5,"format":"int32"},"migrations":{"type":"array","description":"List of migrations.","items":{"type":"object","$ref":"#\/definitions\/migration"},"x-example":""}},"required":["total","migrations"]},"firebaseProjectList":{"description":"Migrations Firebase Projects List","type":"object","properties":{"total":{"type":"integer","description":"Total number of projects documents that matched your query.","x-example":5,"format":"int32"},"projects":{"type":"array","description":"List of projects.","items":{"type":"object","$ref":"#\/definitions\/firebaseProject"},"x-example":""}},"required":["total","projects"]},"vcsContentList":{"description":"VCS Content List","type":"object","properties":{"total":{"type":"integer","description":"Total number of contents documents that matched your query.","x-example":5,"format":"int32"},"contents":{"type":"array","description":"List of contents.","items":{"type":"object","$ref":"#\/definitions\/vcsContent"},"x-example":""}},"required":["total","contents"]},"database":{"description":"Database","type":"object","properties":{"$id":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Database name.","x-example":"My Database"},"$createdAt":{"type":"string","description":"Database creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Database update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"enabled":{"type":"boolean","description":"If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false}},"required":["$id","name","$createdAt","$updatedAt","enabled"]},"collection":{"description":"Collection","type":"object","properties":{"$id":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Collection creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Collection update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Collection name.","x-example":"My Collection"},"enabled":{"type":"boolean","description":"Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false},"documentSecurity":{"type":"boolean","description":"Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"attributes":{"type":"array","description":"Collection attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":{}},"indexes":{"type":"array","description":"Collection indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":{}}},"required":["$id","$createdAt","$updatedAt","$permissions","databaseId","name","enabled","documentSecurity","attributes","indexes"]},"attributeList":{"description":"Attributes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of attributes in the given collection.","x-example":5,"format":"int32"},"attributes":{"type":"array","description":"List of attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":""}},"required":["total","attributes"]},"attributeString":{"description":"AttributeString","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"size":{"type":"integer","description":"Attribute size.","x-example":128,"format":"int32"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default","x-nullable":true}},"required":["key","type","status","error","required","size"]},"attributeInteger":{"description":"AttributeInteger","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"count"},"type":{"type":"string","description":"Attribute type.","x-example":"integer"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"integer","description":"Minimum value to enforce for new documents.","x-example":1,"format":"int32","x-nullable":true},"max":{"type":"integer","description":"Maximum value to enforce for new documents.","x-example":10,"format":"int32","x-nullable":true},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":10,"format":"int32","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeFloat":{"description":"AttributeFloat","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"percentageCompleted"},"type":{"type":"string","description":"Attribute type.","x-example":"double"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"number","description":"Minimum value to enforce for new documents.","x-example":1.5,"format":"double","x-nullable":true},"max":{"type":"number","description":"Maximum value to enforce for new documents.","x-example":10.5,"format":"double","x-nullable":true},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":2.5,"format":"double","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeBoolean":{"description":"AttributeBoolean","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"isEnabled"},"type":{"type":"string","description":"Attribute type.","x-example":"boolean"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"x-nullable":true}},"required":["key","type","status","error","required"]},"attributeEmail":{"description":"AttributeEmail","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"userEmail"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"email"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default@example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeEnum":{"description":"AttributeEnum","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"status"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"elements":{"type":"array","description":"Array of elements in enumerated type.","items":{"type":"string"},"x-example":"element"},"format":{"type":"string","description":"String format.","x-example":"enum"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"element","x-nullable":true}},"required":["key","type","status","error","required","elements","format"]},"attributeIp":{"description":"AttributeIP","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"ipAddress"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"ip"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"192.0.2.0","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeUrl":{"description":"AttributeURL","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"githubUrl"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"url"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"http:\/\/example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeDatetime":{"description":"AttributeDatetime","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"birthDay"},"type":{"type":"string","description":"Attribute type.","x-example":"datetime"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"ISO 8601 format.","x-example":"datetime"},"default":{"type":"string","description":"Default value for attribute when not provided. Only null is optional","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeRelationship":{"description":"AttributeRelationship","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"relatedCollection":{"type":"string","description":"The ID of the related collection.","x-example":"collection"},"relationType":{"type":"string","description":"The type of the relationship.","x-example":"oneToOne|oneToMany|manyToOne|manyToMany"},"twoWay":{"type":"boolean","description":"Is the relationship two-way?","x-example":false},"twoWayKey":{"type":"string","description":"The key of the two-way relationship.","x-example":"string"},"onDelete":{"type":"string","description":"How deleting the parent document will propagate to child documents.","x-example":"restrict|cascade|setNull"},"side":{"type":"string","description":"Whether this is the parent or child side of the relationship","x-example":"parent|child"}},"required":["key","type","status","error","required","relatedCollection","relationType","twoWay","twoWayKey","onDelete","side"]},"index":{"description":"Index","type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":"index1"},"type":{"type":"string","description":"Index type.","x-example":"primary"},"status":{"type":"string","description":"Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an index.","x-example":"string"},"attributes":{"type":"array","description":"Index attributes.","items":{"type":"string"},"x-example":[]},"orders":{"type":"array","description":"Index orders.","items":{"type":"string"},"x-example":[],"x-nullable":true}},"required":["key","type","status","error","attributes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","x-nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","x-nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"x-oneOf":[{"$ref":"#\/definitions\/algoArgon2"},{"$ref":"#\/definitions\/algoScrypt"},{"$ref":"#\/definitions\/algoScryptModified"},{"$ref":"#\/definitions\/algoBcrypt"},{"$ref":"#\/definitions\/algoPhpass"},{"$ref":"#\/definitions\/algoSha"},{"$ref":"#\/definitions\/algoMd5"}]},"x-nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"bucket":{"description":"Bucket","type":"object","properties":{"$id":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Bucket creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Bucket update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"fileSecurity":{"type":"boolean","description":"Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"name":{"type":"string","description":"Bucket name.","x-example":"Documents"},"enabled":{"type":"boolean","description":"Bucket enabled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size supported.","x-example":100,"format":"int32"},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions.","items":{"type":"string"},"x-example":["jpg","png"]},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).","x-example":"gzip"},"encryption":{"type":"boolean","description":"Bucket is encrypted.","x-example":false},"antivirus":{"type":"boolean","description":"Virus scanning is enabled.","x-example":false}},"required":["$id","$createdAt","$updatedAt","$permissions","fileSecurity","name","enabled","maximumFileSize","allowedFileExtensions","compression","encryption","antivirus"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"function":{"description":"Function","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"execute":{"type":"array","description":"Execution permissions.","items":{"type":"string"},"x-example":"users"},"name":{"type":"string","description":"Function name.","x-example":"My Function"},"enabled":{"type":"boolean","description":"Function enabled.","x-example":false},"live":{"type":"boolean","description":"Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"runtime":{"type":"string","description":"Function execution runtime.","x-example":"python-3.8"},"deployment":{"type":"string","description":"Function's active deployment ID.","x-example":"5e5ea5c16897e"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"vars":{"type":"array","description":"Function variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":[]},"events":{"type":"array","description":"Function trigger events.","items":{"type":"string"},"x-example":"account.create"},"schedule":{"type":"string","description":"Function execution schedult in CRON format.","x-example":"5 4 * * *"},"timeout":{"type":"integer","description":"Function execution timeout in seconds.","x-example":300,"format":"int32"},"entrypoint":{"type":"string","description":"The entrypoint file used to execute the deployment.","x-example":"index.js"},"commands":{"type":"string","description":"The build command used to build the deployment.","x-example":"npm install"},"version":{"type":"string","description":"Version of Open Runtimes used for the function.","x-example":"v2"},"installationId":{"type":"string","description":"Function VCS (Version Control System) installation id.","x-example":"6m40at4ejk5h2u9s1hboo"},"providerRepositoryId":{"type":"string","description":"VCS (Version Control System) Repository ID","x-example":"appwrite"},"providerBranch":{"type":"string","description":"VCS (Version Control System) branch name","x-example":"main"},"providerRootDirectory":{"type":"string","description":"Path to function in VCS (Version Control System) repository","x-example":"functions\/helloWorld"},"providerSilentMode":{"type":"boolean","description":"Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests","x-example":false}},"required":["$id","$createdAt","$updatedAt","execute","name","enabled","live","logging","runtime","deployment","scopes","vars","events","schedule","timeout","entrypoint","commands","version","installationId","providerRepositoryId","providerBranch","providerRootDirectory","providerSilentMode"]},"installation":{"description":"Installation","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"VCS (Version Control System) provider name.","x-example":"github"},"organization":{"type":"string","description":"VCS (Version Control System) organization name.","x-example":"appwrite"},"providerInstallationId":{"type":"string","description":"VCS (Version Control System) installation ID.","x-example":"5322"}},"required":["$id","$createdAt","$updatedAt","provider","organization","providerInstallationId"]},"providerRepository":{"description":"ProviderRepository","type":"object","properties":{"id":{"type":"string","description":"VCS (Version Control System) repository ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"VCS (Version Control System) repository name.","x-example":"appwrite"},"organization":{"type":"string","description":"VCS (Version Control System) organization name","x-example":"appwrite"},"provider":{"type":"string","description":"VCS (Version Control System) provider name.","x-example":"github"},"private":{"type":"boolean","description":"Is VCS (Version Control System) repository private?","x-example":true},"runtime":{"type":"string","description":"Auto-detected runtime suggestion. Empty if getting response of getRuntime().","x-example":"node"},"pushedAt":{"type":"string","description":"Last commit date in ISO 8601 format.","x-example":"datetime"}},"required":["id","name","organization","provider","private","runtime","pushedAt"]},"detection":{"description":"Detection","type":"object","properties":{"runtime":{"type":"string","description":"Runtime","x-example":"node"}},"required":["runtime"]},"vcsContent":{"description":"VcsContents","type":"object","properties":{"size":{"type":"integer","description":"Content size in bytes. Only files have size, and for directories, 0 is returned.","x-example":1523,"format":"int32","x-nullable":true},"isDirectory":{"type":"boolean","description":"If a content is a directory. Directories can be used to check nested contents.","x-example":true,"x-nullable":true},"name":{"type":"string","description":"Name of directory or file.","x-example":"Main.java"}},"required":["name"]},"branch":{"description":"Branch","type":"object","properties":{"name":{"type":"string","description":"Branch Name.","x-example":"main"}},"required":["name"]},"runtime":{"description":"Runtime","type":"object","properties":{"$id":{"type":"string","description":"Runtime ID.","x-example":"python-3.8"},"name":{"type":"string","description":"Runtime Name.","x-example":"Python"},"version":{"type":"string","description":"Runtime version.","x-example":"3.8"},"base":{"type":"string","description":"Base Docker image used to build the runtime.","x-example":"python:3.8-alpine"},"image":{"type":"string","description":"Image name of Docker Hub.","x-example":"appwrite\\\/runtime-for-python:3.8"},"logo":{"type":"string","description":"Name of the logo image.","x-example":"python.png"},"supports":{"type":"array","description":"List of supported architectures.","items":{"type":"string"},"x-example":"amd64"}},"required":["$id","name","version","base","image","logo","supports"]},"deployment":{"description":"Deployment","type":"object","properties":{"$id":{"type":"string","description":"Deployment ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Deployment update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"type":{"type":"string","description":"Type of deployment.","x-example":"vcs"},"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea6g16897e"},"resourceType":{"type":"string","description":"Resource type.","x-example":"functions"},"entrypoint":{"type":"string","description":"The entrypoint file to use to execute the deployment code.","x-example":"index.js"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"},"buildId":{"type":"string","description":"The current build ID.","x-example":"5e5ea5c16897e"},"activate":{"type":"boolean","description":"Whether the deployment should be automatically activated.","x-example":true},"status":{"type":"string","description":"The deployment status. Possible values are \"processing\", \"building\", \"waiting\", \"ready\", and \"failed\".","x-example":"ready"},"buildLogs":{"type":"string","description":"The build logs.","x-example":"Compiling source files..."},"buildTime":{"type":"integer","description":"The current build time in seconds.","x-example":128,"format":"int32"},"providerRepositoryName":{"type":"string","description":"The name of the vcs provider repository","x-example":"database"},"providerRepositoryOwner":{"type":"string","description":"The name of the vcs provider repository owner","x-example":"utopia"},"providerRepositoryUrl":{"type":"string","description":"The url of the vcs provider repository","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function"},"providerBranch":{"type":"string","description":"The branch of the vcs repository","x-example":"0.7.x"},"providerCommitHash":{"type":"string","description":"The commit hash of the vcs commit","x-example":"7c3f25d"},"providerCommitAuthorUrl":{"type":"string","description":"The url of vcs commit author","x-example":"https:\/\/github.com\/vermakhushboo"},"providerCommitAuthor":{"type":"string","description":"The name of vcs commit author","x-example":"Khushboo Verma"},"providerCommitMessage":{"type":"string","description":"The commit message","x-example":"Update index.js"},"providerCommitUrl":{"type":"string","description":"The url of the vcs commit","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"},"providerBranchUrl":{"type":"string","description":"The branch of the vcs repository","x-example":"https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"}},"required":["$id","$createdAt","$updatedAt","type","resourceId","resourceType","entrypoint","size","buildId","activate","status","buildLogs","buildTime","providerRepositoryName","providerRepositoryOwner","providerRepositoryUrl","providerBranch","providerCommitHash","providerCommitAuthorUrl","providerCommitAuthor","providerCommitMessage","providerCommitUrl","providerBranchUrl"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"build":{"description":"Build","type":"object","properties":{"$id":{"type":"string","description":"Build ID.","x-example":"5e5ea5c16897e"},"deploymentId":{"type":"string","description":"The deployment that created this build.","x-example":"5e5ea5c16897e"},"status":{"type":"string","description":"The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built","x-example":"ready"},"stdout":{"type":"string","description":"The stdout of the build.","x-example":""},"stderr":{"type":"string","description":"The stderr of the build.","x-example":""},"startTime":{"type":"string","description":"The deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"endTime":{"type":"string","description":"The time the build was finished in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"duration":{"type":"integer","description":"The build duration in seconds.","x-example":0,"format":"int32"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"}},"required":["$id","deploymentId","status","stdout","stderr","startTime","endTime","duration","size"]},"project":{"description":"Project","type":"object","properties":{"$id":{"type":"string","description":"Project ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Project creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Project update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Project name.","x-example":"New Project"},"description":{"type":"string","description":"Project description.","x-example":"This is a new project."},"teamId":{"type":"string","description":"Project team ID.","x-example":"1592981250"},"logo":{"type":"string","description":"Project logo file ID.","x-example":"5f5c451b403cb"},"url":{"type":"string","description":"Project website URL.","x-example":"5f5c451b403cb"},"legalName":{"type":"string","description":"Company legal name.","x-example":"Company LTD."},"legalCountry":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.","x-example":"US"},"legalState":{"type":"string","description":"State name.","x-example":"New York"},"legalCity":{"type":"string","description":"City name.","x-example":"New York City."},"legalAddress":{"type":"string","description":"Company Address.","x-example":"620 Eighth Avenue, New York, NY 10018"},"legalTaxId":{"type":"string","description":"Company Tax ID.","x-example":"131102020"},"authDuration":{"type":"integer","description":"Session duration in seconds.","x-example":60,"format":"int32"},"authLimit":{"type":"integer","description":"Max users allowed. 0 is unlimited.","x-example":100,"format":"int32"},"authSessionsLimit":{"type":"integer","description":"Max sessions allowed per user. 100 maximum.","x-example":10,"format":"int32"},"authPasswordHistory":{"type":"integer","description":"Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.","x-example":5,"format":"int32"},"authPasswordDictionary":{"type":"boolean","description":"Whether or not to check user's password against most commonly used passwords.","x-example":true},"authPersonalDataCheck":{"type":"boolean","description":"Whether or not to check the user password for similarity with their personal data.","x-example":true},"authMockNumbers":{"type":"array","description":"An array of mock numbers and their corresponding verification codes (OTPs).","items":{"type":"object","$ref":"#\/definitions\/mockNumber"},"x-example":[{}]},"authSessionAlerts":{"type":"boolean","description":"Whether or not to send session alert emails to users.","x-example":true},"oAuthProviders":{"type":"array","description":"List of Auth Providers.","items":{"type":"object","$ref":"#\/definitions\/authProvider"},"x-example":[{}]},"platforms":{"type":"array","description":"List of Platforms.","items":{"type":"object","$ref":"#\/definitions\/platform"},"x-example":{}},"webhooks":{"type":"array","description":"List of Webhooks.","items":{"type":"object","$ref":"#\/definitions\/webhook"},"x-example":{}},"keys":{"type":"array","description":"List of API Keys.","items":{"type":"object","$ref":"#\/definitions\/key"},"x-example":{}},"smtpEnabled":{"type":"boolean","description":"Status for custom SMTP","x-example":false},"smtpSenderName":{"type":"string","description":"SMTP sender name","x-example":"John Appwrite"},"smtpSenderEmail":{"type":"string","description":"SMTP sender email","x-example":"john@appwrite.io"},"smtpReplyTo":{"type":"string","description":"SMTP reply to email","x-example":"support@appwrite.io"},"smtpHost":{"type":"string","description":"SMTP server host name","x-example":"mail.appwrite.io"},"smtpPort":{"type":"integer","description":"SMTP server port","x-example":25,"format":"int32"},"smtpUsername":{"type":"string","description":"SMTP server username","x-example":"emailuser"},"smtpPassword":{"type":"string","description":"SMTP server password","x-example":"securepassword"},"smtpSecure":{"type":"string","description":"SMTP server secure protocol","x-example":"tls"},"authEmailPassword":{"type":"boolean","description":"Email\/Password auth method status","x-example":true},"authUsersAuthMagicURL":{"type":"boolean","description":"Magic URL auth method status","x-example":true},"authEmailOtp":{"type":"boolean","description":"Email (OTP) auth method status","x-example":true},"authAnonymous":{"type":"boolean","description":"Anonymous auth method status","x-example":true},"authInvites":{"type":"boolean","description":"Invites auth method status","x-example":true},"authJWT":{"type":"boolean","description":"JWT auth method status","x-example":true},"authPhone":{"type":"boolean","description":"Phone auth method status","x-example":true},"serviceStatusForAccount":{"type":"boolean","description":"Account service status","x-example":true},"serviceStatusForAvatars":{"type":"boolean","description":"Avatars service status","x-example":true},"serviceStatusForDatabases":{"type":"boolean","description":"Databases service status","x-example":true},"serviceStatusForLocale":{"type":"boolean","description":"Locale service status","x-example":true},"serviceStatusForHealth":{"type":"boolean","description":"Health service status","x-example":true},"serviceStatusForStorage":{"type":"boolean","description":"Storage service status","x-example":true},"serviceStatusForTeams":{"type":"boolean","description":"Teams service status","x-example":true},"serviceStatusForUsers":{"type":"boolean","description":"Users service status","x-example":true},"serviceStatusForFunctions":{"type":"boolean","description":"Functions service status","x-example":true},"serviceStatusForGraphql":{"type":"boolean","description":"GraphQL service status","x-example":true},"serviceStatusForMessaging":{"type":"boolean","description":"Messaging service status","x-example":true}},"required":["$id","$createdAt","$updatedAt","name","description","teamId","logo","url","legalName","legalCountry","legalState","legalCity","legalAddress","legalTaxId","authDuration","authLimit","authSessionsLimit","authPasswordHistory","authPasswordDictionary","authPersonalDataCheck","authMockNumbers","authSessionAlerts","oAuthProviders","platforms","webhooks","keys","smtpEnabled","smtpSenderName","smtpSenderEmail","smtpReplyTo","smtpHost","smtpPort","smtpUsername","smtpPassword","smtpSecure","authEmailPassword","authUsersAuthMagicURL","authEmailOtp","authAnonymous","authInvites","authJWT","authPhone","serviceStatusForAccount","serviceStatusForAvatars","serviceStatusForDatabases","serviceStatusForLocale","serviceStatusForHealth","serviceStatusForStorage","serviceStatusForTeams","serviceStatusForUsers","serviceStatusForFunctions","serviceStatusForGraphql","serviceStatusForMessaging"]},"webhook":{"description":"Webhook","type":"object","properties":{"$id":{"type":"string","description":"Webhook ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Webhook creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Webhook update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Webhook name.","x-example":"My Webhook"},"url":{"type":"string","description":"Webhook URL endpoint.","x-example":"https:\/\/example.com\/webhook"},"events":{"type":"array","description":"Webhook trigger events.","items":{"type":"string"},"x-example":"database.collections.update"},"security":{"type":"boolean","description":"Indicated if SSL \/ TLS Certificate verification is enabled.","x-example":true},"httpUser":{"type":"string","description":"HTTP basic authentication username.","x-example":"username"},"httpPass":{"type":"string","description":"HTTP basic authentication password.","x-example":"password"},"signatureKey":{"type":"string","description":"Signature key which can be used to validated incoming","x-example":"ad3d581ca230e2b7059c545e5a"},"enabled":{"type":"boolean","description":"Indicates if this webhook is enabled.","x-example":true},"logs":{"type":"string","description":"Webhook error logs from the most recent failure.","x-example":"Failed to connect to remote server."},"attempts":{"type":"integer","description":"Number of consecutive failed webhook attempts.","x-example":10,"format":"int32"}},"required":["$id","$createdAt","$updatedAt","name","url","events","security","httpUser","httpPass","signatureKey","enabled","logs","attempts"]},"key":{"description":"Key","type":"object","properties":{"$id":{"type":"string","description":"Key ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Key creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Key update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Key name.","x-example":"My API Key"},"expire":{"type":"string","description":"Key expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"secret":{"type":"string","description":"Secret key.","x-example":"919c2d18fb5d4...a2ae413da83346ad2"},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"},"sdks":{"type":"array","description":"List of SDK user agents that used this key.","items":{"type":"string"},"x-example":"appwrite:flutter"}},"required":["$id","$createdAt","$updatedAt","name","expire","scopes","secret","accessedAt","sdks"]},"mockNumber":{"description":"Mock Number","type":"object","properties":{"phone":{"type":"string","description":"Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.","x-example":"+1612842323"},"otp":{"type":"string","description":"Mock OTP for the number. ","x-example":"123456"}},"required":["phone","otp"]},"authProvider":{"description":"AuthProvider","type":"object","properties":{"key":{"type":"string","description":"Auth Provider.","x-example":"github"},"name":{"type":"string","description":"Auth Provider name.","x-example":"GitHub"},"appId":{"type":"string","description":"OAuth 2.0 application ID.","x-example":"259125845563242502"},"secret":{"type":"string","description":"OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.","x-example":"Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ"},"enabled":{"type":"boolean","description":"Auth Provider is active and can be used to create session.","x-example":""}},"required":["key","name","appId","secret","enabled"]},"platform":{"description":"Platform","type":"object","properties":{"$id":{"type":"string","description":"Platform ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Platform creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Platform update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Platform name.","x-example":"My Web App"},"type":{"type":"string","description":"Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, ios, android, and unity.","x-example":"web"},"key":{"type":"string","description":"Platform Key. iOS bundle ID or Android package name. Empty string for other platforms.","x-example":"com.company.appname"},"store":{"type":"string","description":"App store or Google Play store ID.","x-example":""},"hostname":{"type":"string","description":"Web app hostname. Empty string for other platforms.","x-example":true},"httpUser":{"type":"string","description":"HTTP basic authentication username.","x-example":"username"},"httpPass":{"type":"string","description":"HTTP basic authentication password.","x-example":"password"}},"required":["$id","$createdAt","$updatedAt","name","type","key","store","hostname","httpUser","httpPass"]},"variable":{"description":"Variable","type":"object","properties":{"$id":{"type":"string","description":"Variable ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"key":{"type":"string","description":"Variable key.","x-example":"API_KEY"},"value":{"type":"string","description":"Variable value.","x-example":"myPa$$word1"},"resourceType":{"type":"string","description":"Service to which the variable belongs. Possible values are \"project\", \"function\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"}},"required":["$id","$createdAt","$updatedAt","key","value","resourceType","resourceId"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"healthAntivirus":{"description":"Health Antivirus","type":"object","properties":{"version":{"type":"string","description":"Antivirus version.","x-example":"1.0.0"},"status":{"type":"string","description":"Antivirus status. Possible values can are: `disabled`, `offline`, `online`","x-example":"online"}},"required":["version","status"]},"healthQueue":{"description":"Health Queue","type":"object","properties":{"size":{"type":"integer","description":"Amount of actions in the queue.","x-example":8,"format":"int32"}},"required":["size"]},"healthStatus":{"description":"Health Status","type":"object","properties":{"name":{"type":"string","description":"Name of the service.","x-example":"database"},"ping":{"type":"integer","description":"Duration in milliseconds how long the health check took.","x-example":128,"format":"int32"},"status":{"type":"string","description":"Service status. Possible values can are: `pass`, `fail`","x-example":"pass"}},"required":["name","ping","status"]},"healthCertificate":{"description":"Health Certificate","type":"object","properties":{"name":{"type":"string","description":"Certificate name","x-example":"\/CN=www.google.com"},"subjectSN":{"type":"string","description":"Subject SN","x-example":""},"issuerOrganisation":{"type":"string","description":"Issuer organisation","x-example":""},"validFrom":{"type":"string","description":"Valid from","x-example":"1704200998"},"validTo":{"type":"string","description":"Valid to","x-example":"1711458597"},"signatureTypeSN":{"type":"string","description":"Signature type SN","x-example":"RSA-SHA256"}},"required":["name","subjectSN","issuerOrganisation","validFrom","validTo","signatureTypeSN"]},"healthTime":{"description":"Health Time","type":"object","properties":{"remoteTime":{"type":"integer","description":"Current unix timestamp on trustful remote server.","x-example":1639490751,"format":"int32"},"localTime":{"type":"integer","description":"Current unix timestamp of local server where Appwrite runs.","x-example":1639490844,"format":"int32"},"diff":{"type":"integer","description":"Difference of unix remote and local timestamps in milliseconds.","x-example":93,"format":"int32"}},"required":["remoteTime","localTime","diff"]},"metric":{"description":"Metric","type":"object","properties":{"value":{"type":"integer","description":"The value of this metric at the timestamp.","x-example":1,"format":"int32"},"date":{"type":"string","description":"The date at which this metric was aggregated in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["value","date"]},"metricBreakdown":{"description":"Metric Breakdown","type":"object","properties":{"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Resource name.","x-example":"Documents"},"value":{"type":"integer","description":"The value of this metric at the timestamp.","x-example":1,"format":"int32"}},"required":["resourceId","name","value"]},"usageDatabases":{"description":"UsageDatabases","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"databasesTotal":{"type":"integer","description":"Total aggregated number of databases.","x-example":0,"format":"int32"},"collectionsTotal":{"type":"integer","description":"Total aggregated number of collections.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"databases":{"type":"array","description":"Aggregated number of databases per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"collections":{"type":"array","description":"Aggregated number of collections per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","databasesTotal","collectionsTotal","documentsTotal","databases","collections","documents"]},"usageDatabase":{"description":"UsageDatabase","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"collectionsTotal":{"type":"integer","description":"Total aggregated number of collections.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"collections":{"type":"array","description":"Aggregated number of collections per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","collectionsTotal","documentsTotal","collections","documents"]},"usageCollection":{"description":"UsageCollection","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"documentsTotal":{"type":"integer","description":"Total aggregated number of of documents.","x-example":0,"format":"int32"},"documents":{"type":"array","description":"Aggregated number of documents per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","documentsTotal","documents"]},"usageUsers":{"description":"UsageUsers","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"usersTotal":{"type":"integer","description":"Total aggregated number of statistics of users.","x-example":0,"format":"int32"},"sessionsTotal":{"type":"integer","description":"Total aggregated number of active sessions.","x-example":0,"format":"int32"},"users":{"type":"array","description":"Aggregated number of users per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"sessions":{"type":"array","description":"Aggregated number of active sessions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","usersTotal","sessionsTotal","users","sessions"]},"usageStorage":{"description":"StorageUsage","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"bucketsTotal":{"type":"integer","description":"Total aggregated number of buckets","x-example":0,"format":"int32"},"filesTotal":{"type":"integer","description":"Total aggregated number of files.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated number of files storage (in bytes).","x-example":0,"format":"int32"},"buckets":{"type":"array","description":"Aggregated number of buckets per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"files":{"type":"array","description":"Aggregated number of files per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"storage":{"type":"array","description":"Aggregated number of files storage (in bytes) per period .","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","bucketsTotal","filesTotal","filesStorageTotal","buckets","files","storage"]},"usageBuckets":{"description":"UsageBuckets","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"filesTotal":{"type":"integer","description":"Total aggregated number of bucket files.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated number of bucket files storage (in bytes).","x-example":0,"format":"int32"},"files":{"type":"array","description":"Aggregated number of bucket files per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"storage":{"type":"array","description":"Aggregated number of bucket storage files (in bytes) per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","filesTotal","filesStorageTotal","files","storage"]},"usageFunctions":{"description":"UsageFunctions","type":"object","properties":{"range":{"type":"string","description":"Time range of the usage stats.","x-example":"30d"},"functionsTotal":{"type":"integer","description":"Total aggregated number of functions.","x-example":0,"format":"int32"},"deploymentsTotal":{"type":"integer","description":"Total aggregated number of functions deployments.","x-example":0,"format":"int32"},"deploymentsStorageTotal":{"type":"integer","description":"Total aggregated sum of functions deployment storage.","x-example":0,"format":"int32"},"buildsTotal":{"type":"integer","description":"Total aggregated number of functions build.","x-example":0,"format":"int32"},"buildsStorageTotal":{"type":"integer","description":"total aggregated sum of functions build storage.","x-example":0,"format":"int32"},"buildsTimeTotal":{"type":"integer","description":"Total aggregated sum of functions build compute time.","x-example":0,"format":"int32"},"executionsTotal":{"type":"integer","description":"Total aggregated number of functions execution.","x-example":0,"format":"int32"},"executionsTimeTotal":{"type":"integer","description":"Total aggregated sum of functions execution compute time.","x-example":0,"format":"int32"},"functions":{"type":"array","description":"Aggregated number of functions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":0},"deployments":{"type":"array","description":"Aggregated number of functions deployment per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"deploymentsStorage":{"type":"array","description":"Aggregated number of functions deployment storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"builds":{"type":"array","description":"Aggregated number of functions build per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsStorage":{"type":"array","description":"Aggregated sum of functions build storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsTime":{"type":"array","description":"Aggregated sum of functions build compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of functions execution per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executionsTime":{"type":"array","description":"Aggregated number of functions execution compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","functionsTotal","deploymentsTotal","deploymentsStorageTotal","buildsTotal","buildsStorageTotal","buildsTimeTotal","executionsTotal","executionsTimeTotal","functions","deployments","deploymentsStorage","builds","buildsStorage","buildsTime","executions","executionsTime"]},"usageFunction":{"description":"UsageFunction","type":"object","properties":{"range":{"type":"string","description":"The time range of the usage stats.","x-example":"30d"},"deploymentsTotal":{"type":"integer","description":"Total aggregated number of function deployments.","x-example":0,"format":"int32"},"deploymentsStorageTotal":{"type":"integer","description":"Total aggregated sum of function deployments storage.","x-example":0,"format":"int32"},"buildsTotal":{"type":"integer","description":"Total aggregated number of function builds.","x-example":0,"format":"int32"},"buildsStorageTotal":{"type":"integer","description":"total aggregated sum of function builds storage.","x-example":0,"format":"int32"},"buildsTimeTotal":{"type":"integer","description":"Total aggregated sum of function builds compute time.","x-example":0,"format":"int32"},"executionsTotal":{"type":"integer","description":"Total aggregated number of function executions.","x-example":0,"format":"int32"},"executionsTimeTotal":{"type":"integer","description":"Total aggregated sum of function executions compute time.","x-example":0,"format":"int32"},"deployments":{"type":"array","description":"Aggregated number of function deployments per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"deploymentsStorage":{"type":"array","description":"Aggregated number of function deployments storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"builds":{"type":"array","description":"Aggregated number of function builds per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsStorage":{"type":"array","description":"Aggregated sum of function builds storage per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"buildsTime":{"type":"array","description":"Aggregated sum of function builds compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of function executions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executionsTime":{"type":"array","description":"Aggregated number of function executions compute time per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]}},"required":["range","deploymentsTotal","deploymentsStorageTotal","buildsTotal","buildsStorageTotal","buildsTimeTotal","executionsTotal","executionsTimeTotal","deployments","deploymentsStorage","builds","buildsStorage","buildsTime","executions","executionsTime"]},"usageProject":{"description":"UsageProject","type":"object","properties":{"executionsTotal":{"type":"integer","description":"Total aggregated number of function executions.","x-example":0,"format":"int32"},"documentsTotal":{"type":"integer","description":"Total aggregated number of documents.","x-example":0,"format":"int32"},"databasesTotal":{"type":"integer","description":"Total aggregated number of databases.","x-example":0,"format":"int32"},"usersTotal":{"type":"integer","description":"Total aggregated number of users.","x-example":0,"format":"int32"},"filesStorageTotal":{"type":"integer","description":"Total aggregated sum of files storage size (in bytes).","x-example":0,"format":"int32"},"bucketsTotal":{"type":"integer","description":"Total aggregated number of buckets.","x-example":0,"format":"int32"},"requests":{"type":"array","description":"Aggregated number of requests per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"network":{"type":"array","description":"Aggregated number of consumed bandwidth per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"users":{"type":"array","description":"Aggregated number of users per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executions":{"type":"array","description":"Aggregated number of executions per period.","items":{"type":"object","$ref":"#\/definitions\/metric"},"x-example":[]},"executionsBreakdown":{"type":"array","description":"Aggregated breakdown in totals of executions by functions.","items":{"type":"object","$ref":"#\/definitions\/metricBreakdown"},"x-example":[]},"bucketsBreakdown":{"type":"array","description":"Aggregated breakdown in totals of usage by buckets.","items":{"type":"object","$ref":"#\/definitions\/metricBreakdown"},"x-example":[]}},"required":["executionsTotal","documentsTotal","databasesTotal","usersTotal","filesStorageTotal","bucketsTotal","requests","network","users","executions","executionsBreakdown","bucketsBreakdown"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"proxyRule":{"description":"Rule","type":"object","properties":{"$id":{"type":"string","description":"Rule ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Rule creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Rule update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"domain":{"type":"string","description":"Domain name.","x-example":"appwrite.company.com"},"resourceType":{"type":"string","description":"Action definition for the rule. Possible values are \"api\", \"function\", or \"redirect\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource for the action type. If resourceType is \"api\" or \"url\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"},"status":{"type":"string","description":"Domain verification status. Possible values are \"created\", \"verifying\", \"verified\" and \"unverified\"","x-example":"verified"},"logs":{"type":"string","description":"Certificate generation logs. This will return an empty string if generation did not run, or succeeded.","x-example":"HTTP challegne failed."},"renewAt":{"type":"string","description":"Certificate auto-renewal date in ISO 8601 format.","x-example":"datetime"}},"required":["$id","$createdAt","$updatedAt","domain","resourceType","resourceId","status","logs","renewAt"]},"smsTemplate":{"description":"SmsTemplate","type":"object","properties":{"type":{"type":"string","description":"Template type","x-example":"verification"},"locale":{"type":"string","description":"Template locale","x-example":"en_us"},"message":{"type":"string","description":"Template message","x-example":"Click on the link to verify your account."}},"required":["type","locale","message"]},"emailTemplate":{"description":"EmailTemplate","type":"object","properties":{"type":{"type":"string","description":"Template type","x-example":"verification"},"locale":{"type":"string","description":"Template locale","x-example":"en_us"},"message":{"type":"string","description":"Template message","x-example":"Click on the link to verify your account."},"senderName":{"type":"string","description":"Name of the sender","x-example":"My User"},"senderEmail":{"type":"string","description":"Email of the sender","x-example":"mail@appwrite.io"},"replyTo":{"type":"string","description":"Reply to email address","x-example":"emails@appwrite.io"},"subject":{"type":"string","description":"Email subject","x-example":"Please verify your email address"}},"required":["type","locale","message","senderName","senderEmail","replyTo","subject"]},"consoleVariables":{"description":"Console Variables","type":"object","properties":{"_APP_DOMAIN_TARGET":{"type":"string","description":"CNAME target for your Appwrite custom domains.","x-example":"appwrite.io"},"_APP_STORAGE_LIMIT":{"type":"integer","description":"Maximum file size allowed for file upload in bytes.","x-example":"30000000","format":"int32"},"_APP_FUNCTIONS_SIZE_LIMIT":{"type":"integer","description":"Maximum file size allowed for deployment in bytes.","x-example":"30000000","format":"int32"},"_APP_USAGE_STATS":{"type":"string","description":"Defines if usage stats are enabled. This value is set to 'enabled' by default, to disable the usage stats set the value to 'disabled'.","x-example":"enabled"},"_APP_VCS_ENABLED":{"type":"boolean","description":"Defines if VCS (Version Control System) is enabled.","x-example":true},"_APP_DOMAIN_ENABLED":{"type":"boolean","description":"Defines if main domain is configured. If so, custom domains can be created.","x-example":true},"_APP_ASSISTANT_ENABLED":{"type":"boolean","description":"Defines if AI assistant is enabled.","x-example":true}},"required":["_APP_DOMAIN_TARGET","_APP_STORAGE_LIMIT","_APP_FUNCTIONS_SIZE_LIMIT","_APP_USAGE_STATS","_APP_VCS_ENABLED","_APP_DOMAIN_ENABLED","_APP_ASSISTANT_ENABLED"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"provider":{"description":"Provider","type":"object","properties":{"$id":{"type":"string","description":"Provider ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Provider creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Provider update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name for the provider instance.","x-example":"Mailgun"},"provider":{"type":"string","description":"The name of the provider service.","x-example":"mailgun"},"enabled":{"type":"boolean","description":"Is provider enabled?","x-example":true},"type":{"type":"string","description":"Type of provider.","x-example":"sms"},"credentials":{"type":"object","additionalProperties":true,"description":"Provider credentials.","x-example":{"key":"123456789"}},"options":{"type":"object","additionalProperties":true,"description":"Provider options.","x-example":{"from":"sender-email@mydomain"}}},"required":["$id","$createdAt","$updatedAt","name","provider","enabled","type","credentials"]},"message":{"description":"Message","type":"object","properties":{"$id":{"type":"string","description":"Message ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Message creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Message update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerType":{"type":"string","description":"Message provider type.","x-example":"email"},"topics":{"type":"array","description":"Topic IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"users":{"type":"array","description":"User IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"targets":{"type":"array","description":"Target IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"scheduledAt":{"type":"string","description":"The scheduled time for message.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveredAt":{"type":"string","description":"The time when the message was delivered.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveryErrors":{"type":"array","description":"Delivery errors if any.","items":{"type":"string"},"x-example":["Failed to send message to target 5e5ea5c16897e: Credentials not valid."],"x-nullable":true},"deliveredTotal":{"type":"integer","description":"Number of recipients the message was delivered to.","x-example":1,"format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Data of the message.","x-example":{"subject":"Welcome to Appwrite","content":"Hi there, welcome to Appwrite family."}},"status":{"type":"string","description":"Status of delivery.","x-example":"Message status can be one of the following: draft, processing, scheduled, sent, or failed."}},"required":["$id","$createdAt","$updatedAt","providerType","topics","users","targets","deliveredTotal","data","status"]},"topic":{"description":"Topic","type":"object","properties":{"$id":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Topic creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Topic update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name of the topic.","x-example":"events"},"emailTotal":{"type":"integer","description":"Total count of email subscribers subscribed to the topic.","x-example":100,"format":"int32"},"smsTotal":{"type":"integer","description":"Total count of SMS subscribers subscribed to the topic.","x-example":100,"format":"int32"},"pushTotal":{"type":"integer","description":"Total count of push subscribers subscribed to the topic.","x-example":100,"format":"int32"},"subscribe":{"type":"array","description":"Subscribe permissions.","items":{"type":"string"},"x-example":"users"}},"required":["$id","$createdAt","$updatedAt","name","emailTotal","smsTotal","pushTotal","subscribe"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"type":"object","$ref":"#\/definitions\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","x-nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]},"migration":{"description":"Migration","type":"object","properties":{"$id":{"type":"string","description":"Migration ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"string","description":"Migration status ( pending, processing, failed, completed ) ","x-example":"pending"},"stage":{"type":"string","description":"Migration stage ( init, processing, source-check, destination-check, migrating, finished )","x-example":"init"},"source":{"type":"string","description":"A string containing the type of source of the migration.","x-example":"Appwrite"},"resources":{"type":"array","description":"Resources to migration.","items":{"type":"string"},"x-example":["user"]},"statusCounters":{"type":"object","additionalProperties":true,"description":"A group of counters that represent the total progress of the migration.","x-example":"{\"Database\": {\"PENDING\": 0, \"SUCCESS\": 1, \"ERROR\": 0, \"SKIP\": 0, \"PROCESSING\": 0, \"WARNING\": 0}}"},"resourceData":{"type":"object","additionalProperties":true,"description":"An array of objects containing the report data of the resources that were migrated.","x-example":"[{\"resource\":\"Database\",\"id\":\"public\",\"status\":\"SUCCESS\",\"message\":\"\"}]"},"errors":{"type":"array","description":"All errors that occurred during the migration process.","items":{"type":"string"},"x-example":[]}},"required":["$id","$createdAt","$updatedAt","status","stage","source","resources","statusCounters","resourceData","errors"]},"migrationReport":{"description":"Migration Report","type":"object","properties":{"user":{"type":"integer","description":"Number of users to be migrated.","x-example":20,"format":"int32"},"team":{"type":"integer","description":"Number of teams to be migrated.","x-example":20,"format":"int32"},"database":{"type":"integer","description":"Number of databases to be migrated.","x-example":20,"format":"int32"},"document":{"type":"integer","description":"Number of documents to be migrated.","x-example":20,"format":"int32"},"file":{"type":"integer","description":"Number of files to be migrated.","x-example":20,"format":"int32"},"bucket":{"type":"integer","description":"Number of buckets to be migrated.","x-example":20,"format":"int32"},"function":{"type":"integer","description":"Number of functions to be migrated.","x-example":20,"format":"int32"},"size":{"type":"integer","description":"Size of files to be migrated in mb.","x-example":30000,"format":"int32"},"version":{"type":"string","description":"Version of the Appwrite instance to be migrated.","x-example":"1.4.0"}},"required":["user","team","database","document","file","bucket","function","size","version"]},"firebaseProject":{"description":"MigrationFirebaseProject","type":"object","properties":{"projectId":{"type":"string","description":"Project ID.","x-example":"my-project"},"displayName":{"type":"string","description":"Project display name.","x-example":"My Project"}},"required":["projectId","displayName"]}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file diff --git a/app/config/specs/swagger2-1.6.x-server.json b/app/config/specs/swagger2-1.6.x-server.json new file mode 100644 index 0000000000..0faea4151e --- /dev/null +++ b/app/config/specs/swagger2-1.6.x-server.json @@ -0,0 +1 @@ +{"swagger":"2.0","info":{"version":"1.5.7","title":"Appwrite","description":"Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)","termsOfService":"https:\/\/appwrite.io\/policy\/terms","contact":{"name":"Appwrite Team","url":"https:\/\/appwrite.io\/support","email":"team@appwrite.io"},"license":{"name":"BSD-3-Clause","url":"https:\/\/raw.githubusercontent.com\/appwrite\/appwrite\/master\/LICENSE"}},"host":"cloud.appwrite.io","basePath":"\/v1","schemes":["https"],"consumes":["application\/json","multipart\/form-data"],"produces":["application\/json"],"securityDefinitions":{"Project":{"type":"apiKey","name":"X-Appwrite-Project","description":"Your project ID","in":"header","x-appwrite":{"demo":"<YOUR_PROJECT_ID>"}},"Key":{"type":"apiKey","name":"X-Appwrite-Key","description":"Your secret API key","in":"header","x-appwrite":{"demo":"<YOUR_API_KEY>"}},"JWT":{"type":"apiKey","name":"X-Appwrite-JWT","description":"Your secret JSON Web Token","in":"header","x-appwrite":{"demo":"<YOUR_JWT>"}},"Locale":{"type":"apiKey","name":"X-Appwrite-Locale","description":"","in":"header","x-appwrite":{"demo":"en"}},"Session":{"type":"apiKey","name":"X-Appwrite-Session","description":"The user session to authenticate with","in":"header"},"ForwardedUserAgent":{"type":"apiKey","name":"X-Forwarded-User-Agent","description":"The user agent string of the client that made the request","in":"header"}},"paths":{"\/account":{"get":{"summary":"Get account","operationId":"accountGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the currently logged in user.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":8,"cookies":false,"type":"","deprecated":false,"demo":"account\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create account","operationId":"accountCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":7,"cookies":false,"type":"","deprecated":false,"demo":"account\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/account\/email":{"patch":{"summary":"Update email","operationId":"accountUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":33,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/identities":{"get":{"summary":"List Identities","operationId":"accountListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of identities for the currently logged in user.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":56,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/identities","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"accountDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":57,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/account\/jwts":{"post":{"summary":"Create JWT","operationId":"accountCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":28,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/logs":{"get":{"summary":"List logs","operationId":"accountListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":30,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/mfa":{"patch":{"summary":"Update MFA","operationId":"accountUpdateMFA","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Enable or disable MFA on an account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMFA","weight":43,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-m-f-a.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/account\/mfa\/authenticators\/{type}":{"post":{"summary":"Add Authenticator","operationId":"accountCreateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.","responses":{"200":{"description":"MFAType","schema":{"$ref":"#\/definitions\/mfaType"}}},"x-appwrite":{"method":"createMfaAuthenticator","weight":45,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator. Must be `totp`","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]},"put":{"summary":"Verify Authenticator","operationId":"accountUpdateMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfaAuthenticator","weight":46,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["otp"]}}]},"delete":{"summary":"Delete Authenticator","operationId":"accountDeleteMfaAuthenticator","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete an authenticator for a user by ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":50,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/account\/mfa\/challenge":{"post":{"summary":"Create 2FA Challenge","operationId":"accountCreateMfaChallenge","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.","responses":{"201":{"description":"MFA Challenge","schema":{"$ref":"#\/definitions\/mfaChallenge"}}},"x-appwrite":{"method":"createMfaChallenge","weight":51,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},token:{param-token}","scope":"account","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"factor":{"type":"string","description":"Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.","default":null,"x-example":"email","enum":["email","phone","totp","recoverycode"],"x-enum-name":"AuthenticationFactor","x-enum-keys":[]}},"required":["factor"]}}]},"put":{"summary":"Create MFA Challenge (confirmation)","operationId":"accountUpdateMfaChallenge","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"updateMfaChallenge","weight":52,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-challenge.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"challengeId":{"type":"string","description":"ID of the challenge.","default":null,"x-example":"<CHALLENGE_ID>"},"otp":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<OTP>"}},"required":["challengeId","otp"]}}]}},"\/account\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"accountListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":44,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"accountGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":49,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"post":{"summary":"Create MFA Recovery Codes","operationId":"accountCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":47,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Regenerate MFA Recovery Codes","operationId":"accountUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":48,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/name":{"patch":{"summary":"Update name","operationId":"accountUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Update currently logged in user account name.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":31,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/account\/password":{"patch":{"summary":"Update password","operationId":"accountUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":32,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null},"oldPassword":{"type":"string","description":"Current user password. Must be at least 8 chars.","default":"","x-example":"password"}},"required":["password"]}}]}},"\/account\/phone":{"patch":{"summary":"Update phone","operationId":"accountUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":34,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["phone","password"]}}]}},"\/account\/prefs":{"get":{"summary":"Get account preferences","operationId":"accountGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the preferences as a key-value object for the currently logged in user.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":29,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"patch":{"summary":"Update preferences","operationId":"accountUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePrefs","weight":35,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/prefs","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/account\/recovery":{"post":{"summary":"Create password recovery","operationId":"accountCreateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createRecovery","weight":37,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["email","url"]}}]},"put":{"summary":"Create password recovery (confirmation)","operationId":"accountUpdateRecovery","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease 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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateRecovery","weight":38,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-recovery.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"sessions.write","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid reset token.","default":null,"x-example":"<SECRET>"},"password":{"type":"string","description":"New user password. Must be between 8 and 256 chars.","default":null,"x-example":null}},"required":["userId","secret","password"]}}]}},"\/account\/sessions":{"get":{"summary":"List sessions","operationId":"accountListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Get the list of active sessions across different devices for the currently logged in user.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":10,"cookies":false,"type":"","deprecated":false,"demo":"account\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"delete":{"summary":"Delete sessions","operationId":"accountDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"Delete all sessions from the user account and remove any sessions cookies from the end client.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":11,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/sessions\/anonymous":{"post":{"summary":"Create anonymous session","operationId":"accountCreateAnonymousSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createAnonymousSession","weight":16,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-anonymous-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}]}},"\/account\/sessions\/email":{"post":{"summary":"Create email password session","operationId":"accountCreateEmailPasswordSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createEmailPasswordSession","weight":15,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-password-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password. Must be at least 8 chars.","default":null,"x-example":"password"}},"required":["email","password"]}}]}},"\/account\/sessions\/magic-url":{"put":{"summary":"Update magic URL session","operationId":"accountUpdateMagicURLSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateMagicURLSession","weight":25,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-magic-u-r-l-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/phone":{"put":{"summary":"Update phone session","operationId":"accountUpdatePhoneSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updatePhoneSession","weight":26,"cookies":false,"type":"","deprecated":true,"demo":"account\/update-phone-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/token":{"post":{"summary":"Create session","operationId":"accountCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":17,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md","rate-limit":10,"rate-time":3600,"rate-key":"ip:{ip},userId:{param-userId}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/sessions\/{sessionId}":{"get":{"summary":"Get session","operationId":"accountGetSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"getSession","weight":12,"cookies":false,"type":"","deprecated":false,"demo":"account\/get-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"\/account\/sessions","offline-key":"{sessionId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to get the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"patch":{"summary":"Update session","operationId":"accountUpdateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.","responses":{"200":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"updateSession","weight":14,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to update the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]},"delete":{"summary":"Delete session","operationId":"accountDeleteSession","consumes":["application\/json"],"produces":[],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":13,"cookies":false,"type":"","deprecated":false,"demo":"account\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md","rate-limit":100,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"sessionId","description":"Session ID. Use the string 'current' to delete the current device session.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/account\/status":{"patch":{"summary":"Update status","operationId":"accountUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":36,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]}},"\/account\/tokens\/email":{"post":{"summary":"Create email token (OTP)","operationId":"accountCreateEmailToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createEmailToken","weight":24,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-email-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},email:{param-email}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/magic-url":{"post":{"summary":"Create magic URL token","operationId":"accountCreateMagicURLToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createMagicURLToken","weight":23,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-magic-u-r-l-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md","rate-limit":60,"rate-time":3600,"rate-key":["url:{url},email:{param-email}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"url":{"type":"string","description":"URL to redirect the user back to your app from the magic URL login. 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.","default":"","x-example":"https:\/\/example.com"},"phrase":{"type":"boolean","description":"Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.","default":false,"x-example":false}},"required":["userId","email"]}}]}},"\/account\/tokens\/oauth2\/{provider}":{"get":{"summary":"Create OAuth2 token","operationId":"accountCreateOAuth2Token","consumes":["application\/json"],"produces":["text\/html"],"tags":["account"],"description":"Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"301":{"description":"No content"}},"x-appwrite":{"method":"createOAuth2Token","weight":22,"cookies":false,"type":"webAuth","deprecated":false,"demo":"account\/create-o-auth2token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md","rate-limit":50,"rate-time":3600,"rate-key":"ip:{ip}","scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"provider","description":"OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.","required":true,"type":"string","x-example":"amazon","enum":["amazon","apple","auth0","authentik","autodesk","bitbucket","bitly","box","dailymotion","discord","disqus","dropbox","etsy","facebook","github","gitlab","google","linkedin","microsoft","notion","oidc","okta","paypal","paypalSandbox","podio","salesforce","slack","spotify","stripe","tradeshift","tradeshiftBox","twitch","wordpress","yahoo","yammer","yandex","zoho","zoom","mock"],"x-enum-name":"OAuthProvider","x-enum-keys":[],"in":"path"},{"name":"success","description":"URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"failure","description":"URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's 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.","required":false,"type":"string","format":"url","x-example":"https:\/\/example.com","default":"","in":"query"},{"name":"scopes","description":"A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/account\/tokens\/phone":{"post":{"summary":"Create phone token","operationId":"accountCreatePhoneToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneToken","weight":27,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},phone:{param-phone}","url:{url},ip:{ip}"],"scope":"sessions.write","platforms":["server","client"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[]}},"security":[{"Project":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"}},"required":["userId","phone"]}}]}},"\/account\/verification":{"post":{"summary":"Create email verification","operationId":"accountCreateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease 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.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createVerification","weight":39,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{userId}","scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"url":{"type":"string","description":"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.","default":null,"x-example":"https:\/\/example.com"}},"required":["url"]}}]},"put":{"summary":"Create email verification (confirmation)","operationId":"accountUpdateVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updateVerification","weight":40,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/account\/verification\/phone":{"post":{"summary":"Create phone verification","operationId":"accountCreatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createPhoneVerification","weight":41,"cookies":false,"type":"","deprecated":false,"demo":"account\/create-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":["url:{url},userId:{userId}","url:{url},ip:{ip}"],"scope":"account","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}]},"put":{"summary":"Create phone verification (confirmation)","operationId":"accountUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["account"],"description":"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.","responses":{"200":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":42,"cookies":false,"type":"","deprecated":false,"demo":"account\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md","rate-limit":10,"rate-time":3600,"rate-key":"userId:{param-userId}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Valid verification token.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/avatars\/browsers\/{code}":{"get":{"summary":"Get browser icon","operationId":"avatarsGetBrowser","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getBrowser","weight":59,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-browser.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Browser Code.","required":true,"type":"string","x-example":"aa","enum":["aa","an","ch","ci","cm","cr","ff","sf","mf","ps","oi","om","op","on"],"x-enum-name":"Browser","x-enum-keys":["Avant Browser","Android WebView Beta","Google Chrome","Google Chrome (iOS)","Google Chrome (Mobile)","Chromium","Mozilla Firefox","Safari","Mobile Safari","Microsoft Edge","Microsoft Edge (iOS)","Opera Mini","Opera","Opera (Next)"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/credit-cards\/{code}":{"get":{"summary":"Get credit card icon","operationId":"avatarsGetCreditCard","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getCreditCard","weight":58,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-credit-card.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro.","required":true,"type":"string","x-example":"amex","enum":["amex","argencard","cabal","cencosud","diners","discover","elo","hipercard","jcb","mastercard","naranja","targeta-shopping","union-china-pay","visa","mir","maestro"],"x-enum-name":"CreditCard","x-enum-keys":["American Express","Argencard","Cabal","Cencosud","Diners Club","Discover","Elo","Hipercard","JCB","Mastercard","Naranja","Tarjeta Shopping","Union China Pay","Visa","MIR","Maestro"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/favicon":{"get":{"summary":"Get favicon","operationId":"avatarsGetFavicon","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFavicon","weight":62,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-favicon.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Website URL which you want to fetch the favicon from.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"}]}},"\/avatars\/flags\/{code}":{"get":{"summary":"Get country flag","operationId":"avatarsGetFlag","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFlag","weight":60,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-flag.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"code","description":"Country Code. ISO Alpha-2 country code format.","required":true,"type":"string","x-example":"af","enum":["af","ao","al","ad","ae","ar","am","ag","au","at","az","bi","be","bj","bf","bd","bg","bh","bs","ba","by","bz","bo","br","bb","bn","bt","bw","cf","ca","ch","cl","cn","ci","cm","cd","cg","co","km","cv","cr","cu","cy","cz","de","dj","dm","dk","do","dz","ec","eg","er","es","ee","et","fi","fj","fr","fm","ga","gb","ge","gh","gn","gm","gw","gq","gr","gd","gt","gy","hn","hr","ht","hu","id","in","ie","ir","iq","is","il","it","jm","jo","jp","kz","ke","kg","kh","ki","kn","kr","kw","la","lb","lr","ly","lc","li","lk","ls","lt","lu","lv","ma","mc","md","mg","mv","mx","mh","mk","ml","mt","mm","me","mn","mz","mr","mu","mw","my","na","ne","ng","ni","nl","no","np","nr","nz","om","pk","pa","pe","ph","pw","pg","pl","pf","kp","pt","py","qa","ro","ru","rw","sa","sd","sn","sg","sb","sl","sv","sm","so","rs","ss","st","sr","sk","si","se","sz","sc","sy","td","tg","th","tj","tm","tl","to","tt","tn","tr","tv","tz","ug","ua","uy","us","uz","va","vc","ve","vn","vu","ws","ye","za","zm","zw"],"x-enum-name":"Flag","x-enum-keys":["Afghanistan","Angola","Albania","Andorra","United Arab Emirates","Argentina","Armenia","Antigua and Barbuda","Australia","Austria","Azerbaijan","Burundi","Belgium","Benin","Burkina Faso","Bangladesh","Bulgaria","Bahrain","Bahamas","Bosnia and Herzegovina","Belarus","Belize","Bolivia","Brazil","Barbados","Brunei Darussalam","Bhutan","Botswana","Central African Republic","Canada","Switzerland","Chile","China","C\u00f4te d'Ivoire","Cameroon","Democratic Republic of the Congo","Republic of the Congo","Colombia","Comoros","Cape Verde","Costa Rica","Cuba","Cyprus","Czech Republic","Germany","Djibouti","Dominica","Denmark","Dominican Republic","Algeria","Ecuador","Egypt","Eritrea","Spain","Estonia","Ethiopia","Finland","Fiji","France","Micronesia (Federated States of)","Gabon","United Kingdom","Georgia","Ghana","Guinea","Gambia","Guinea-Bissau","Equatorial Guinea","Greece","Grenada","Guatemala","Guyana","Honduras","Croatia","Haiti","Hungary","Indonesia","India","Ireland","Iran (Islamic Republic of)","Iraq","Iceland","Israel","Italy","Jamaica","Jordan","Japan","Kazakhstan","Kenya","Kyrgyzstan","Cambodia","Kiribati","Saint Kitts and Nevis","South Korea","Kuwait","Lao People's Democratic Republic","Lebanon","Liberia","Libya","Saint Lucia","Liechtenstein","Sri Lanka","Lesotho","Lithuania","Luxembourg","Latvia","Morocco","Monaco","Moldova","Madagascar","Maldives","Mexico","Marshall Islands","North Macedonia","Mali","Malta","Myanmar","Montenegro","Mongolia","Mozambique","Mauritania","Mauritius","Malawi","Malaysia","Namibia","Niger","Nigeria","Nicaragua","Netherlands","Norway","Nepal","Nauru","New Zealand","Oman","Pakistan","Panama","Peru","Philippines","Palau","Papua New Guinea","Poland","French Polynesia","North Korea","Portugal","Paraguay","Qatar","Romania","Russia","Rwanda","Saudi Arabia","Sudan","Senegal","Singapore","Solomon Islands","Sierra Leone","El Salvador","San Marino","Somalia","Serbia","South Sudan","Sao Tome and Principe","Suriname","Slovakia","Slovenia","Sweden","Eswatini","Seychelles","Syria","Chad","Togo","Thailand","Tajikistan","Turkmenistan","Timor-Leste","Tonga","Trinidad and Tobago","Tunisia","Turkey","Tuvalu","Tanzania","Uganda","Ukraine","Uruguay","United States","Uzbekistan","Vatican City","Saint Vincent and the Grenadines","Venezuela","Vietnam","Vanuatu","Samoa","Yemen","South Africa","Zambia","Zimbabwe"],"in":"path"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"quality","description":"Image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"}]}},"\/avatars\/image":{"get":{"summary":"Get image from URL","operationId":"avatarsGetImage","consumes":["application\/json"],"produces":["image\/*"],"tags":["avatars"],"description":"Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getImage","weight":61,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-image.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"url","description":"Image URL which you want to crop.","required":true,"type":"string","format":"url","x-example":"https:\/\/example.com","in":"query"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":0,"default":400,"in":"query"}]}},"\/avatars\/initials":{"get":{"summary":"Get user initials","operationId":"avatarsGetInitials","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getInitials","weight":64,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-initials.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"name","description":"Full Name. When empty, current user name or email will be used. Max length: 128 chars.","required":false,"type":"string","x-example":"<NAME>","default":"","in":"query"},{"name":"width","description":"Image width. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"height","description":"Image height. Pass an integer between 0 to 2000. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":500,"in":"query"},{"name":"background","description":"Changes background color. By default a random color will be picked and stay will persistent to the given name.","required":false,"type":"string","default":"","in":"query"}]}},"\/avatars\/qr":{"get":{"summary":"Get QR code","operationId":"avatarsGetQR","consumes":["application\/json"],"produces":["image\/png"],"tags":["avatars"],"description":"Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getQR","weight":63,"cookies":false,"type":"location","deprecated":false,"demo":"avatars\/get-q-r.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"avatars.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"text","description":"Plain text to be converted to QR code image.","required":true,"type":"string","x-example":"<TEXT>","in":"query"},{"name":"size","description":"QR code size. Pass an integer between 1 to 1000. Defaults to 400.","required":false,"type":"integer","format":"int32","x-example":1,"default":400,"in":"query"},{"name":"margin","description":"Margin from edge. Pass an integer between 0 to 10. Defaults to 1.","required":false,"type":"integer","format":"int32","x-example":0,"default":1,"in":"query"},{"name":"download","description":"Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.","required":false,"type":"boolean","x-example":false,"default":false,"in":"query"}]}},"\/databases":{"get":{"summary":"List databases","operationId":"databasesList","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.","responses":{"200":{"description":"Databases List","schema":{"$ref":"#\/definitions\/databaseList"}}},"x-appwrite":{"method":"list","weight":69,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create database","operationId":"databasesCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Database.\n","responses":{"201":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"create","weight":68,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"databaseId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DATABASE_ID>"},"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["databaseId","name"]}}]}},"\/databases\/{databaseId}":{"get":{"summary":"Get database","operationId":"databasesGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"get","weight":70,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]},"put":{"summary":"Update database","operationId":"databasesUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a database by its unique ID.","responses":{"200":{"description":"Database","schema":{"$ref":"#\/definitions\/database"}}},"x-appwrite":{"method":"update","weight":72,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Database name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete database","operationId":"databasesDelete","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":73,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"databases.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections":{"get":{"summary":"List collections","operationId":"databasesListCollections","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.","responses":{"200":{"description":"Collections List","schema":{"$ref":"#\/definitions\/collectionList"}}},"x-appwrite":{"method":"listCollections","weight":75,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-collections.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"queries","description":"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: name, enabled, documentSecurity","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create collection","operationId":"databasesCreateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"createCollection","weight":74,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"collectionId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<COLLECTION_ID>"},"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["collectionId","name"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}":{"get":{"summary":"Get collection","operationId":"databasesGetCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"getCollection","weight":76,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]},"put":{"summary":"Update collection","operationId":"databasesUpdateCollection","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a collection by its unique ID.","responses":{"200":{"description":"Collection","schema":{"$ref":"#\/definitions\/collection"}}},"x-appwrite":{"method":"updateCollection","weight":78,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Collection name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"documentSecurity":{"type":"boolean","description":"Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete collection","operationId":"databasesDeleteCollection","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteCollection","weight":79,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-collection.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes":{"get":{"summary":"List attributes","operationId":"databasesListAttributes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List attributes in the collection.","responses":{"200":{"description":"Attributes List","schema":{"$ref":"#\/definitions\/attributeList"}}},"x-appwrite":{"method":"listAttributes","weight":90,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-attributes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, size, required, array, status, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean":{"post":{"summary":"Create boolean attribute","operationId":"databasesCreateBooleanAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a boolean attribute.\n","responses":{"202":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"createBooleanAttribute","weight":87,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}":{"patch":{"summary":"Update boolean attribute","operationId":"databasesUpdateBooleanAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a boolean attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeBoolean","schema":{"$ref":"#\/definitions\/attributeBoolean"}}},"x-appwrite":{"method":"updateBooleanAttribute","weight":99,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-boolean-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":false,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime":{"post":{"summary":"Create datetime attribute","operationId":"databasesCreateDatetimeAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a date time attribute according to the ISO 8601 standard.","responses":{"202":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"createDatetimeAttribute","weight":88,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}":{"patch":{"summary":"Update dateTime attribute","operationId":"databasesUpdateDatetimeAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a date time attribute. Changing the `default` value will not update already existing documents.","responses":{"200":{"description":"AttributeDatetime","schema":{"$ref":"#\/definitions\/attributeDatetime"}}},"x-appwrite":{"method":"updateDatetimeAttribute","weight":100,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-datetime-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email":{"post":{"summary":"Create email attribute","operationId":"databasesCreateEmailAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an email attribute.\n","responses":{"202":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"createEmailAttribute","weight":81,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}":{"patch":{"summary":"Update email attribute","operationId":"databasesUpdateEmailAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an email attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEmail","schema":{"$ref":"#\/definitions\/attributeEmail"}}},"x-appwrite":{"method":"updateEmailAttribute","weight":93,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-email-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"email@example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum":{"post":{"summary":"Create enum attribute","operationId":"databasesCreateEnumAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n","responses":{"202":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"createEnumAttribute","weight":82,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","elements","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}":{"patch":{"summary":"Update enum attribute","operationId":"databasesUpdateEnumAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an enum attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeEnum","schema":{"$ref":"#\/definitions\/attributeEnum"}}},"x-appwrite":{"method":"updateEnumAttribute","weight":94,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-enum-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"elements":{"type":"array","description":"Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["elements","required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float":{"post":{"summary":"Create float attribute","operationId":"databasesCreateFloatAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a float attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"createFloatAttribute","weight":86,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float\/{key}":{"patch":{"summary":"Update float attribute","operationId":"databasesUpdateFloatAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a float attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeFloat","schema":{"$ref":"#\/definitions\/attributeFloat"}}},"x-appwrite":{"method":"updateFloatAttribute","weight":98,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-float-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"number","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"number","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer":{"post":{"summary":"Create integer attribute","operationId":"databasesCreateIntegerAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create an integer attribute. Optionally, minimum and maximum values can be provided.\n","responses":{"202":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"createIntegerAttribute","weight":85,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer\/{key}":{"patch":{"summary":"Update integer attribute","operationId":"databasesUpdateIntegerAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an integer attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeInteger","schema":{"$ref":"#\/definitions\/attributeInteger"}}},"x-appwrite":{"method":"updateIntegerAttribute","weight":97,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-integer-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"min":{"type":"integer","description":"Minimum value to enforce on new documents","default":null,"x-example":null},"max":{"type":"integer","description":"Maximum value to enforce on new documents","default":null,"x-example":null},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","min","max","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip":{"post":{"summary":"Create IP address attribute","operationId":"databasesCreateIpAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create IP address attribute.\n","responses":{"202":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"createIpAttribute","weight":83,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}":{"patch":{"summary":"Update IP address attribute","operationId":"databasesUpdateIpAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an ip attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeIP","schema":{"$ref":"#\/definitions\/attributeIp"}}},"x-appwrite":{"method":"updateIpAttribute","weight":95,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-ip-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":null,"x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship":{"post":{"summary":"Create relationship attribute","operationId":"databasesCreateRelationshipAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"202":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"createRelationshipAttribute","weight":89,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"relatedCollectionId":{"type":"string","description":"Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","default":null,"x-example":"<RELATED_COLLECTION_ID>"},"type":{"type":"string","description":"Relation type","default":null,"x-example":"oneToOne","enum":["oneToOne","manyToOne","manyToMany","oneToMany"],"x-enum-name":"RelationshipType","x-enum-keys":[]},"twoWay":{"type":"boolean","description":"Is Two Way?","default":false,"x-example":false},"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"twoWayKey":{"type":"string","description":"Two Way Attribute Key.","default":null,"x-example":null},"onDelete":{"type":"string","description":"Constraints option","default":"restrict","x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}},"required":["relatedCollectionId","type"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string":{"post":{"summary":"Create string attribute","operationId":"databasesCreateStringAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a string attribute.\n","responses":{"202":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"createStringAttribute","weight":80,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"size":{"type":"integer","description":"Attribute size for text attributes, in number of characters.","default":null,"x-example":1},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false},"encrypt":{"type":"boolean","description":"Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.","default":false,"x-example":false}},"required":["key","size","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}":{"patch":{"summary":"Update string attribute","operationId":"databasesUpdateStringAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update a string attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeString","schema":{"$ref":"#\/definitions\/attributeString"}}},"x-appwrite":{"method":"updateStringAttribute","weight":92,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-string-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"<DEFAULT>","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url":{"post":{"summary":"Create URL attribute","operationId":"databasesCreateUrlAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a URL attribute.\n","responses":{"202":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"createUrlAttribute","weight":84,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","default":null,"x-example":null},"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com"},"array":{"type":"boolean","description":"Is attribute an array?","default":false,"x-example":false}},"required":["key","required"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}":{"patch":{"summary":"Update URL attribute","operationId":"databasesUpdateUrlAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update an url attribute. Changing the `default` value will not update already existing documents.\n","responses":{"200":{"description":"AttributeURL","schema":{"$ref":"#\/definitions\/attributeUrl"}}},"x-appwrite":{"method":"updateUrlAttribute","weight":96,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-url-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"required":{"type":"boolean","description":"Is attribute required?","default":null,"x-example":false},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","default":null,"x-example":"https:\/\/example.com","x-nullable":true}},"required":["required","default"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}":{"get":{"summary":"Get attribute","operationId":"databasesGetAttribute","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get attribute by ID.","responses":{"200":{"description":"AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString","schema":{"x-oneOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]}}},"x-appwrite":{"method":"getAttribute","weight":91,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete attribute","operationId":"databasesDeleteAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Deletes an attribute.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteAttribute","weight":102,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship":{"patch":{"summary":"Update relationship attribute","operationId":"databasesUpdateRelationshipAttribute","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n","responses":{"200":{"description":"AttributeRelationship","schema":{"$ref":"#\/definitions\/attributeRelationship"}}},"x-appwrite":{"method":"updateRelationshipAttribute","weight":101,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-relationship-attribute.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Attribute Key.","required":true,"type":"string","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"onDelete":{"type":"string","description":"Constraints option","default":null,"x-example":"cascade","enum":["cascade","restrict","setNull"],"x-enum-name":"RelationMutate","x-enum-keys":[]}}}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents":{"get":{"summary":"List documents","operationId":"databasesListDocuments","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a list of all the user's documents in a given collection. You can use the query params to filter your results.","responses":{"200":{"description":"Documents List","schema":{"$ref":"#\/definitions\/documentList"}}},"x-appwrite":{"method":"listDocuments","weight":108,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-documents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create document","operationId":"databasesCreateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.","responses":{"201":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"createDocument","weight":107,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"documentId":{"type":"string","description":"Document ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<DOCUMENT_ID>"},"data":{"type":"object","description":"Document data as JSON object.","default":{},"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}},"required":["documentId","data"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}":{"get":{"summary":"Get document","operationId":"databasesGetDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get a document by its unique ID. This endpoint response returns a JSON object with the document data.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"getDocument","weight":109,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"documents.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"queries","description":"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.","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"patch":{"summary":"Update document","operationId":"databasesUpdateDocument","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.","responses":{"200":{"description":"Document","schema":{"$ref":"#\/definitions\/document"}}},"x-appwrite":{"method":"updateDocument","weight":111,"cookies":false,"type":"","deprecated":false,"demo":"databases\/update-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md","rate-limit":120,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID.","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"data":{"type":"object","description":"Document data as JSON object. Include only attribute and value pairs to be updated.","default":[],"x-example":"{}"},"permissions":{"type":"array","description":"An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete document","operationId":"databasesDeleteDocument","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete a document by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDocument","weight":112,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-document.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"documents.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/databases\/{databaseId}\/collections\/{collectionId}\/documents","offline-key":"{documentId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"documentId","description":"Document ID.","required":true,"type":"string","x-example":"<DOCUMENT_ID>","in":"path"}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes":{"get":{"summary":"List indexes","operationId":"databasesListIndexes","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"List indexes in the collection.","responses":{"200":{"description":"Indexes List","schema":{"$ref":"#\/definitions\/indexList"}}},"x-appwrite":{"method":"listIndexes","weight":104,"cookies":false,"type":"","deprecated":false,"demo":"databases\/list-indexes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"queries","description":"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: key, type, status, attributes, error","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create index","operationId":"databasesCreateIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.","responses":{"202":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"createIndex","weight":103,"cookies":false,"type":"","deprecated":false,"demo":"databases\/create-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Index Key.","default":null,"x-example":null},"type":{"type":"string","description":"Index type.","default":null,"x-example":"key","enum":["key","fulltext","unique"],"x-enum-name":"IndexType","x-enum-keys":[]},"attributes":{"type":"array","description":"Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"orders":{"type":"array","description":"Array of index orders. Maximum of 100 orders are allowed.","default":[],"x-example":null,"items":{"type":"string"}}},"required":["key","type","attributes"]}}]}},"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}":{"get":{"summary":"Get index","operationId":"databasesGetIndex","consumes":["application\/json"],"produces":["application\/json"],"tags":["databases"],"description":"Get index by ID.","responses":{"200":{"description":"Index","schema":{"$ref":"#\/definitions\/index"}}},"x-appwrite":{"method":"getIndex","weight":105,"cookies":false,"type":"","deprecated":false,"demo":"databases\/get-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]},"delete":{"summary":"Delete index","operationId":"databasesDeleteIndex","consumes":["application\/json"],"produces":[],"tags":["databases"],"description":"Delete an index.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIndex","weight":106,"cookies":false,"type":"","deprecated":false,"demo":"databases\/delete-index.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"collections.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"databaseId","description":"Database ID.","required":true,"type":"string","x-example":"<DATABASE_ID>","in":"path"},{"name":"collectionId","description":"Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).","required":true,"type":"string","x-example":"<COLLECTION_ID>","in":"path"},{"name":"key","description":"Index Key.","required":true,"type":"string","in":"path"}]}},"\/functions":{"get":{"summary":"List functions","operationId":"functionsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's functions. You can use the query params to filter your results.","responses":{"200":{"description":"Functions List","schema":{"$ref":"#\/definitions\/functionList"}}},"x-appwrite":{"method":"list","weight":287,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create function","operationId":"functionsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.","responses":{"201":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"create","weight":286,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"functionId":{"type":"string","description":"Function ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<FUNCTION_ID>"},"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":null,"x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Function maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Control System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function.","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function.","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"},"templateRepository":{"type":"string","description":"Repository name of the template.","default":"","x-example":"<TEMPLATE_REPOSITORY>"},"templateOwner":{"type":"string","description":"The name of the owner of the template.","default":"","x-example":"<TEMPLATE_OWNER>"},"templateRootDirectory":{"type":"string","description":"Path to function code in the template repo.","default":"","x-example":"<TEMPLATE_ROOT_DIRECTORY>"},"templateBranch":{"type":"string","description":"Production branch for the repo linked to the function template.","default":"","x-example":"<TEMPLATE_BRANCH>"}},"required":["functionId","name","runtime"]}}]}},"\/functions\/runtimes":{"get":{"summary":"List runtimes","operationId":"functionsListRuntimes","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all runtimes that are currently active on your instance.","responses":{"200":{"description":"Runtimes List","schema":{"$ref":"#\/definitions\/runtimeList"}}},"x-appwrite":{"method":"listRuntimes","weight":288,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-runtimes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-runtimes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/functions\/{functionId}":{"get":{"summary":"Get function","operationId":"functionsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"get","weight":289,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"put":{"summary":"Update function","operationId":"functionsUpdate","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update function by its unique ID.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"update","weight":292,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Function name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"runtime":{"type":"string","description":"Execution runtime.","default":"","x-example":"node-14.5","enum":["node-14.5","node-16.0","node-18.0","node-19.0","node-20.0","node-21.0","php-8.0","php-8.1","php-8.2","php-8.3","ruby-3.0","ruby-3.1","ruby-3.2","ruby-3.3","python-3.8","python-3.9","python-3.10","python-3.11","python-3.12","python-ml-3.11","deno-1.40","dart-2.15","dart-2.16","dart-2.17","dart-2.18","dart-3.0","dart-3.1","dart-3.3","dotnet-3.1","dotnet-6.0","dotnet-7.0","java-8.0","java-11.0","java-17.0","java-18.0","java-21.0","swift-5.5","swift-5.8","swift-5.9","kotlin-1.6","kotlin-1.8","kotlin-1.9","cpp-17","cpp-20","bun-1.0","go-1.22"],"x-enum-name":null,"x-enum-keys":[]},"execute":{"type":"array","description":"An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":[],"x-example":"[\"any\"]","items":{"type":"string"}},"events":{"type":"array","description":"Events list. Maximum of 100 events are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"schedule":{"type":"string","description":"Schedule CRON syntax.","default":"","x-example":null},"timeout":{"type":"integer","description":"Maximum execution time in seconds.","default":15,"x-example":1},"enabled":{"type":"boolean","description":"Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.","default":true,"x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","default":true,"x-example":false},"entrypoint":{"type":"string","description":"Entrypoint File. This path is relative to the \"providerRootDirectory\".","default":"","x-example":"<ENTRYPOINT>"},"commands":{"type":"string","description":"Build Commands.","default":"","x-example":"<COMMANDS>"},"scopes":{"type":"array","description":"List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.","default":[],"x-example":null,"items":{"type":"string"}},"installationId":{"type":"string","description":"Appwrite Installation ID for VCS (Version Controle System) deployment.","default":"","x-example":"<INSTALLATION_ID>"},"providerRepositoryId":{"type":"string","description":"Repository ID of the repo linked to the function","default":"","x-example":"<PROVIDER_REPOSITORY_ID>"},"providerBranch":{"type":"string","description":"Production branch for the repo linked to the function","default":"","x-example":"<PROVIDER_BRANCH>"},"providerSilentMode":{"type":"boolean","description":"Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.","default":false,"x-example":false},"providerRootDirectory":{"type":"string","description":"Path to function code in the linked repo.","default":"","x-example":"<PROVIDER_ROOT_DIRECTORY>"}},"required":["name"]}}]},"delete":{"summary":"Delete function","operationId":"functionsDelete","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":295,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-function.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments":{"get":{"summary":"List deployments","operationId":"functionsListDeployments","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the project's code deployments. You can use the query params to filter your results.","responses":{"200":{"description":"Deployments List","schema":{"$ref":"#\/definitions\/deploymentList"}}},"x-appwrite":{"method":"listDeployments","weight":297,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-deployments.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-deployments.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: size, buildId, activate, entrypoint, commands","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create deployment","operationId":"functionsCreateDeployment","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.","responses":{"202":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"createDeployment","weight":296,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":true,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"entrypoint","description":"Entrypoint File.","required":false,"type":"string","x-example":"<ENTRYPOINT>","in":"formData"},{"name":"commands","description":"Build Commands.","required":false,"type":"string","x-example":"<COMMANDS>","in":"formData"},{"name":"code","description":"Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.","required":true,"type":"file","in":"formData"},{"name":"activate","description":"Automatically activate the deployment when it is finished building.","required":true,"type":"boolean","x-example":false,"in":"formData"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}":{"get":{"summary":"Get deployment","operationId":"functionsGetDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a code deployment by its unique ID.","responses":{"200":{"description":"Deployment","schema":{"$ref":"#\/definitions\/deployment"}}},"x-appwrite":{"method":"getDeployment","weight":298,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"patch":{"summary":"Update function deployment","operationId":"functionsUpdateDeployment","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update the function code deployment ID using the unique function ID. Use this endpoint to switch the code deployment that should be executed by the execution endpoint.","responses":{"200":{"description":"Function","schema":{"$ref":"#\/definitions\/function"}}},"x-appwrite":{"method":"updateDeployment","weight":294,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-function-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]},"delete":{"summary":"Delete deployment","operationId":"functionsDeleteDeployment","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a code deployment by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteDeployment","weight":299,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/build":{"post":{"summary":"Rebuild deployment","operationId":"functionsCreateBuild","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"createBuild","weight":300,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"buildId":{"type":"string","description":"Build unique ID.","default":"","x-example":"<BUILD_ID>"}}}}]},"patch":{"summary":"Cancel deployment","operationId":"functionsUpdateDeploymentBuild","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"","responses":{"200":{"description":"Build","schema":{"$ref":"#\/definitions\/build"}}},"x-appwrite":{"method":"updateDeploymentBuild","weight":301,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-deployment-build.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/deployments\/{deploymentId}\/download":{"get":{"summary":"Download Deployment","operationId":"functionsDownloadDeployment","consumes":["application\/json"],"produces":["*\/*"],"tags":["functions"],"description":"Get a Deployment's contents by its unique ID. This endpoint supports range requests for partial or streaming file download.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"downloadDeployment","weight":293,"cookies":false,"type":"location","deprecated":false,"demo":"functions\/download-deployment.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/download-deployment.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"deploymentId","description":"Deployment ID.","required":true,"type":"string","x-example":"<DEPLOYMENT_ID>","in":"path"}]}},"\/functions\/{functionId}\/executions":{"get":{"summary":"List executions","operationId":"functionsListExecutions","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all the current user function execution logs. You can use the query params to filter your results.","responses":{"200":{"description":"Executions List","schema":{"$ref":"#\/definitions\/executionList"}}},"x-appwrite":{"method":"listExecutions","weight":303,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-executions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-executions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"queries","description":"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create execution","operationId":"functionsCreateExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.","responses":{"201":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"createExecution","weight":302,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"body":{"type":"string","description":"HTTP body of execution. Default value is empty string.","default":"","x-example":"<BODY>"},"async":{"type":"boolean","description":"Execute code in the background. Default value is false.","default":false,"x-example":false},"path":{"type":"string","description":"HTTP path of execution. Path can include query params. Default value is \/","default":"\/","x-example":"<PATH>"},"method":{"type":"string","description":"HTTP method of execution. Default value is GET.","default":"POST","x-example":"GET","enum":["GET","POST","PUT","PATCH","DELETE","OPTIONS"],"x-enum-name":"ExecutionMethod","x-enum-keys":[]},"headers":{"type":"object","description":"HTTP headers of execution. Defaults to empty.","default":[],"x-example":"{}"},"scheduledAt":{"type":"string","description":"Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/functions\/{functionId}\/executions\/{executionId}":{"get":{"summary":"Get execution","operationId":"functionsGetExecution","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a function execution log by its unique ID.","responses":{"200":{"description":"Execution","schema":{"$ref":"#\/definitions\/execution"}}},"x-appwrite":{"method":"getExecution","weight":304,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]},"delete":{"summary":"Delete execution","operationId":"functionsDeleteExecution","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a function execution by its unique ID.\n","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteExecution","weight":305,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-execution.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-execution.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"execution.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"executionId","description":"Execution ID.","required":true,"type":"string","x-example":"<EXECUTION_ID>","in":"path"}]}},"\/functions\/{functionId}\/variables":{"get":{"summary":"List variables","operationId":"functionsListVariables","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a list of all variables of a specific function.","responses":{"200":{"description":"Variables List","schema":{"$ref":"#\/definitions\/variableList"}}},"x-appwrite":{"method":"listVariables","weight":307,"cookies":false,"type":"","deprecated":false,"demo":"functions\/list-variables.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/list-variables.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"}]},"post":{"summary":"Create variable","operationId":"functionsCreateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.","responses":{"201":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"createVariable","weight":306,"cookies":false,"type":"","deprecated":false,"demo":"functions\/create-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key","value"]}}]}},"\/functions\/{functionId}\/variables\/{variableId}":{"get":{"summary":"Get variable","operationId":"functionsGetVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Get a variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"getVariable","weight":308,"cookies":false,"type":"","deprecated":false,"demo":"functions\/get-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/get-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]},"put":{"summary":"Update variable","operationId":"functionsUpdateVariable","consumes":["application\/json"],"produces":["application\/json"],"tags":["functions"],"description":"Update variable by its unique ID.","responses":{"200":{"description":"Variable","schema":{"$ref":"#\/definitions\/variable"}}},"x-appwrite":{"method":"updateVariable","weight":309,"cookies":false,"type":"","deprecated":false,"demo":"functions\/update-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"key":{"type":"string","description":"Variable key. Max length: 255 chars.","default":null,"x-example":"<KEY>"},"value":{"type":"string","description":"Variable value. Max length: 8192 chars.","default":null,"x-example":"<VALUE>"}},"required":["key"]}}]},"delete":{"summary":"Delete variable","operationId":"functionsDeleteVariable","consumes":["application\/json"],"produces":[],"tags":["functions"],"description":"Delete a variable by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteVariable","weight":310,"cookies":false,"type":"","deprecated":false,"demo":"functions\/delete-variable.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/delete-variable.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"functions.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"functionId","description":"Function unique ID.","required":true,"type":"string","x-example":"<FUNCTION_ID>","in":"path"},{"name":"variableId","description":"Variable unique ID.","required":true,"type":"string","x-example":"<VARIABLE_ID>","in":"path"}]}},"\/graphql":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlQuery","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"query","weight":326,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/query.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/graphql\/mutation":{"post":{"summary":"GraphQL endpoint","operationId":"graphqlMutation","consumes":["application\/json"],"produces":["application\/json"],"tags":["graphql"],"description":"Execute a GraphQL mutation.","responses":{"200":{"description":"Any","schema":{"$ref":"#\/definitions\/any"}}},"x-appwrite":{"method":"mutation","weight":325,"cookies":false,"type":"graphql","deprecated":false,"demo":"graphql\/mutation.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md","rate-limit":60,"rate-time":60,"rate-key":"url:{url},ip:{ip}","scope":"graphql","platforms":["server","client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[],"Session":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"query":{"type":"object","description":"The query or queries to execute.","default":{},"x-example":"{}"}},"required":["query"]}}]}},"\/health":{"get":{"summary":"Get HTTP","operationId":"healthGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite HTTP server is up and responsive.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"get","weight":124,"cookies":false,"type":"","deprecated":false,"demo":"health\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/anti-virus":{"get":{"summary":"Get antivirus","operationId":"healthGetAntivirus","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite Antivirus server is up and connection is successful.","responses":{"200":{"description":"Health Antivirus","schema":{"$ref":"#\/definitions\/healthAntivirus"}}},"x-appwrite":{"method":"getAntivirus","weight":146,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-antivirus.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/cache":{"get":{"summary":"Get cache","operationId":"healthGetCache","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite in-memory cache servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getCache","weight":127,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-cache.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/certificate":{"get":{"summary":"Get the SSL certificate for a domain","operationId":"healthGetCertificate","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the SSL certificate for a domain","responses":{"200":{"description":"Health Certificate","schema":{"$ref":"#\/definitions\/healthCertificate"}}},"x-appwrite":{"method":"getCertificate","weight":133,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-certificate.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"domain","description":"string","required":false,"type":"string","in":"query"}]}},"\/health\/db":{"get":{"summary":"Get DB","operationId":"healthGetDB","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite database servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getDB","weight":126,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-d-b.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/pubsub":{"get":{"summary":"Get pubsub","operationId":"healthGetPubSub","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite pub-sub servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getPubSub","weight":129,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-pub-sub.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue":{"get":{"summary":"Get queue","operationId":"healthGetQueue","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite queue messaging servers are up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getQueue","weight":128,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/queue\/builds":{"get":{"summary":"Get builds queue","operationId":"healthGetQueueBuilds","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of builds that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueBuilds","weight":135,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-builds.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/certificates":{"get":{"summary":"Get certificates queue","operationId":"healthGetQueueCertificates","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of certificates that are waiting to be issued against [Letsencrypt](https:\/\/letsencrypt.org\/) in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueCertificates","weight":134,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-certificates.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/databases":{"get":{"summary":"Get databases queue","operationId":"healthGetQueueDatabases","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDatabases","weight":136,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-databases.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"Queue name for which to check the queue size","required":false,"type":"string","x-example":"<NAME>","default":"database_db_main","in":"query"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/deletes":{"get":{"summary":"Get deletes queue","operationId":"healthGetQueueDeletes","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueDeletes","weight":137,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-deletes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/failed\/{name}":{"get":{"summary":"Get number of failed queue jobs","operationId":"healthGetFailedJobs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Returns the amount of failed jobs in a given queue.\n","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getFailedJobs","weight":147,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-failed-jobs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"name","description":"The name of the queue","required":true,"type":"string","x-example":"v1-database","enum":["v1-database","v1-deletes","v1-audits","v1-mails","v1-functions","v1-usage","v1-usage-dump","v1-webhooks","v1-certificates","v1-builds","v1-messaging","v1-migrations"],"x-enum-name":null,"x-enum-keys":[],"in":"path"},{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/functions":{"get":{"summary":"Get functions queue","operationId":"healthGetQueueFunctions","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueFunctions","weight":141,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-functions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/logs":{"get":{"summary":"Get logs queue","operationId":"healthGetQueueLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of logs that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueLogs","weight":132,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/mails":{"get":{"summary":"Get mails queue","operationId":"healthGetQueueMails","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of mails that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMails","weight":138,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-mails.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/messaging":{"get":{"summary":"Get messaging queue","operationId":"healthGetQueueMessaging","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of messages that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMessaging","weight":139,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-messaging.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/migrations":{"get":{"summary":"Get migrations queue","operationId":"healthGetQueueMigrations","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueMigrations","weight":140,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-migrations.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage":{"get":{"summary":"Get usage queue","operationId":"healthGetQueueUsage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsage","weight":142,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/usage-dump":{"get":{"summary":"Get usage dump queue","operationId":"healthGetQueueUsageDump","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of projects containing metrics that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueUsageDump","weight":143,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-usage-dump.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-usage-dump.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/queue\/webhooks":{"get":{"summary":"Get webhooks queue","operationId":"healthGetQueueWebhooks","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.","responses":{"200":{"description":"Health Queue","schema":{"$ref":"#\/definitions\/healthQueue"}}},"x-appwrite":{"method":"getQueueWebhooks","weight":131,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-queue-webhooks.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"threshold","description":"Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.","required":false,"type":"integer","format":"int32","default":5000,"in":"query"}]}},"\/health\/storage":{"get":{"summary":"Get storage","operationId":"healthGetStorage","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorage","weight":145,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/storage\/local":{"get":{"summary":"Get local storage","operationId":"healthGetStorageLocal","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite local storage device is up and connection is successful.","responses":{"200":{"description":"Health Status","schema":{"$ref":"#\/definitions\/healthStatus"}}},"x-appwrite":{"method":"getStorageLocal","weight":144,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-storage-local.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/health\/time":{"get":{"summary":"Get time","operationId":"healthGetTime","consumes":["application\/json"],"produces":["application\/json"],"tags":["health"],"description":"Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https:\/\/en.wikipedia.org\/wiki\/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.","responses":{"200":{"description":"Health Time","schema":{"$ref":"#\/definitions\/healthTime"}}},"x-appwrite":{"method":"getTime","weight":130,"cookies":false,"type":"","deprecated":false,"demo":"health\/get-time.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"health.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}]}},"\/locale":{"get":{"summary":"Get user locale","operationId":"localeGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))","responses":{"200":{"description":"Locale","schema":{"$ref":"#\/definitions\/locale"}}},"x-appwrite":{"method":"get","weight":116,"cookies":false,"type":"","deprecated":false,"demo":"locale\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/localed","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/codes":{"get":{"summary":"List Locale Codes","operationId":"localeListCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).","responses":{"200":{"description":"Locale codes list","schema":{"$ref":"#\/definitions\/localeCodeList"}}},"x-appwrite":{"method":"listCodes","weight":117,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/localeCode","offline-key":"current","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/continents":{"get":{"summary":"List continents","operationId":"localeListContinents","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all continents. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Continents List","schema":{"$ref":"#\/definitions\/continentList"}}},"x-appwrite":{"method":"listContinents","weight":121,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-continents.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/continents","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries":{"get":{"summary":"List countries","operationId":"localeListCountries","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountries","weight":118,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/eu":{"get":{"summary":"List EU countries","operationId":"localeListCountriesEU","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Countries List","schema":{"$ref":"#\/definitions\/countryList"}}},"x-appwrite":{"method":"listCountriesEU","weight":119,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-e-u.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/eu","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/countries\/phones":{"get":{"summary":"List countries phone codes","operationId":"localeListCountriesPhones","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all countries phone codes. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Phones List","schema":{"$ref":"#\/definitions\/phoneList"}}},"x-appwrite":{"method":"listCountriesPhones","weight":120,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-countries-phones.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/countries\/phones","offline-key":"","offline-response-key":"countryCode","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/currencies":{"get":{"summary":"List currencies","operationId":"localeListCurrencies","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.","responses":{"200":{"description":"Currencies List","schema":{"$ref":"#\/definitions\/currencyList"}}},"x-appwrite":{"method":"listCurrencies","weight":122,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-currencies.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/currencies","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/locale\/languages":{"get":{"summary":"List languages","operationId":"localeListLanguages","consumes":["application\/json"],"produces":["application\/json"],"tags":["locale"],"description":"List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.","responses":{"200":{"description":"Languages List","schema":{"$ref":"#\/definitions\/languageList"}}},"x-appwrite":{"method":"listLanguages","weight":123,"cookies":false,"type":"","deprecated":false,"demo":"locale\/list-languages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"locale.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/locale\/languages","offline-key":"","offline-response-key":"code","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}]}},"\/messaging\/messages":{"get":{"summary":"List messages","operationId":"messagingListMessages","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all messages from the current Appwrite project.","responses":{"200":{"description":"Message list","schema":{"$ref":"#\/definitions\/messageList"}}},"x-appwrite":{"method":"listMessages","weight":385,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-messages.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/messages\/email":{"post":{"summary":"Create email","operationId":"messagingCreateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new email message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createEmail","weight":382,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":[],"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":[],"x-example":null,"items":{"type":"string"}},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","subject","content"]}}]}},"\/messaging\/messages\/email\/{messageId}":{"patch":{"summary":"Update email","operationId":"messagingUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateEmail","weight":389,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"subject":{"type":"string","description":"Email Subject.","default":null,"x-example":"<SUBJECT>"},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"html":{"type":"boolean","description":"Is content of type HTML","default":null,"x-example":false},"cc":{"type":"array","description":"Array of target IDs to be added as CC.","default":null,"x-example":null,"items":{"type":"string"}},"bcc":{"type":"array","description":"Array of target IDs to be added as BCC.","default":null,"x-example":null,"items":{"type":"string"}},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null},"attachments":{"type":"array","description":"Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":null,"items":{"type":"string"}}}}}]}},"\/messaging\/messages\/push":{"post":{"summary":"Create push notification","operationId":"messagingCreatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new push notification.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createPush","weight":384,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":"","x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":"","x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web Platform.","default":"","x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and IOS Platform.","default":"","x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android Platform.","default":"","x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android Platform.","default":"","x-example":"<TAG>"},"badge":{"type":"string","description":"Badge for push notification. Available only for IOS Platform.","default":"","x-example":"<BADGE>"},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","title","body"]}}]}},"\/messaging\/messages\/push\/{messageId}":{"patch":{"summary":"Update push notification","operationId":"messagingUpdatePush","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a push notification by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updatePush","weight":391,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-push.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"title":{"type":"string","description":"Title for push notification.","default":null,"x-example":"<TITLE>"},"body":{"type":"string","description":"Body for push notification.","default":null,"x-example":"<BODY>"},"data":{"type":"object","description":"Additional Data for push notification.","default":{},"x-example":"{}"},"action":{"type":"string","description":"Action for push notification.","default":null,"x-example":"<ACTION>"},"image":{"type":"string","description":"Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.","default":null,"x-example":"[ID1:ID2]"},"icon":{"type":"string","description":"Icon for push notification. Available only for Android and Web platforms.","default":null,"x-example":"<ICON>"},"sound":{"type":"string","description":"Sound for push notification. Available only for Android and iOS platforms.","default":null,"x-example":"<SOUND>"},"color":{"type":"string","description":"Color for push notification. Available only for Android platforms.","default":null,"x-example":"<COLOR>"},"tag":{"type":"string","description":"Tag for push notification. Available only for Android platforms.","default":null,"x-example":"<TAG>"},"badge":{"type":"integer","description":"Badge for push notification. Available only for iOS platforms.","default":null,"x-example":null},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/sms":{"post":{"summary":"Create SMS","operationId":"messagingCreateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMS message.","responses":{"201":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"createSms","weight":383,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"messageId":{"type":"string","description":"Message ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<MESSAGE_ID>"},"content":{"type":"string","description":"SMS Content.","default":null,"x-example":"<CONTENT>"},"topics":{"type":"array","description":"List of Topic IDs.","default":[],"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":[],"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":[],"x-example":null,"items":{"type":"string"}},"draft":{"type":"boolean","description":"Is message a draft","default":false,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}},"required":["messageId","content"]}}]}},"\/messaging\/messages\/sms\/{messageId}":{"patch":{"summary":"Update SMS","operationId":"messagingUpdateSms","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update an email message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"updateSms","weight":390,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sms.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"topics":{"type":"array","description":"List of Topic IDs.","default":null,"x-example":null,"items":{"type":"string"}},"users":{"type":"array","description":"List of User IDs.","default":null,"x-example":null,"items":{"type":"string"}},"targets":{"type":"array","description":"List of Targets IDs.","default":null,"x-example":null,"items":{"type":"string"}},"content":{"type":"string","description":"Email Content.","default":null,"x-example":"<CONTENT>"},"draft":{"type":"boolean","description":"Is message a draft","default":null,"x-example":false},"scheduledAt":{"type":"string","description":"Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.","default":null,"x-example":null}}}}]}},"\/messaging\/messages\/{messageId}":{"get":{"summary":"Get message","operationId":"messagingGetMessage","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a message by its unique ID.\n","responses":{"200":{"description":"Message","schema":{"$ref":"#\/definitions\/message"}}},"x-appwrite":{"method":"getMessage","weight":388,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-message.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]},"delete":{"summary":"Delete message","operationId":"messagingDelete","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":392,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"}]}},"\/messaging\/messages\/{messageId}\/logs":{"get":{"summary":"List message logs","operationId":"messagingListMessageLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the message activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listMessageLogs","weight":386,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-message-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/messages\/{messageId}\/targets":{"get":{"summary":"List message targets","operationId":"messagingListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of the targets associated with a message.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":387,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"messages.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"messageId","description":"Message ID.","required":true,"type":"string","x-example":"<MESSAGE_ID>","in":"path"},{"name":"queries","description":"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, providerId, identifier, providerType","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/providers":{"get":{"summary":"List providers","operationId":"messagingListProviders","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all providers from the current Appwrite project.","responses":{"200":{"description":"Provider list","schema":{"$ref":"#\/definitions\/providerList"}}},"x-appwrite":{"method":"listProviders","weight":357,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-providers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/messaging\/providers\/apns":{"post":{"summary":"Create APNS provider","operationId":"messagingCreateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Apple Push Notification service provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createApnsProvider","weight":356,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/apns\/{providerId}":{"patch":{"summary":"Update APNS provider","operationId":"messagingUpdateApnsProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Apple Push Notification service provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateApnsProvider","weight":369,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-apns-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"authKey":{"type":"string","description":"APNS authentication key.","default":"","x-example":"<AUTH_KEY>"},"authKeyId":{"type":"string","description":"APNS authentication key ID.","default":"","x-example":"<AUTH_KEY_ID>"},"teamId":{"type":"string","description":"APNS team ID.","default":"","x-example":"<TEAM_ID>"},"bundleId":{"type":"string","description":"APNS bundle ID.","default":"","x-example":"<BUNDLE_ID>"},"sandbox":{"type":"boolean","description":"Use APNS sandbox environment.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/fcm":{"post":{"summary":"Create FCM provider","operationId":"messagingCreateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Firebase Cloud Messaging provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createFcmProvider","weight":355,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/fcm\/{providerId}":{"patch":{"summary":"Update FCM provider","operationId":"messagingUpdateFcmProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Firebase Cloud Messaging provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateFcmProvider","weight":368,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-fcm-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"serviceAccountJSON":{"type":"object","description":"FCM service account JSON.","default":{},"x-example":"{}"}}}}]}},"\/messaging\/providers\/mailgun":{"post":{"summary":"Create Mailgun provider","operationId":"messagingCreateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Mailgun provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMailgunProvider","weight":347,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/mailgun\/{providerId}":{"patch":{"summary":"Update Mailgun provider","operationId":"messagingUpdateMailgunProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Mailgun provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMailgunProvider","weight":360,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-mailgun-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"apiKey":{"type":"string","description":"Mailgun API Key.","default":"","x-example":"<API_KEY>"},"domain":{"type":"string","description":"Mailgun Domain.","default":"","x-example":"<DOMAIN>"},"isEuRegion":{"type":"boolean","description":"Set as EU region.","default":null,"x-example":false},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/msg91":{"post":{"summary":"Create Msg91 provider","operationId":"messagingCreateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new MSG91 provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createMsg91Provider","weight":350,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"templateId":{"type":"string","description":"Msg91 template ID","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/msg91\/{providerId}":{"patch":{"summary":"Update Msg91 provider","operationId":"messagingUpdateMsg91Provider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a MSG91 provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateMsg91Provider","weight":363,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-msg91provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"templateId":{"type":"string","description":"Msg91 template ID.","default":"","x-example":"<TEMPLATE_ID>"},"senderId":{"type":"string","description":"Msg91 sender ID.","default":"","x-example":"<SENDER_ID>"},"authKey":{"type":"string","description":"Msg91 auth key.","default":"","x-example":"<AUTH_KEY>"}}}}]}},"\/messaging\/providers\/sendgrid":{"post":{"summary":"Create Sendgrid provider","operationId":"messagingCreateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Sendgrid provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSendgridProvider","weight":348,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/sendgrid\/{providerId}":{"patch":{"summary":"Update Sendgrid provider","operationId":"messagingUpdateSendgridProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Sendgrid provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSendgridProvider","weight":361,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-sendgrid-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Sendgrid API key.","default":"","x-example":"<API_KEY>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"}}}}]}},"\/messaging\/providers\/smtp":{"post":{"summary":"Create SMTP provider","operationId":"messagingCreateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new SMTP provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createSmtpProvider","weight":349,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":null,"x-example":"<HOST>"},"port":{"type":"integer","description":"The default SMTP server port.","default":587,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be omitted, 'ssl', or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":true,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the reply to field for the mail. Default value is sender name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the reply to field for the mail. Default value is sender email.","default":"","x-example":"email@example.com"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name","host"]}}]}},"\/messaging\/providers\/smtp\/{providerId}":{"patch":{"summary":"Update SMTP provider","operationId":"messagingUpdateSmtpProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a SMTP provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateSmtpProvider","weight":362,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-smtp-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"host":{"type":"string","description":"SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.","default":"","x-example":"<HOST>"},"port":{"type":"integer","description":"SMTP port.","default":null,"x-example":1},"username":{"type":"string","description":"Authentication username.","default":"","x-example":"<USERNAME>"},"password":{"type":"string","description":"Authentication password.","default":"","x-example":"<PASSWORD>"},"encryption":{"type":"string","description":"Encryption type. Can be 'ssl' or 'tls'","default":"","x-example":"none","enum":["none","ssl","tls"],"x-enum-name":"SmtpEncryption","x-enum-keys":[]},"autoTLS":{"type":"boolean","description":"Enable SMTP AutoTLS feature.","default":null,"x-example":false},"mailer":{"type":"string","description":"The value to use for the X-Mailer header.","default":"","x-example":"<MAILER>"},"fromName":{"type":"string","description":"Sender Name.","default":"","x-example":"<FROM_NAME>"},"fromEmail":{"type":"string","description":"Sender email address.","default":"","x-example":"email@example.com"},"replyToName":{"type":"string","description":"Name set in the Reply To field for the mail. Default value is Sender Name.","default":"","x-example":"<REPLY_TO_NAME>"},"replyToEmail":{"type":"string","description":"Email set in the Reply To field for the mail. Default value is Sender Email.","default":"","x-example":"<REPLY_TO_EMAIL>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}}}}]}},"\/messaging\/providers\/telesign":{"post":{"summary":"Create Telesign provider","operationId":"messagingCreateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Telesign provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTelesignProvider","weight":351,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/telesign\/{providerId}":{"patch":{"summary":"Update Telesign provider","operationId":"messagingUpdateTelesignProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Telesign provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTelesignProvider","weight":364,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-telesign-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"customerId":{"type":"string","description":"Telesign customer ID.","default":"","x-example":"<CUSTOMER_ID>"},"apiKey":{"type":"string","description":"Telesign API key.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/textmagic":{"post":{"summary":"Create Textmagic provider","operationId":"messagingCreateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Textmagic provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTextmagicProvider","weight":352,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/textmagic\/{providerId}":{"patch":{"summary":"Update Textmagic provider","operationId":"messagingUpdateTextmagicProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Textmagic provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTextmagicProvider","weight":365,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-textmagic-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"username":{"type":"string","description":"Textmagic username.","default":"","x-example":"<USERNAME>"},"apiKey":{"type":"string","description":"Textmagic apiKey.","default":"","x-example":"<API_KEY>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/twilio":{"post":{"summary":"Create Twilio provider","operationId":"messagingCreateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Twilio provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createTwilioProvider","weight":353,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/twilio\/{providerId}":{"patch":{"summary":"Update Twilio provider","operationId":"messagingUpdateTwilioProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Twilio provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateTwilioProvider","weight":366,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-twilio-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"accountSid":{"type":"string","description":"Twilio account secret ID.","default":"","x-example":"<ACCOUNT_SID>"},"authToken":{"type":"string","description":"Twilio authentication token.","default":"","x-example":"<AUTH_TOKEN>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/vonage":{"post":{"summary":"Create Vonage provider","operationId":"messagingCreateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new Vonage provider.","responses":{"201":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"createVonageProvider","weight":354,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"providerId":{"type":"string","description":"Provider ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Provider name.","default":null,"x-example":"<NAME>"},"from":{"type":"string","description":"Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false}},"required":["providerId","name"]}}]}},"\/messaging\/providers\/vonage\/{providerId}":{"patch":{"summary":"Update Vonage provider","operationId":"messagingUpdateVonageProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a Vonage provider by its unique ID.","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"updateVonageProvider","weight":367,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-vonage-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Provider name.","default":"","x-example":"<NAME>"},"enabled":{"type":"boolean","description":"Set as enabled.","default":null,"x-example":false},"apiKey":{"type":"string","description":"Vonage API key.","default":"","x-example":"<API_KEY>"},"apiSecret":{"type":"string","description":"Vonage API secret.","default":"","x-example":"<API_SECRET>"},"from":{"type":"string","description":"Sender number.","default":"","x-example":"<FROM>"}}}}]}},"\/messaging\/providers\/{providerId}":{"get":{"summary":"Get provider","operationId":"messagingGetProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a provider by its unique ID.\n","responses":{"200":{"description":"Provider","schema":{"$ref":"#\/definitions\/provider"}}},"x-appwrite":{"method":"getProvider","weight":359,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]},"delete":{"summary":"Delete provider","operationId":"messagingDeleteProvider","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a provider by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteProvider","weight":370,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-provider.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"}]}},"\/messaging\/providers\/{providerId}\/logs":{"get":{"summary":"List provider logs","operationId":"messagingListProviderLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the provider activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listProviderLogs","weight":358,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-provider-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"providers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"providerId","description":"Provider ID.","required":true,"type":"string","x-example":"<PROVIDER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/subscribers\/{subscriberId}\/logs":{"get":{"summary":"List subscriber logs","operationId":"messagingListSubscriberLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the subscriber activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listSubscriberLogs","weight":379,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscriber-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics":{"get":{"summary":"List topics","operationId":"messagingListTopics","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all topics from the current Appwrite project.","responses":{"200":{"description":"Topic list","schema":{"$ref":"#\/definitions\/topicList"}}},"x-appwrite":{"method":"listTopics","weight":372,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topics.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, description, emailTotal, smsTotal, pushTotal","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create topic","operationId":"messagingCreateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new topic.","responses":{"201":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"createTopic","weight":371,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"topicId":{"type":"string","description":"Topic ID. Choose a custom Topic ID or a new Topic ID.","default":null,"x-example":"<TOPIC_ID>"},"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":["users"],"x-example":"[\"any\"]","items":{"type":"string"}}},"required":["topicId","name"]}}]}},"\/messaging\/topics\/{topicId}":{"get":{"summary":"Get topic","operationId":"messagingGetTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"getTopic","weight":374,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]},"patch":{"summary":"Update topic","operationId":"messagingUpdateTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Update a topic by its unique ID.\n","responses":{"200":{"description":"Topic","schema":{"$ref":"#\/definitions\/topic"}}},"x-appwrite":{"method":"updateTopic","weight":375,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/update-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Topic Name.","default":null,"x-example":"<NAME>"},"subscribe":{"type":"array","description":"An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.","default":null,"x-example":"[\"any\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete topic","operationId":"messagingDeleteTopic","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a topic by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTopic","weight":376,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-topic.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.write","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"}]}},"\/messaging\/topics\/{topicId}\/logs":{"get":{"summary":"List topic logs","operationId":"messagingListTopicLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get the topic activity logs listed by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listTopicLogs","weight":373,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-topic-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"topics.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/messaging\/topics\/{topicId}\/subscribers":{"get":{"summary":"List subscribers","operationId":"messagingListSubscribers","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a list of all subscribers from the current Appwrite project.","responses":{"200":{"description":"Subscriber list","schema":{"$ref":"#\/definitions\/subscriberList"}}},"x-appwrite":{"method":"listSubscribers","weight":378,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/list-subscribers.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"queries","description":"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: name, provider, type, enabled","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create subscriber","operationId":"messagingCreateSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Create a new subscriber.","responses":{"201":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"createSubscriber","weight":377,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/create-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"JWT":[]}},"security":[{"Project":[],"JWT":[],"Session":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID to subscribe to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"subscriberId":{"type":"string","description":"Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.","default":null,"x-example":"<SUBSCRIBER_ID>"},"targetId":{"type":"string","description":"Target ID. The target ID to link to the specified Topic ID.","default":null,"x-example":"<TARGET_ID>"}},"required":["subscriberId","targetId"]}}]}},"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}":{"get":{"summary":"Get subscriber","operationId":"messagingGetSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Get a subscriber by its unique ID.\n","responses":{"200":{"description":"Subscriber","schema":{"$ref":"#\/definitions\/subscriber"}}},"x-appwrite":{"method":"getSubscriber","weight":380,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/get-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.read","platforms":["console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]},"delete":{"summary":"Delete subscriber","operationId":"messagingDeleteSubscriber","consumes":["application\/json"],"produces":["application\/json"],"tags":["messaging"],"description":"Delete a subscriber by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSubscriber","weight":381,"cookies":false,"type":"","deprecated":false,"demo":"messaging\/delete-subscriber.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"subscribers.write","platforms":["server","client","console","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"JWT":[]}},"security":[{"Project":[],"JWT":[],"Session":[],"Key":[]}],"parameters":[{"name":"topicId","description":"Topic ID. The topic ID subscribed to.","required":true,"type":"string","x-example":"<TOPIC_ID>","in":"path"},{"name":"subscriberId","description":"Subscriber ID.","required":true,"type":"string","x-example":"<SUBSCRIBER_ID>","in":"path"}]}},"\/storage\/buckets":{"get":{"summary":"List buckets","operationId":"storageListBuckets","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the storage buckets. You can use the query params to filter your results.","responses":{"200":{"description":"Buckets List","schema":{"$ref":"#\/definitions\/bucketList"}}},"x-appwrite":{"method":"listBuckets","weight":201,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-buckets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create bucket","operationId":"storageCreateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new storage bucket.","responses":{"201":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"createBucket","weight":200,"cookies":false,"type":"","deprecated":false,"demo":"storage\/create-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"bucketId":{"type":"string","description":"Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<BUCKET_ID>"},"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["bucketId","name"]}}]}},"\/storage\/buckets\/{bucketId}":{"get":{"summary":"Get bucket","operationId":"storageGetBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"getBucket","weight":202,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]},"put":{"summary":"Update bucket","operationId":"storageUpdateBucket","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a storage bucket by its unique ID.","responses":{"200":{"description":"Bucket","schema":{"$ref":"#\/definitions\/bucket"}}},"x-appwrite":{"method":"updateBucket","weight":203,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Bucket name","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}},"fileSecurity":{"type":"boolean","description":"Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":false,"x-example":false},"enabled":{"type":"boolean","description":"Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.","default":true,"x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size allowed in bytes. Maximum allowed value is 30MB.","default":{},"x-example":1},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.","default":[],"x-example":null,"items":{"type":"string"}},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled","default":"none","x-example":"none","enum":["none","gzip","zstd"],"x-enum-name":null,"x-enum-keys":[]},"encryption":{"type":"boolean","description":"Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled","default":true,"x-example":false},"antivirus":{"type":"boolean","description":"Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled","default":true,"x-example":false}},"required":["name"]}}]},"delete":{"summary":"Delete bucket","operationId":"storageDeleteBucket","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a storage bucket by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteBucket","weight":204,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-bucket.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"buckets.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"bucketId","description":"Bucket unique ID.","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files":{"get":{"summary":"List files","operationId":"storageListFiles","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a list of all the user files. You can use the query params to filter your results.","responses":{"200":{"description":"Files List","schema":{"$ref":"#\/definitions\/fileList"}}},"x-appwrite":{"method":"listFiles","weight":206,"cookies":false,"type":"","deprecated":false,"demo":"storage\/list-files.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"queries","description":"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: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create file","operationId":"storageCreateFile","consumes":["multipart\/form-data"],"produces":["application\/json"],"tags":["storage"],"description":"Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n","responses":{"201":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"createFile","weight":205,"cookies":false,"type":"upload","deprecated":false,"demo":"storage\/create-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"x-upload-id":true,"type":"string","x-example":"<FILE_ID>","in":"formData"},{"name":"file","description":"Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).","required":true,"type":"file","in":"formData"},{"name":"permissions","description":"An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"x-example":"[\"read(\"any\")\"]","in":"formData"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}":{"get":{"summary":"Get file","operationId":"storageGetFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"getFile","weight":207,"cookies":false,"type":"","deprecated":false,"demo":"storage\/get-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]},"put":{"summary":"Update file","operationId":"storageUpdateFile","consumes":["application\/json"],"produces":["application\/json"],"tags":["storage"],"description":"Update a file by its unique ID. Only users with write permissions have access to update this resource.","responses":{"200":{"description":"File","schema":{"$ref":"#\/definitions\/file"}}},"x-appwrite":{"method":"updateFile","weight":212,"cookies":false,"type":"","deprecated":false,"demo":"storage\/update-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File unique ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the file","default":null,"x-example":"<NAME>"},"permissions":{"type":"array","description":"An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","default":null,"x-example":"[\"read(\"any\")\"]","items":{"type":"string"}}}}}]},"delete":{"summary":"Delete File","operationId":"storageDeleteFile","consumes":["application\/json"],"produces":[],"tags":["storage"],"description":"Delete a file by its unique ID. Only users with write permissions have access to delete this resource.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteFile","weight":213,"cookies":false,"type":"","deprecated":false,"demo":"storage\/delete-file.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md","rate-limit":60,"rate-time":60,"rate-key":"ip:{ip},method:{method},url:{url},userId:{userId}","scope":"files.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download":{"get":{"summary":"Get file for download","operationId":"storageGetFileDownload","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileDownload","weight":209,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-download.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview":{"get":{"summary":"Get file preview","operationId":"storageGetFilePreview","consumes":["application\/json"],"produces":["image\/*"],"tags":["storage"],"description":"Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.","responses":{"200":{"description":"Image","schema":{"type":"file"}}},"x-appwrite":{"method":"getFilePreview","weight":208,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-preview.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"},{"name":"width","description":"Resize preview image width, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"height","description":"Resize preview image height, Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"gravity","description":"Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right","required":false,"type":"string","x-example":"center","enum":["center","top-left","top","top-right","left","right","bottom-left","bottom","bottom-right"],"x-enum-name":"ImageGravity","x-enum-keys":[],"default":"center","in":"query"},{"name":"quality","description":"Preview image quality. Pass an integer between 0 to 100. Defaults to 100.","required":false,"type":"integer","format":"int32","x-example":0,"default":100,"in":"query"},{"name":"borderWidth","description":"Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"borderColor","description":"Preview image border color. Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"borderRadius","description":"Preview image border radius in pixels. Pass an integer between 0 to 4000.","required":false,"type":"integer","format":"int32","x-example":0,"default":0,"in":"query"},{"name":"opacity","description":"Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.","required":false,"type":"number","format":"float","x-example":0,"default":1,"in":"query"},{"name":"rotation","description":"Preview image rotation in degrees. Pass an integer between -360 and 360.","required":false,"type":"integer","format":"int32","x-example":-360,"default":0,"in":"query"},{"name":"background","description":"Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.","required":false,"type":"string","default":"","in":"query"},{"name":"output","description":"Output format type (jpeg, jpg, png, gif and webp).","required":false,"type":"string","x-example":"jpg","enum":["jpg","jpeg","gif","png","webp"],"x-enum-name":"ImageFormat","x-enum-keys":[],"default":"","in":"query"}]}},"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view":{"get":{"summary":"Get file for view","operationId":"storageGetFileView","consumes":["application\/json"],"produces":["*\/*"],"tags":["storage"],"description":"Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.","responses":{"200":{"description":"File","schema":{"type":"file"}}},"x-appwrite":{"method":"getFileView","weight":210,"cookies":false,"type":"location","deprecated":false,"demo":"storage\/get-file-view.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"files.read","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"bucketId","description":"Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).","required":true,"type":"string","x-example":"<BUCKET_ID>","in":"path"},{"name":"fileId","description":"File ID.","required":true,"type":"string","x-example":"<FILE_ID>","in":"path"}]}},"\/teams":{"get":{"summary":"List teams","operationId":"teamsList","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.","responses":{"200":{"description":"Teams List","schema":{"$ref":"#\/definitions\/teamList"}}},"x-appwrite":{"method":"list","weight":217,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"queries","description":"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: name, total, billingPlan","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team","operationId":"teamsCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.","responses":{"201":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"create","weight":216,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"teamId":{"type":"string","description":"Team ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TEAM_ID>"},"name":{"type":"string","description":"Team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"},"roles":{"type":"array","description":"Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":["owner"],"x-example":null,"items":{"type":"string"}}},"required":["teamId","name"]}}]}},"\/teams\/{teamId}":{"get":{"summary":"Get team","operationId":"teamsGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team by its ID. All team members have read access for this resource.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"get","weight":218,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update name","operationId":"teamsUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's name by its unique ID.","responses":{"200":{"description":"Team","schema":{"$ref":"#\/definitions\/team"}}},"x-appwrite":{"method":"updateName","weight":220,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams","offline-key":"{teamId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"New team name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]},"delete":{"summary":"Delete team","operationId":"teamsDelete","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"Delete a team using its ID. Only team members with the owner role can delete the team.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":222,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships":{"get":{"summary":"List team memberships","operationId":"teamsListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":224,"cookies":false,"type":"","deprecated":false,"demo":"teams\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"queries","description":"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, teamId, invited, joined, confirm","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create team membership","operationId":"teamsCreateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n","responses":{"201":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"createMembership","weight":223,"cookies":false,"type":"","deprecated":false,"demo":"teams\/create-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md","rate-limit":10,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"Email of the new team member.","default":"","x-example":"email@example.com"},"userId":{"type":"string","description":"ID of the user to be added to a team.","default":"","x-example":"<USER_ID>"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":"","x-example":"+12065550100"},"roles":{"type":"array","description":"Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}},"url":{"type":"string","description":"URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. 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.","default":"","x-example":"https:\/\/example.com"},"name":{"type":"string","description":"Name of the new team member. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["roles"]}}]}},"\/teams\/{teamId}\/memberships\/{membershipId}":{"get":{"summary":"Get team membership","operationId":"teamsGetMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get a team member by the membership unique id. All team members have read access for this resource.","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"getMembership","weight":225,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/memberships","offline-key":"{membershipId}","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]},"patch":{"summary":"Update membership","operationId":"teamsUpdateMembership","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembership","weight":226,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"roles":{"type":"array","description":"An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["roles"]}}]},"delete":{"summary":"Delete team membership","operationId":"teamsDeleteMembership","consumes":["application\/json"],"produces":[],"tags":["teams"],"description":"This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteMembership","weight":228,"cookies":false,"type":"","deprecated":false,"demo":"teams\/delete-membership.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"Key":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"}]}},"\/teams\/{teamId}\/memberships\/{membershipId}\/status":{"patch":{"summary":"Update team membership status","operationId":"teamsUpdateMembershipStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n","responses":{"200":{"description":"Membership","schema":{"$ref":"#\/definitions\/membership"}}},"x-appwrite":{"method":"updateMembershipStatus","weight":227,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-membership-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"public","platforms":["client","server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"membershipId","description":"Membership ID.","required":true,"type":"string","x-example":"<MEMBERSHIP_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID.","default":null,"x-example":"<USER_ID>"},"secret":{"type":"string","description":"Secret key.","default":null,"x-example":"<SECRET>"}},"required":["userId","secret"]}}]}},"\/teams\/{teamId}\/prefs":{"get":{"summary":"Get team preferences","operationId":"teamsGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":219,"cookies":false,"type":"","deprecated":false,"demo":"teams\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.read","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"}]},"put":{"summary":"Update preferences","operationId":"teamsUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["teams"],"description":"Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":221,"cookies":false,"type":"","deprecated":false,"demo":"teams\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"teams.write","platforms":["client","server"],"packaging":false,"offline-model":"\/teams\/{teamId}\/prefs","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Session":[]}},"security":[{"Project":[],"Session":[],"JWT":[]}],"parameters":[{"name":"teamId","description":"Team ID.","required":true,"type":"string","x-example":"<TEAM_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users":{"get":{"summary":"List users","operationId":"usersList","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a list of all the project's users. You can use the query params to filter your results.","responses":{"200":{"description":"Users List","schema":{"$ref":"#\/definitions\/userList"}}},"x-appwrite":{"method":"list","weight":239,"cookies":false,"type":"","deprecated":false,"demo":"users\/list.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]},"post":{"summary":"Create user","operationId":"usersCreate","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"create","weight":230,"cookies":false,"type":"","deprecated":false,"demo":"users\/create.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"phone":{"type":"string","description":"Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.","default":null,"x-example":"+12065550100"},"password":{"type":"string","description":"Plain text user password. Must be at least 8 chars.","default":"","x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId"]}}]}},"\/users\/argon2":{"post":{"summary":"Create user with Argon2 password","operationId":"usersCreateArgon2User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createArgon2User","weight":233,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-argon2user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Argon2.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/bcrypt":{"post":{"summary":"Create user with bcrypt password","operationId":"usersCreateBcryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createBcryptUser","weight":231,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-bcrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Bcrypt.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/identities":{"get":{"summary":"List Identities","operationId":"usersListIdentities","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get identities for all users.","responses":{"200":{"description":"Identities List","schema":{"$ref":"#\/definitions\/identityList"}}},"x-appwrite":{"method":"listIdentities","weight":247,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-identities.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"},{"name":"search","description":"Search term to filter your list results. Max length: 256 chars.","required":false,"type":"string","x-example":"<SEARCH>","default":"","in":"query"}]}},"\/users\/identities\/{identityId}":{"delete":{"summary":"Delete identity","operationId":"usersDeleteIdentity","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete an identity by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteIdentity","weight":270,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-identity.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"identityId","description":"Identity ID.","required":true,"type":"string","x-example":"<IDENTITY_ID>","in":"path"}]}},"\/users\/md5":{"post":{"summary":"Create user with MD5 password","operationId":"usersCreateMD5User","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createMD5User","weight":232,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-m-d5user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using MD5.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/phpass":{"post":{"summary":"Create user with PHPass password","operationId":"usersCreatePHPassUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createPHPassUser","weight":235,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-p-h-pass-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using PHPass.","default":null,"x-example":"password"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/scrypt":{"post":{"summary":"Create user with Scrypt password","operationId":"usersCreateScryptUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptUser","weight":236,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Optional salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordCpu":{"type":"integer","description":"Optional CPU cost used to hash password.","default":null,"x-example":null},"passwordMemory":{"type":"integer","description":"Optional memory cost used to hash password.","default":null,"x-example":null},"passwordParallel":{"type":"integer","description":"Optional parallelization cost used to hash password.","default":null,"x-example":null},"passwordLength":{"type":"integer","description":"Optional hash length used to hash password.","default":null,"x-example":null},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordCpu","passwordMemory","passwordParallel","passwordLength"]}}]}},"\/users\/scrypt-modified":{"post":{"summary":"Create user with Scrypt modified password","operationId":"usersCreateScryptModifiedUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createScryptModifiedUser","weight":237,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-scrypt-modified-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using Scrypt Modified.","default":null,"x-example":"password"},"passwordSalt":{"type":"string","description":"Salt used to hash password.","default":null,"x-example":"<PASSWORD_SALT>"},"passwordSaltSeparator":{"type":"string","description":"Salt separator used to hash password.","default":null,"x-example":"<PASSWORD_SALT_SEPARATOR>"},"passwordSignerKey":{"type":"string","description":"Signer key used to hash password.","default":null,"x-example":"<PASSWORD_SIGNER_KEY>"},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password","passwordSalt","passwordSaltSeparator","passwordSignerKey"]}}]}},"\/users\/sha":{"post":{"summary":"Create user with SHA password","operationId":"usersCreateSHAUser","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.","responses":{"201":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"createSHAUser","weight":234,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-s-h-a-user.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"payload","in":"body","schema":{"type":"object","properties":{"userId":{"type":"string","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<USER_ID>"},"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"},"password":{"type":"string","description":"User password hashed using SHA.","default":null,"x-example":"password"},"passwordVersion":{"type":"string","description":"Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'","default":"","x-example":"sha1","enum":["sha1","sha224","sha256","sha384","sha512\/224","sha512\/256","sha512","sha3-224","sha3-256","sha3-384","sha3-512"],"x-enum-name":"PasswordHash","x-enum-keys":[]},"name":{"type":"string","description":"User name. Max length: 128 chars.","default":"","x-example":"<NAME>"}},"required":["userId","email","password"]}}]}},"\/users\/{userId}":{"get":{"summary":"Get user","operationId":"usersGet","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"get","weight":240,"cookies":false,"type":"","deprecated":false,"demo":"users\/get.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user","operationId":"usersDelete","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"delete","weight":268,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/email":{"patch":{"summary":"Update email","operationId":"usersUpdateEmail","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmail","weight":253,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"email":{"type":"string","description":"User email.","default":null,"x-example":"email@example.com"}},"required":["email"]}}]}},"\/users\/{userId}\/jwts":{"post":{"summary":"Create user JWT","operationId":"usersCreateJWT","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.","responses":{"201":{"description":"JWT","schema":{"$ref":"#\/definitions\/jwt"}}},"x-appwrite":{"method":"createJWT","weight":271,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-j-w-t.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"sessionId":{"type":"string","description":"Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.","default":"recent","x-example":"<SESSION_ID>"},"duration":{"type":"integer","description":"Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.","default":900,"x-example":0}}}}]}},"\/users\/{userId}\/labels":{"put":{"summary":"Update user labels","operationId":"usersUpdateLabels","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateLabels","weight":249,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-labels.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"labels":{"type":"array","description":"Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.","default":null,"x-example":null,"items":{"type":"string"}}},"required":["labels"]}}]}},"\/users\/{userId}\/logs":{"get":{"summary":"List user logs","operationId":"usersListLogs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user activity logs list by its unique ID.","responses":{"200":{"description":"Logs List","schema":{"$ref":"#\/definitions\/logList"}}},"x-appwrite":{"method":"listLogs","weight":245,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-logs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]}},"\/users\/{userId}\/memberships":{"get":{"summary":"List user memberships","operationId":"usersListMemberships","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user membership list by its unique ID.","responses":{"200":{"description":"Memberships List","schema":{"$ref":"#\/definitions\/membershipList"}}},"x-appwrite":{"method":"listMemberships","weight":244,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-memberships.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa":{"patch":{"summary":"Update MFA","operationId":"usersUpdateMfa","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Enable or disable MFA on a user account.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateMfa","weight":258,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"mfa":{"type":"boolean","description":"Enable or disable MFA.","default":null,"x-example":false}},"required":["mfa"]}}]}},"\/users\/{userId}\/mfa\/authenticators\/{type}":{"delete":{"summary":"Delete Authenticator","operationId":"usersDeleteMfaAuthenticator","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete an authenticator app.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"deleteMfaAuthenticator","weight":263,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-mfa-authenticator.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"type","description":"Type of authenticator.","required":true,"type":"string","x-example":"totp","enum":["totp"],"x-enum-name":"AuthenticatorType","x-enum-keys":[],"in":"path"}]}},"\/users\/{userId}\/mfa\/factors":{"get":{"summary":"List Factors","operationId":"usersListMfaFactors","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the factors available on the account to be used as a MFA challange.","responses":{"200":{"description":"MFAFactors","schema":{"$ref":"#\/definitions\/mfaFactors"}}},"x-appwrite":{"method":"listMfaFactors","weight":259,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-mfa-factors.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/mfa\/recovery-codes":{"get":{"summary":"Get MFA Recovery Codes","operationId":"usersGetMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"getMfaRecoveryCodes","weight":260,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"put":{"summary":"Regenerate MFA Recovery Codes","operationId":"usersUpdateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.","responses":{"200":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"updateMfaRecoveryCodes","weight":262,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Create MFA Recovery Codes","operationId":"usersCreateMfaRecoveryCodes","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.","responses":{"201":{"description":"MFA Recovery Codes","schema":{"$ref":"#\/definitions\/mfaRecoveryCodes"}}},"x-appwrite":{"method":"createMfaRecoveryCodes","weight":261,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-mfa-recovery-codes.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/name":{"patch":{"summary":"Update name","operationId":"usersUpdateName","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user name by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateName","weight":251,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-name.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"name":{"type":"string","description":"User name. Max length: 128 chars.","default":null,"x-example":"<NAME>"}},"required":["name"]}}]}},"\/users\/{userId}\/password":{"patch":{"summary":"Update password","operationId":"usersUpdatePassword","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user password by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePassword","weight":252,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-password.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"password":{"type":"string","description":"New user password. Must be at least 8 chars.","default":null,"x-example":null}},"required":["password"]}}]}},"\/users\/{userId}\/phone":{"patch":{"summary":"Update phone","operationId":"usersUpdatePhone","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhone","weight":254,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"number":{"type":"string","description":"User phone number.","default":null,"x-example":"+12065550100"}},"required":["number"]}}]}},"\/users\/{userId}\/prefs":{"get":{"summary":"Get user preferences","operationId":"usersGetPrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user preferences by its unique ID.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"getPrefs","weight":241,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"patch":{"summary":"Update user preferences","operationId":"usersUpdatePrefs","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user preferences by its unique ID. 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.","responses":{"200":{"description":"Preferences","schema":{"$ref":"#\/definitions\/preferences"}}},"x-appwrite":{"method":"updatePrefs","weight":256,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-prefs.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"prefs":{"type":"object","description":"Prefs key-value JSON object.","default":{},"x-example":"{}"}},"required":["prefs"]}}]}},"\/users\/{userId}\/sessions":{"get":{"summary":"List user sessions","operationId":"usersListSessions","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get the user sessions list by its unique ID.","responses":{"200":{"description":"Sessions List","schema":{"$ref":"#\/definitions\/sessionList"}}},"x-appwrite":{"method":"listSessions","weight":243,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.read","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"post":{"summary":"Create session","operationId":"usersCreateSession","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.","responses":{"201":{"description":"Session","schema":{"$ref":"#\/definitions\/session"}}},"x-appwrite":{"method":"createSession","weight":264,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]},"delete":{"summary":"Delete user sessions","operationId":"usersDeleteSessions","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete all user's sessions by using the user's unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSessions","weight":267,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-sessions.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"}]}},"\/users\/{userId}\/sessions\/{sessionId}":{"delete":{"summary":"Delete user session","operationId":"usersDeleteSession","consumes":["application\/json"],"produces":[],"tags":["users"],"description":"Delete a user sessions by its unique ID.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteSession","weight":266,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-session.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"sessionId","description":"Session ID.","required":true,"type":"string","x-example":"<SESSION_ID>","in":"path"}]}},"\/users\/{userId}\/status":{"patch":{"summary":"Update user status","operationId":"usersUpdateStatus","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateStatus","weight":248,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-status.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"status":{"type":"boolean","description":"User Status. To activate the user pass `true` and to block the user pass `false`.","default":null,"x-example":false}},"required":["status"]}}]}},"\/users\/{userId}\/targets":{"get":{"summary":"List User Targets","operationId":"usersListTargets","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"List the messaging targets that are associated with a user.","responses":{"200":{"description":"Target list","schema":{"$ref":"#\/definitions\/targetList"}}},"x-appwrite":{"method":"listTargets","weight":246,"cookies":false,"type":"","deprecated":false,"demo":"users\/list-targets.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"queries","description":"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: name, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels","required":false,"type":"array","collectionFormat":"multi","items":{"type":"string"},"default":[],"in":"query"}]},"post":{"summary":"Create User Target","operationId":"usersCreateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Create a messaging target.","responses":{"201":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"createTarget","weight":238,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"targetId":{"type":"string","description":"Target ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.","default":null,"x-example":"<TARGET_ID>"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","default":null,"x-example":"email","enum":["email","sms","push"],"x-enum-name":"MessagingProviderType","x-enum-keys":[]},"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":null,"x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}},"required":["targetId","providerType","identifier"]}}]}},"\/users\/{userId}\/targets\/{targetId}":{"get":{"summary":"Get User Target","operationId":"usersGetTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Get a user's push notification target by ID.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"getTarget","weight":242,"cookies":false,"type":"","deprecated":false,"demo":"users\/get-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.read","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]},"patch":{"summary":"Update User target","operationId":"usersUpdateTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update a messaging target.","responses":{"200":{"description":"Target","schema":{"$ref":"#\/definitions\/target"}}},"x-appwrite":{"method":"updateTarget","weight":257,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"identifier":{"type":"string","description":"The target identifier (token, email, phone etc.)","default":"","x-example":"<IDENTIFIER>"},"providerId":{"type":"string","description":"Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.","default":"","x-example":"<PROVIDER_ID>"},"name":{"type":"string","description":"Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.","default":"","x-example":"<NAME>"}}}}]},"delete":{"summary":"Delete user target","operationId":"usersDeleteTarget","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Delete a messaging target.","responses":{"204":{"description":"No content"}},"x-appwrite":{"method":"deleteTarget","weight":269,"cookies":false,"type":"","deprecated":false,"demo":"users\/delete-target.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"targets.write","platforms":["server","console"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"targetId","description":"Target ID.","required":true,"type":"string","x-example":"<TARGET_ID>","in":"path"}]}},"\/users\/{userId}\/tokens":{"post":{"summary":"Create token","operationId":"usersCreateToken","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n","responses":{"201":{"description":"Token","schema":{"$ref":"#\/definitions\/token"}}},"x-appwrite":{"method":"createToken","weight":265,"cookies":false,"type":"","deprecated":false,"demo":"users\/create-token.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"length":{"type":"integer","description":"Token length in characters. The default length is 6 characters","default":6,"x-example":4},"expire":{"type":"integer","description":"Token expiration period in seconds. The default expiration is 15 minutes.","default":900,"x-example":60}}}}]}},"\/users\/{userId}\/verification":{"patch":{"summary":"Update email verification","operationId":"usersUpdateEmailVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user email verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updateEmailVerification","weight":255,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-email-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"emailVerification":{"type":"boolean","description":"User email verification status.","default":null,"x-example":false}},"required":["emailVerification"]}}]}},"\/users\/{userId}\/verification\/phone":{"patch":{"summary":"Update phone verification","operationId":"usersUpdatePhoneVerification","consumes":["application\/json"],"produces":["application\/json"],"tags":["users"],"description":"Update the user phone verification status by its unique ID.","responses":{"200":{"description":"User","schema":{"$ref":"#\/definitions\/user"}}},"x-appwrite":{"method":"updatePhoneVerification","weight":250,"cookies":false,"type":"","deprecated":false,"demo":"users\/update-phone-verification.md","edit":"https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md","rate-limit":0,"rate-time":3600,"rate-key":"url:{url},ip:{ip}","scope":"users.write","platforms":["server"],"packaging":false,"offline-model":"","offline-key":"","offline-response-key":"$id","auth":{"Project":[],"Key":[]}},"security":[{"Project":[],"Key":[]}],"parameters":[{"name":"userId","description":"User ID.","required":true,"type":"string","x-example":"<USER_ID>","in":"path"},{"name":"payload","in":"body","schema":{"type":"object","properties":{"phoneVerification":{"type":"boolean","description":"User phone verification status.","default":null,"x-example":false}},"required":["phoneVerification"]}}]}}},"tags":[{"name":"account","description":"The Account service allows you to authenticate and manage a user account.","x-globalAttributes":[]},{"name":"avatars","description":"The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.","x-globalAttributes":[]},{"name":"databases","description":"The Databases service allows you to create structured collections of documents, query and filter lists of documents","x-globalAttributes":["databaseId"]},{"name":"locale","description":"The Locale service allows you to customize your app based on your users' location.","x-globalAttributes":[]},{"name":"health","description":"The Health service allows you to both validate and monitor your Appwrite server's health.","x-globalAttributes":[]},{"name":"projects","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"project","description":"The Project service allows you to manage all the projects in your Appwrite server.","x-globalAttributes":[]},{"name":"storage","description":"The Storage service allows you to manage your project files.","x-globalAttributes":[]},{"name":"teams","description":"The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources","x-globalAttributes":[]},{"name":"users","description":"The Users service allows you to manage your project users.","x-globalAttributes":[]},{"name":"functions","description":"The Functions Service allows you view, create and manage your Cloud Functions.","x-globalAttributes":[]},{"name":"proxy","description":"The Proxy Service allows you to configure actions for your domains beyond DNS configuration.","x-globalAttributes":[]},{"name":"graphql","description":"The GraphQL API allows you to query and mutate your Appwrite server using GraphQL.","x-globalAttributes":[]},{"name":"console","description":"The Console service allows you to interact with console relevant informations.","x-globalAttributes":[]},{"name":"migrations","description":"The Migrations service allows you to migrate third-party data to your Appwrite project.","x-globalAttributes":[]},{"name":"messaging","description":"The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).","x-globalAttributes":[]}],"definitions":{"any":{"description":"Any","type":"object","additionalProperties":true},"documentList":{"description":"Documents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of documents documents that matched your query.","x-example":5,"format":"int32"},"documents":{"type":"array","description":"List of documents.","items":{"type":"object","$ref":"#\/definitions\/document"},"x-example":""}},"required":["total","documents"]},"collectionList":{"description":"Collections List","type":"object","properties":{"total":{"type":"integer","description":"Total number of collections documents that matched your query.","x-example":5,"format":"int32"},"collections":{"type":"array","description":"List of collections.","items":{"type":"object","$ref":"#\/definitions\/collection"},"x-example":""}},"required":["total","collections"]},"databaseList":{"description":"Databases List","type":"object","properties":{"total":{"type":"integer","description":"Total number of databases documents that matched your query.","x-example":5,"format":"int32"},"databases":{"type":"array","description":"List of databases.","items":{"type":"object","$ref":"#\/definitions\/database"},"x-example":""}},"required":["total","databases"]},"indexList":{"description":"Indexes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of indexes documents that matched your query.","x-example":5,"format":"int32"},"indexes":{"type":"array","description":"List of indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":""}},"required":["total","indexes"]},"userList":{"description":"Users List","type":"object","properties":{"total":{"type":"integer","description":"Total number of users documents that matched your query.","x-example":5,"format":"int32"},"users":{"type":"array","description":"List of users.","items":{"type":"object","$ref":"#\/definitions\/user"},"x-example":""}},"required":["total","users"]},"sessionList":{"description":"Sessions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of sessions documents that matched your query.","x-example":5,"format":"int32"},"sessions":{"type":"array","description":"List of sessions.","items":{"type":"object","$ref":"#\/definitions\/session"},"x-example":""}},"required":["total","sessions"]},"identityList":{"description":"Identities List","type":"object","properties":{"total":{"type":"integer","description":"Total number of identities documents that matched your query.","x-example":5,"format":"int32"},"identities":{"type":"array","description":"List of identities.","items":{"type":"object","$ref":"#\/definitions\/identity"},"x-example":""}},"required":["total","identities"]},"logList":{"description":"Logs List","type":"object","properties":{"total":{"type":"integer","description":"Total number of logs documents that matched your query.","x-example":5,"format":"int32"},"logs":{"type":"array","description":"List of logs.","items":{"type":"object","$ref":"#\/definitions\/log"},"x-example":""}},"required":["total","logs"]},"fileList":{"description":"Files List","type":"object","properties":{"total":{"type":"integer","description":"Total number of files documents that matched your query.","x-example":5,"format":"int32"},"files":{"type":"array","description":"List of files.","items":{"type":"object","$ref":"#\/definitions\/file"},"x-example":""}},"required":["total","files"]},"bucketList":{"description":"Buckets List","type":"object","properties":{"total":{"type":"integer","description":"Total number of buckets documents that matched your query.","x-example":5,"format":"int32"},"buckets":{"type":"array","description":"List of buckets.","items":{"type":"object","$ref":"#\/definitions\/bucket"},"x-example":""}},"required":["total","buckets"]},"teamList":{"description":"Teams List","type":"object","properties":{"total":{"type":"integer","description":"Total number of teams documents that matched your query.","x-example":5,"format":"int32"},"teams":{"type":"array","description":"List of teams.","items":{"type":"object","$ref":"#\/definitions\/team"},"x-example":""}},"required":["total","teams"]},"membershipList":{"description":"Memberships List","type":"object","properties":{"total":{"type":"integer","description":"Total number of memberships documents that matched your query.","x-example":5,"format":"int32"},"memberships":{"type":"array","description":"List of memberships.","items":{"type":"object","$ref":"#\/definitions\/membership"},"x-example":""}},"required":["total","memberships"]},"functionList":{"description":"Functions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of functions documents that matched your query.","x-example":5,"format":"int32"},"functions":{"type":"array","description":"List of functions.","items":{"type":"object","$ref":"#\/definitions\/function"},"x-example":""}},"required":["total","functions"]},"runtimeList":{"description":"Runtimes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of runtimes documents that matched your query.","x-example":5,"format":"int32"},"runtimes":{"type":"array","description":"List of runtimes.","items":{"type":"object","$ref":"#\/definitions\/runtime"},"x-example":""}},"required":["total","runtimes"]},"deploymentList":{"description":"Deployments List","type":"object","properties":{"total":{"type":"integer","description":"Total number of deployments documents that matched your query.","x-example":5,"format":"int32"},"deployments":{"type":"array","description":"List of deployments.","items":{"type":"object","$ref":"#\/definitions\/deployment"},"x-example":""}},"required":["total","deployments"]},"executionList":{"description":"Executions List","type":"object","properties":{"total":{"type":"integer","description":"Total number of executions documents that matched your query.","x-example":5,"format":"int32"},"executions":{"type":"array","description":"List of executions.","items":{"type":"object","$ref":"#\/definitions\/execution"},"x-example":""}},"required":["total","executions"]},"countryList":{"description":"Countries List","type":"object","properties":{"total":{"type":"integer","description":"Total number of countries documents that matched your query.","x-example":5,"format":"int32"},"countries":{"type":"array","description":"List of countries.","items":{"type":"object","$ref":"#\/definitions\/country"},"x-example":""}},"required":["total","countries"]},"continentList":{"description":"Continents List","type":"object","properties":{"total":{"type":"integer","description":"Total number of continents documents that matched your query.","x-example":5,"format":"int32"},"continents":{"type":"array","description":"List of continents.","items":{"type":"object","$ref":"#\/definitions\/continent"},"x-example":""}},"required":["total","continents"]},"languageList":{"description":"Languages List","type":"object","properties":{"total":{"type":"integer","description":"Total number of languages documents that matched your query.","x-example":5,"format":"int32"},"languages":{"type":"array","description":"List of languages.","items":{"type":"object","$ref":"#\/definitions\/language"},"x-example":""}},"required":["total","languages"]},"currencyList":{"description":"Currencies List","type":"object","properties":{"total":{"type":"integer","description":"Total number of currencies documents that matched your query.","x-example":5,"format":"int32"},"currencies":{"type":"array","description":"List of currencies.","items":{"type":"object","$ref":"#\/definitions\/currency"},"x-example":""}},"required":["total","currencies"]},"phoneList":{"description":"Phones List","type":"object","properties":{"total":{"type":"integer","description":"Total number of phones documents that matched your query.","x-example":5,"format":"int32"},"phones":{"type":"array","description":"List of phones.","items":{"type":"object","$ref":"#\/definitions\/phone"},"x-example":""}},"required":["total","phones"]},"variableList":{"description":"Variables List","type":"object","properties":{"total":{"type":"integer","description":"Total number of variables documents that matched your query.","x-example":5,"format":"int32"},"variables":{"type":"array","description":"List of variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":""}},"required":["total","variables"]},"localeCodeList":{"description":"Locale codes list","type":"object","properties":{"total":{"type":"integer","description":"Total number of localeCodes documents that matched your query.","x-example":5,"format":"int32"},"localeCodes":{"type":"array","description":"List of localeCodes.","items":{"type":"object","$ref":"#\/definitions\/localeCode"},"x-example":""}},"required":["total","localeCodes"]},"providerList":{"description":"Provider list","type":"object","properties":{"total":{"type":"integer","description":"Total number of providers documents that matched your query.","x-example":5,"format":"int32"},"providers":{"type":"array","description":"List of providers.","items":{"type":"object","$ref":"#\/definitions\/provider"},"x-example":""}},"required":["total","providers"]},"messageList":{"description":"Message list","type":"object","properties":{"total":{"type":"integer","description":"Total number of messages documents that matched your query.","x-example":5,"format":"int32"},"messages":{"type":"array","description":"List of messages.","items":{"type":"object","$ref":"#\/definitions\/message"},"x-example":""}},"required":["total","messages"]},"topicList":{"description":"Topic list","type":"object","properties":{"total":{"type":"integer","description":"Total number of topics documents that matched your query.","x-example":5,"format":"int32"},"topics":{"type":"array","description":"List of topics.","items":{"type":"object","$ref":"#\/definitions\/topic"},"x-example":""}},"required":["total","topics"]},"subscriberList":{"description":"Subscriber list","type":"object","properties":{"total":{"type":"integer","description":"Total number of subscribers documents that matched your query.","x-example":5,"format":"int32"},"subscribers":{"type":"array","description":"List of subscribers.","items":{"type":"object","$ref":"#\/definitions\/subscriber"},"x-example":""}},"required":["total","subscribers"]},"targetList":{"description":"Target list","type":"object","properties":{"total":{"type":"integer","description":"Total number of targets documents that matched your query.","x-example":5,"format":"int32"},"targets":{"type":"array","description":"List of targets.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":""}},"required":["total","targets"]},"database":{"description":"Database","type":"object","properties":{"$id":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Database name.","x-example":"My Database"},"$createdAt":{"type":"string","description":"Database creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Database update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"enabled":{"type":"boolean","description":"If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false}},"required":["$id","name","$createdAt","$updatedAt","enabled"]},"collection":{"description":"Collection","type":"object","properties":{"$id":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Collection creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Collection update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c16897e"},"name":{"type":"string","description":"Collection name.","x-example":"My Collection"},"enabled":{"type":"boolean","description":"Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.","x-example":false},"documentSecurity":{"type":"boolean","description":"Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"attributes":{"type":"array","description":"Collection attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":{}},"indexes":{"type":"array","description":"Collection indexes.","items":{"type":"object","$ref":"#\/definitions\/index"},"x-example":{}}},"required":["$id","$createdAt","$updatedAt","$permissions","databaseId","name","enabled","documentSecurity","attributes","indexes"]},"attributeList":{"description":"Attributes List","type":"object","properties":{"total":{"type":"integer","description":"Total number of attributes in the given collection.","x-example":5,"format":"int32"},"attributes":{"type":"array","description":"List of attributes.","items":{"x-anyOf":[{"$ref":"#\/definitions\/attributeBoolean"},{"$ref":"#\/definitions\/attributeInteger"},{"$ref":"#\/definitions\/attributeFloat"},{"$ref":"#\/definitions\/attributeEmail"},{"$ref":"#\/definitions\/attributeEnum"},{"$ref":"#\/definitions\/attributeUrl"},{"$ref":"#\/definitions\/attributeIp"},{"$ref":"#\/definitions\/attributeDatetime"},{"$ref":"#\/definitions\/attributeRelationship"},{"$ref":"#\/definitions\/attributeString"}]},"x-example":""}},"required":["total","attributes"]},"attributeString":{"description":"AttributeString","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"size":{"type":"integer","description":"Attribute size.","x-example":128,"format":"int32"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default","x-nullable":true}},"required":["key","type","status","error","required","size"]},"attributeInteger":{"description":"AttributeInteger","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"count"},"type":{"type":"string","description":"Attribute type.","x-example":"integer"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"integer","description":"Minimum value to enforce for new documents.","x-example":1,"format":"int32","x-nullable":true},"max":{"type":"integer","description":"Maximum value to enforce for new documents.","x-example":10,"format":"int32","x-nullable":true},"default":{"type":"integer","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":10,"format":"int32","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeFloat":{"description":"AttributeFloat","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"percentageCompleted"},"type":{"type":"string","description":"Attribute type.","x-example":"double"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"min":{"type":"number","description":"Minimum value to enforce for new documents.","x-example":1.5,"format":"double","x-nullable":true},"max":{"type":"number","description":"Maximum value to enforce for new documents.","x-example":10.5,"format":"double","x-nullable":true},"default":{"type":"number","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":2.5,"format":"double","x-nullable":true}},"required":["key","type","status","error","required"]},"attributeBoolean":{"description":"AttributeBoolean","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"isEnabled"},"type":{"type":"string","description":"Attribute type.","x-example":"boolean"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"default":{"type":"boolean","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":false,"x-nullable":true}},"required":["key","type","status","error","required"]},"attributeEmail":{"description":"AttributeEmail","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"userEmail"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"email"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"default@example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeEnum":{"description":"AttributeEnum","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"status"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"elements":{"type":"array","description":"Array of elements in enumerated type.","items":{"type":"string"},"x-example":"element"},"format":{"type":"string","description":"String format.","x-example":"enum"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"element","x-nullable":true}},"required":["key","type","status","error","required","elements","format"]},"attributeIp":{"description":"AttributeIP","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"ipAddress"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"ip"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"192.0.2.0","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeUrl":{"description":"AttributeURL","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"githubUrl"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"String format.","x-example":"url"},"default":{"type":"string","description":"Default value for attribute when not provided. Cannot be set when attribute is required.","x-example":"http:\/\/example.com","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeDatetime":{"description":"AttributeDatetime","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"birthDay"},"type":{"type":"string","description":"Attribute type.","x-example":"datetime"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"format":{"type":"string","description":"ISO 8601 format.","x-example":"datetime"},"default":{"type":"string","description":"Default value for attribute when not provided. Only null is optional","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true}},"required":["key","type","status","error","required","format"]},"attributeRelationship":{"description":"AttributeRelationship","type":"object","properties":{"key":{"type":"string","description":"Attribute Key.","x-example":"fullName"},"type":{"type":"string","description":"Attribute type.","x-example":"string"},"status":{"type":"string","description":"Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an attribute.","x-example":"string"},"required":{"type":"boolean","description":"Is attribute required?","x-example":true},"array":{"type":"boolean","description":"Is attribute an array?","x-example":false,"x-nullable":true},"relatedCollection":{"type":"string","description":"The ID of the related collection.","x-example":"collection"},"relationType":{"type":"string","description":"The type of the relationship.","x-example":"oneToOne|oneToMany|manyToOne|manyToMany"},"twoWay":{"type":"boolean","description":"Is the relationship two-way?","x-example":false},"twoWayKey":{"type":"string","description":"The key of the two-way relationship.","x-example":"string"},"onDelete":{"type":"string","description":"How deleting the parent document will propagate to child documents.","x-example":"restrict|cascade|setNull"},"side":{"type":"string","description":"Whether this is the parent or child side of the relationship","x-example":"parent|child"}},"required":["key","type","status","error","required","relatedCollection","relationType","twoWay","twoWayKey","onDelete","side"]},"index":{"description":"Index","type":"object","properties":{"key":{"type":"string","description":"Index Key.","x-example":"index1"},"type":{"type":"string","description":"Index type.","x-example":"primary"},"status":{"type":"string","description":"Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`","x-example":"available"},"error":{"type":"string","description":"Error message. Displays error generated on failure of creating or deleting an index.","x-example":"string"},"attributes":{"type":"array","description":"Index attributes.","items":{"type":"string"},"x-example":[]},"orders":{"type":"array","description":"Index orders.","items":{"type":"string"},"x-example":[],"x-nullable":true}},"required":["key","type","status","error","attributes"]},"document":{"description":"Document","type":"object","properties":{"$id":{"type":"string","description":"Document ID.","x-example":"5e5ea5c16897e"},"$collectionId":{"type":"string","description":"Collection ID.","x-example":"5e5ea5c15117e"},"$databaseId":{"type":"string","description":"Database ID.","x-example":"5e5ea5c15117e"},"$createdAt":{"type":"string","description":"Document creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Document update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]}},"additionalProperties":true,"required":["$id","$collectionId","$databaseId","$createdAt","$updatedAt","$permissions"]},"log":{"description":"Log","type":"object","properties":{"event":{"type":"string","description":"Event name.","x-example":"account.sessions.create"},"userId":{"type":"string","description":"User ID.","x-example":"610fc2f985ee0"},"userEmail":{"type":"string","description":"User Email.","x-example":"john@appwrite.io"},"userName":{"type":"string","description":"User Name.","x-example":"John Doe"},"mode":{"type":"string","description":"API mode when event triggered.","x-example":"admin"},"ip":{"type":"string","description":"IP session in use when the session was created.","x-example":"127.0.0.1"},"time":{"type":"string","description":"Log creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["event","userId","userEmail","userName","mode","ip","time","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName"]},"user":{"description":"User","type":"object","properties":{"$id":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"User creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"User update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"User name.","x-example":"John Doe"},"password":{"type":"string","description":"Hashed user password.","x-example":"$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE","x-nullable":true},"hash":{"type":"string","description":"Password hashing algorithm.","x-example":"argon2","x-nullable":true},"hashOptions":{"type":"object","description":"Password hashing algorithm configuration.","x-example":{},"items":{"x-oneOf":[{"$ref":"#\/definitions\/algoArgon2"},{"$ref":"#\/definitions\/algoScrypt"},{"$ref":"#\/definitions\/algoScryptModified"},{"$ref":"#\/definitions\/algoBcrypt"},{"$ref":"#\/definitions\/algoPhpass"},{"$ref":"#\/definitions\/algoSha"},{"$ref":"#\/definitions\/algoMd5"}]},"x-nullable":true},"registration":{"type":"string","description":"User registration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"status":{"type":"boolean","description":"User status. Pass `true` for enabled and `false` for disabled.","x-example":true},"labels":{"type":"array","description":"Labels for the user.","items":{"type":"string"},"x-example":["vip"]},"passwordUpdate":{"type":"string","description":"Password update time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"email":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"phone":{"type":"string","description":"User phone number in E.164 format.","x-example":"+4930901820"},"emailVerification":{"type":"boolean","description":"Email verification status.","x-example":true},"phoneVerification":{"type":"boolean","description":"Phone verification status.","x-example":true},"mfa":{"type":"boolean","description":"Multi factor authentication status.","x-example":true},"prefs":{"type":"object","description":"User preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}},"targets":{"type":"array","description":"A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.","items":{"type":"object","$ref":"#\/definitions\/target"},"x-example":[]},"accessedAt":{"type":"string","description":"Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","name","registration","status","labels","passwordUpdate","email","phone","emailVerification","phoneVerification","mfa","prefs","targets","accessedAt"]},"algoMd5":{"description":"AlgoMD5","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"md5"}},"required":["type"]},"algoSha":{"description":"AlgoSHA","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"sha"}},"required":["type"]},"algoPhpass":{"description":"AlgoPHPass","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"phpass"}},"required":["type"]},"algoBcrypt":{"description":"AlgoBcrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"bcrypt"}},"required":["type"]},"algoScrypt":{"description":"AlgoScrypt","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scrypt"},"costCpu":{"type":"integer","description":"CPU complexity of computed hash.","x-example":8,"format":"int32"},"costMemory":{"type":"integer","description":"Memory complexity of computed hash.","x-example":14,"format":"int32"},"costParallel":{"type":"integer","description":"Parallelization of computed hash.","x-example":1,"format":"int32"},"length":{"type":"integer","description":"Length used to compute hash.","x-example":64,"format":"int32"}},"required":["type","costCpu","costMemory","costParallel","length"]},"algoScryptModified":{"description":"AlgoScryptModified","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"scryptMod"},"salt":{"type":"string","description":"Salt used to compute hash.","x-example":"UxLMreBr6tYyjQ=="},"saltSeparator":{"type":"string","description":"Separator used to compute hash.","x-example":"Bw=="},"signerKey":{"type":"string","description":"Key used to compute hash.","x-example":"XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="}},"required":["type","salt","saltSeparator","signerKey"]},"algoArgon2":{"description":"AlgoArgon2","type":"object","properties":{"type":{"type":"string","description":"Algo type.","x-example":"argon2"},"memoryCost":{"type":"integer","description":"Memory used to compute hash.","x-example":65536,"format":"int32"},"timeCost":{"type":"integer","description":"Amount of time consumed to compute hash","x-example":4,"format":"int32"},"threads":{"type":"integer","description":"Number of threads used to compute hash.","x-example":3,"format":"int32"}},"required":["type","memoryCost","timeCost","threads"]},"preferences":{"description":"Preferences","type":"object","additionalProperties":true},"session":{"description":"Session","type":"object","properties":{"$id":{"type":"string","description":"Session ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Session creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Session update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"expire":{"type":"string","description":"Session expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"provider":{"type":"string","description":"Session Provider.","x-example":"email"},"providerUid":{"type":"string","description":"Session Provider User ID.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Session Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Session Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"ip":{"type":"string","description":"IP in use when the session was created.","x-example":"127.0.0.1"},"osCode":{"type":"string","description":"Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).","x-example":"Mac"},"osName":{"type":"string","description":"Operating system name.","x-example":"Mac"},"osVersion":{"type":"string","description":"Operating system version.","x-example":"Mac"},"clientType":{"type":"string","description":"Client type.","x-example":"browser"},"clientCode":{"type":"string","description":"Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).","x-example":"CM"},"clientName":{"type":"string","description":"Client name.","x-example":"Chrome Mobile iOS"},"clientVersion":{"type":"string","description":"Client version.","x-example":"84.0"},"clientEngine":{"type":"string","description":"Client engine name.","x-example":"WebKit"},"clientEngineVersion":{"type":"string","description":"Client engine name.","x-example":"605.1.15"},"deviceName":{"type":"string","description":"Device name.","x-example":"smartphone"},"deviceBrand":{"type":"string","description":"Device brand name.","x-example":"Google"},"deviceModel":{"type":"string","description":"Device model name.","x-example":"Nexus 5"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"},"current":{"type":"boolean","description":"Returns true if this the current user session.","x-example":true},"factors":{"type":"array","description":"Returns a list of active session factors.","items":{"type":"string"},"x-example":["email"]},"secret":{"type":"string","description":"Secret used to authenticate the user. Only included if the request was made with an API key","x-example":"5e5bb8c16897e"},"mfaUpdatedAt":{"type":"string","description":"Most recent date in ISO 8601 format when the session successfully passed MFA challenge.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","$updatedAt","userId","expire","provider","providerUid","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken","ip","osCode","osName","osVersion","clientType","clientCode","clientName","clientVersion","clientEngine","clientEngineVersion","deviceName","deviceBrand","deviceModel","countryCode","countryName","current","factors","secret","mfaUpdatedAt"]},"identity":{"description":"Identity","type":"object","properties":{"$id":{"type":"string","description":"Identity ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Identity creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Identity update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5bb8c16897e"},"provider":{"type":"string","description":"Identity Provider.","x-example":"email"},"providerUid":{"type":"string","description":"ID of the User in the Identity Provider.","x-example":"5e5bb8c16897e"},"providerEmail":{"type":"string","description":"Email of the User in the Identity Provider.","x-example":"user@example.com"},"providerAccessToken":{"type":"string","description":"Identity Provider Access Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"},"providerAccessTokenExpiry":{"type":"string","description":"The date of when the access token expires in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerRefreshToken":{"type":"string","description":"Identity Provider Refresh Token.","x-example":"MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"}},"required":["$id","$createdAt","$updatedAt","userId","provider","providerUid","providerEmail","providerAccessToken","providerAccessTokenExpiry","providerRefreshToken"]},"token":{"description":"Token","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"secret":{"type":"string","description":"Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"phrase":{"type":"string","description":"Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.","x-example":"Golden Fox"}},"required":["$id","$createdAt","userId","secret","expire","phrase"]},"jwt":{"description":"JWT","type":"object","properties":{"jwt":{"type":"string","description":"JWT encoded string.","x-example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}},"required":["jwt"]},"locale":{"description":"Locale","type":"object","properties":{"ip":{"type":"string","description":"User IP address.","x-example":"127.0.0.1"},"countryCode":{"type":"string","description":"Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format","x-example":"US"},"country":{"type":"string","description":"Country name. This field support localization.","x-example":"United States"},"continentCode":{"type":"string","description":"Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.","x-example":"NA"},"continent":{"type":"string","description":"Continent name. This field support localization.","x-example":"North America"},"eu":{"type":"boolean","description":"True if country is part of the European Union.","x-example":false},"currency":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format","x-example":"USD"}},"required":["ip","countryCode","country","continentCode","continent","eu","currency"]},"localeCode":{"description":"LocaleCode","type":"object","properties":{"code":{"type":"string","description":"Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)","x-example":"en-us"},"name":{"type":"string","description":"Locale name","x-example":"US"}},"required":["code","name"]},"file":{"description":"File","type":"object","properties":{"$id":{"type":"string","description":"File ID.","x-example":"5e5ea5c16897e"},"bucketId":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"File creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"File update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"name":{"type":"string","description":"File name.","x-example":"Pink.png"},"signature":{"type":"string","description":"File MD5 signature.","x-example":"5d529fd02b544198ae075bd57c1762bb"},"mimeType":{"type":"string","description":"File mime type.","x-example":"image\/png"},"sizeOriginal":{"type":"integer","description":"File original size in bytes.","x-example":17890,"format":"int32"},"chunksTotal":{"type":"integer","description":"Total number of chunks available","x-example":17890,"format":"int32"},"chunksUploaded":{"type":"integer","description":"Total number of chunks uploaded","x-example":17890,"format":"int32"}},"required":["$id","bucketId","$createdAt","$updatedAt","$permissions","name","signature","mimeType","sizeOriginal","chunksTotal","chunksUploaded"]},"bucket":{"description":"Bucket","type":"object","properties":{"$id":{"type":"string","description":"Bucket ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Bucket creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Bucket update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","items":{"type":"string"},"x-example":["read(\"any\")"]},"fileSecurity":{"type":"boolean","description":"Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).","x-example":true},"name":{"type":"string","description":"Bucket name.","x-example":"Documents"},"enabled":{"type":"boolean","description":"Bucket enabled.","x-example":false},"maximumFileSize":{"type":"integer","description":"Maximum file size supported.","x-example":100,"format":"int32"},"allowedFileExtensions":{"type":"array","description":"Allowed file extensions.","items":{"type":"string"},"x-example":["jpg","png"]},"compression":{"type":"string","description":"Compression algorithm choosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).","x-example":"gzip"},"encryption":{"type":"boolean","description":"Bucket is encrypted.","x-example":false},"antivirus":{"type":"boolean","description":"Virus scanning is enabled.","x-example":false}},"required":["$id","$createdAt","$updatedAt","$permissions","fileSecurity","name","enabled","maximumFileSize","allowedFileExtensions","compression","encryption","antivirus"]},"team":{"description":"Team","type":"object","properties":{"$id":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Team creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Team update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Team name.","x-example":"VIP"},"total":{"type":"integer","description":"Total number of team members.","x-example":7,"format":"int32"},"prefs":{"type":"object","description":"Team preferences as a key-value object","x-example":{"theme":"pink","timezone":"UTC"},"items":{"type":"object","$ref":"#\/definitions\/preferences"}}},"required":["$id","$createdAt","$updatedAt","name","total","prefs"]},"membership":{"description":"Membership","type":"object","properties":{"$id":{"type":"string","description":"Membership ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Membership creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Membership update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User name.","x-example":"John Doe"},"userEmail":{"type":"string","description":"User email address.","x-example":"john@appwrite.io"},"teamId":{"type":"string","description":"Team ID.","x-example":"5e5ea5c16897e"},"teamName":{"type":"string","description":"Team name.","x-example":"VIP"},"invited":{"type":"string","description":"Date, the user has been invited to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"joined":{"type":"string","description":"Date, the user has accepted the invitation to join the team in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"confirm":{"type":"boolean","description":"User confirmation status, true if the user has joined the team or false otherwise.","x-example":false},"mfa":{"type":"boolean","description":"Multi factor authentication status, true if the user has MFA enabled or false otherwise.","x-example":false},"roles":{"type":"array","description":"User list of roles","items":{"type":"string"},"x-example":["owner"]}},"required":["$id","$createdAt","$updatedAt","userId","userName","userEmail","teamId","teamName","invited","joined","confirm","mfa","roles"]},"function":{"description":"Function","type":"object","properties":{"$id":{"type":"string","description":"Function ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Function creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Function update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"execute":{"type":"array","description":"Execution permissions.","items":{"type":"string"},"x-example":"users"},"name":{"type":"string","description":"Function name.","x-example":"My Function"},"enabled":{"type":"boolean","description":"Function enabled.","x-example":false},"live":{"type":"boolean","description":"Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.","x-example":false},"logging":{"type":"boolean","description":"Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project.","x-example":false},"runtime":{"type":"string","description":"Function execution runtime.","x-example":"python-3.8"},"deployment":{"type":"string","description":"Function's active deployment ID.","x-example":"5e5ea5c16897e"},"scopes":{"type":"array","description":"Allowed permission scopes.","items":{"type":"string"},"x-example":"users.read"},"vars":{"type":"array","description":"Function variables.","items":{"type":"object","$ref":"#\/definitions\/variable"},"x-example":[]},"events":{"type":"array","description":"Function trigger events.","items":{"type":"string"},"x-example":"account.create"},"schedule":{"type":"string","description":"Function execution schedult in CRON format.","x-example":"5 4 * * *"},"timeout":{"type":"integer","description":"Function execution timeout in seconds.","x-example":300,"format":"int32"},"entrypoint":{"type":"string","description":"The entrypoint file used to execute the deployment.","x-example":"index.js"},"commands":{"type":"string","description":"The build command used to build the deployment.","x-example":"npm install"},"version":{"type":"string","description":"Version of Open Runtimes used for the function.","x-example":"v2"},"installationId":{"type":"string","description":"Function VCS (Version Control System) installation id.","x-example":"6m40at4ejk5h2u9s1hboo"},"providerRepositoryId":{"type":"string","description":"VCS (Version Control System) Repository ID","x-example":"appwrite"},"providerBranch":{"type":"string","description":"VCS (Version Control System) branch name","x-example":"main"},"providerRootDirectory":{"type":"string","description":"Path to function in VCS (Version Control System) repository","x-example":"functions\/helloWorld"},"providerSilentMode":{"type":"boolean","description":"Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests","x-example":false}},"required":["$id","$createdAt","$updatedAt","execute","name","enabled","live","logging","runtime","deployment","scopes","vars","events","schedule","timeout","entrypoint","commands","version","installationId","providerRepositoryId","providerBranch","providerRootDirectory","providerSilentMode"]},"runtime":{"description":"Runtime","type":"object","properties":{"$id":{"type":"string","description":"Runtime ID.","x-example":"python-3.8"},"name":{"type":"string","description":"Runtime Name.","x-example":"Python"},"version":{"type":"string","description":"Runtime version.","x-example":"3.8"},"base":{"type":"string","description":"Base Docker image used to build the runtime.","x-example":"python:3.8-alpine"},"image":{"type":"string","description":"Image name of Docker Hub.","x-example":"appwrite\\\/runtime-for-python:3.8"},"logo":{"type":"string","description":"Name of the logo image.","x-example":"python.png"},"supports":{"type":"array","description":"List of supported architectures.","items":{"type":"string"},"x-example":"amd64"}},"required":["$id","name","version","base","image","logo","supports"]},"deployment":{"description":"Deployment","type":"object","properties":{"$id":{"type":"string","description":"Deployment ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Deployment update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"type":{"type":"string","description":"Type of deployment.","x-example":"vcs"},"resourceId":{"type":"string","description":"Resource ID.","x-example":"5e5ea6g16897e"},"resourceType":{"type":"string","description":"Resource type.","x-example":"functions"},"entrypoint":{"type":"string","description":"The entrypoint file to use to execute the deployment code.","x-example":"index.js"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"},"buildId":{"type":"string","description":"The current build ID.","x-example":"5e5ea5c16897e"},"activate":{"type":"boolean","description":"Whether the deployment should be automatically activated.","x-example":true},"status":{"type":"string","description":"The deployment status. Possible values are \"processing\", \"building\", \"waiting\", \"ready\", and \"failed\".","x-example":"ready"},"buildLogs":{"type":"string","description":"The build logs.","x-example":"Compiling source files..."},"buildTime":{"type":"integer","description":"The current build time in seconds.","x-example":128,"format":"int32"},"providerRepositoryName":{"type":"string","description":"The name of the vcs provider repository","x-example":"database"},"providerRepositoryOwner":{"type":"string","description":"The name of the vcs provider repository owner","x-example":"utopia"},"providerRepositoryUrl":{"type":"string","description":"The url of the vcs provider repository","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function"},"providerBranch":{"type":"string","description":"The branch of the vcs repository","x-example":"0.7.x"},"providerCommitHash":{"type":"string","description":"The commit hash of the vcs commit","x-example":"7c3f25d"},"providerCommitAuthorUrl":{"type":"string","description":"The url of vcs commit author","x-example":"https:\/\/github.com\/vermakhushboo"},"providerCommitAuthor":{"type":"string","description":"The name of vcs commit author","x-example":"Khushboo Verma"},"providerCommitMessage":{"type":"string","description":"The commit message","x-example":"Update index.js"},"providerCommitUrl":{"type":"string","description":"The url of the vcs commit","x-example":"https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"},"providerBranchUrl":{"type":"string","description":"The branch of the vcs repository","x-example":"https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"}},"required":["$id","$createdAt","$updatedAt","type","resourceId","resourceType","entrypoint","size","buildId","activate","status","buildLogs","buildTime","providerRepositoryName","providerRepositoryOwner","providerRepositoryUrl","providerBranch","providerCommitHash","providerCommitAuthorUrl","providerCommitAuthor","providerCommitMessage","providerCommitUrl","providerBranchUrl"]},"execution":{"description":"Execution","type":"object","properties":{"$id":{"type":"string","description":"Execution ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Execution creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Execution upate date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$permissions":{"type":"array","description":"Execution roles.","items":{"type":"string"},"x-example":["any"]},"functionId":{"type":"string","description":"Function ID.","x-example":"5e5ea6g16897e"},"trigger":{"type":"string","description":"The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.","x-example":"http"},"status":{"type":"string","description":"The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.","x-example":"processing"},"requestMethod":{"type":"string","description":"HTTP request method type.","x-example":"GET"},"requestPath":{"type":"string","description":"HTTP request path and query.","x-example":"\/articles?id=5"},"requestHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"responseStatusCode":{"type":"integer","description":"HTTP response status code.","x-example":200,"format":"int32"},"responseBody":{"type":"string","description":"HTTP response body. This will return empty unless execution is created as synchronous.","x-example":"Developers are awesome."},"responseHeaders":{"type":"array","description":"HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.","items":{"type":"object","$ref":"#\/definitions\/headers"},"x-example":[{"Content-Type":"application\/json"}]},"logs":{"type":"string","description":"Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"errors":{"type":"string","description":"Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.","x-example":""},"duration":{"type":"number","description":"Function execution duration in seconds.","x-example":0.4,"format":"double"}},"required":["$id","$createdAt","$updatedAt","$permissions","functionId","trigger","status","requestMethod","requestPath","requestHeaders","responseStatusCode","responseBody","responseHeaders","logs","errors","duration"]},"build":{"description":"Build","type":"object","properties":{"$id":{"type":"string","description":"Build ID.","x-example":"5e5ea5c16897e"},"deploymentId":{"type":"string","description":"The deployment that created this build.","x-example":"5e5ea5c16897e"},"status":{"type":"string","description":"The build status. There are a few different types and each one means something different. \\nFailed - The deployment build has failed. More details can usually be found in buildStderr\\nReady - The deployment build was successful and the deployment is ready to be deployed\\nProcessing - The deployment is currently waiting to have a build triggered\\nBuilding - The deployment is currently being built","x-example":"ready"},"stdout":{"type":"string","description":"The stdout of the build.","x-example":""},"stderr":{"type":"string","description":"The stderr of the build.","x-example":""},"startTime":{"type":"string","description":"The deployment creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"endTime":{"type":"string","description":"The time the build was finished in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"duration":{"type":"integer","description":"The build duration in seconds.","x-example":0,"format":"int32"},"size":{"type":"integer","description":"The code size in bytes.","x-example":128,"format":"int32"}},"required":["$id","deploymentId","status","stdout","stderr","startTime","endTime","duration","size"]},"variable":{"description":"Variable","type":"object","properties":{"$id":{"type":"string","description":"Variable ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Variable creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"key":{"type":"string","description":"Variable key.","x-example":"API_KEY"},"value":{"type":"string","description":"Variable value.","x-example":"myPa$$word1"},"resourceType":{"type":"string","description":"Service to which the variable belongs. Possible values are \"project\", \"function\"","x-example":"function"},"resourceId":{"type":"string","description":"ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.","x-example":"myAwesomeFunction"}},"required":["$id","$createdAt","$updatedAt","key","value","resourceType","resourceId"]},"country":{"description":"Country","type":"object","properties":{"name":{"type":"string","description":"Country name.","x-example":"United States"},"code":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"}},"required":["name","code"]},"continent":{"description":"Continent","type":"object","properties":{"name":{"type":"string","description":"Continent name.","x-example":"Europe"},"code":{"type":"string","description":"Continent two letter code.","x-example":"EU"}},"required":["name","code"]},"language":{"description":"Language","type":"object","properties":{"name":{"type":"string","description":"Language name.","x-example":"Italian"},"code":{"type":"string","description":"Language two-character ISO 639-1 codes.","x-example":"it"},"nativeName":{"type":"string","description":"Language native name.","x-example":"Italiano"}},"required":["name","code","nativeName"]},"currency":{"description":"Currency","type":"object","properties":{"symbol":{"type":"string","description":"Currency symbol.","x-example":"$"},"name":{"type":"string","description":"Currency name.","x-example":"US dollar"},"symbolNative":{"type":"string","description":"Currency native symbol.","x-example":"$"},"decimalDigits":{"type":"integer","description":"Number of decimal digits.","x-example":2,"format":"int32"},"rounding":{"type":"number","description":"Currency digit rounding.","x-example":0,"format":"double"},"code":{"type":"string","description":"Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.","x-example":"USD"},"namePlural":{"type":"string","description":"Currency plural name","x-example":"US dollars"}},"required":["symbol","name","symbolNative","decimalDigits","rounding","code","namePlural"]},"phone":{"description":"Phone","type":"object","properties":{"code":{"type":"string","description":"Phone code.","x-example":"+1"},"countryCode":{"type":"string","description":"Country two-character ISO 3166-1 alpha code.","x-example":"US"},"countryName":{"type":"string","description":"Country name.","x-example":"United States"}},"required":["code","countryCode","countryName"]},"healthAntivirus":{"description":"Health Antivirus","type":"object","properties":{"version":{"type":"string","description":"Antivirus version.","x-example":"1.0.0"},"status":{"type":"string","description":"Antivirus status. Possible values can are: `disabled`, `offline`, `online`","x-example":"online"}},"required":["version","status"]},"healthQueue":{"description":"Health Queue","type":"object","properties":{"size":{"type":"integer","description":"Amount of actions in the queue.","x-example":8,"format":"int32"}},"required":["size"]},"healthStatus":{"description":"Health Status","type":"object","properties":{"name":{"type":"string","description":"Name of the service.","x-example":"database"},"ping":{"type":"integer","description":"Duration in milliseconds how long the health check took.","x-example":128,"format":"int32"},"status":{"type":"string","description":"Service status. Possible values can are: `pass`, `fail`","x-example":"pass"}},"required":["name","ping","status"]},"healthCertificate":{"description":"Health Certificate","type":"object","properties":{"name":{"type":"string","description":"Certificate name","x-example":"\/CN=www.google.com"},"subjectSN":{"type":"string","description":"Subject SN","x-example":""},"issuerOrganisation":{"type":"string","description":"Issuer organisation","x-example":""},"validFrom":{"type":"string","description":"Valid from","x-example":"1704200998"},"validTo":{"type":"string","description":"Valid to","x-example":"1711458597"},"signatureTypeSN":{"type":"string","description":"Signature type SN","x-example":"RSA-SHA256"}},"required":["name","subjectSN","issuerOrganisation","validFrom","validTo","signatureTypeSN"]},"healthTime":{"description":"Health Time","type":"object","properties":{"remoteTime":{"type":"integer","description":"Current unix timestamp on trustful remote server.","x-example":1639490751,"format":"int32"},"localTime":{"type":"integer","description":"Current unix timestamp of local server where Appwrite runs.","x-example":1639490844,"format":"int32"},"diff":{"type":"integer","description":"Difference of unix remote and local timestamps in milliseconds.","x-example":93,"format":"int32"}},"required":["remoteTime","localTime","diff"]},"headers":{"description":"Headers","type":"object","properties":{"name":{"type":"string","description":"Header name.","x-example":"Content-Type"},"value":{"type":"string","description":"Header value.","x-example":"application\/json"}},"required":["name","value"]},"mfaChallenge":{"description":"MFA Challenge","type":"object","properties":{"$id":{"type":"string","description":"Token ID.","x-example":"bb8ea5c16897e"},"$createdAt":{"type":"string","description":"Token creation date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"userId":{"type":"string","description":"User ID.","x-example":"5e5ea5c168bb8"},"expire":{"type":"string","description":"Token expiration date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"}},"required":["$id","$createdAt","userId","expire"]},"mfaRecoveryCodes":{"description":"MFA Recovery Codes","type":"object","properties":{"recoveryCodes":{"type":"array","description":"Recovery codes.","items":{"type":"string"},"x-example":["a3kf0-s0cl2","s0co1-as98s"]}},"required":["recoveryCodes"]},"mfaType":{"description":"MFAType","type":"object","properties":{"secret":{"type":"string","description":"Secret token used for TOTP factor.","x-example":true},"uri":{"type":"string","description":"URI for authenticator apps.","x-example":true}},"required":["secret","uri"]},"mfaFactors":{"description":"MFAFactors","type":"object","properties":{"totp":{"type":"boolean","description":"Can TOTP be used for MFA challenge for this account.","x-example":true},"phone":{"type":"boolean","description":"Can phone (SMS) be used for MFA challenge for this account.","x-example":true},"email":{"type":"boolean","description":"Can email be used for MFA challenge for this account.","x-example":true},"recoveryCode":{"type":"boolean","description":"Can recovery code be used for MFA challenge for this account.","x-example":true}},"required":["totp","phone","email","recoveryCode"]},"provider":{"description":"Provider","type":"object","properties":{"$id":{"type":"string","description":"Provider ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Provider creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Provider update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name for the provider instance.","x-example":"Mailgun"},"provider":{"type":"string","description":"The name of the provider service.","x-example":"mailgun"},"enabled":{"type":"boolean","description":"Is provider enabled?","x-example":true},"type":{"type":"string","description":"Type of provider.","x-example":"sms"},"credentials":{"type":"object","additionalProperties":true,"description":"Provider credentials.","x-example":{"key":"123456789"}},"options":{"type":"object","additionalProperties":true,"description":"Provider options.","x-example":{"from":"sender-email@mydomain"}}},"required":["$id","$createdAt","$updatedAt","name","provider","enabled","type","credentials"]},"message":{"description":"Message","type":"object","properties":{"$id":{"type":"string","description":"Message ID.","x-example":"5e5ea5c16897e"},"$createdAt":{"type":"string","description":"Message creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Message update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"providerType":{"type":"string","description":"Message provider type.","x-example":"email"},"topics":{"type":"array","description":"Topic IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"users":{"type":"array","description":"User IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"targets":{"type":"array","description":"Target IDs set as recipients.","items":{"type":"string"},"x-example":["5e5ea5c16897e"]},"scheduledAt":{"type":"string","description":"The scheduled time for message.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveredAt":{"type":"string","description":"The time when the message was delivered.","x-example":"2020-10-15T06:38:00.000+00:00","x-nullable":true},"deliveryErrors":{"type":"array","description":"Delivery errors if any.","items":{"type":"string"},"x-example":["Failed to send message to target 5e5ea5c16897e: Credentials not valid."],"x-nullable":true},"deliveredTotal":{"type":"integer","description":"Number of recipients the message was delivered to.","x-example":1,"format":"int32"},"data":{"type":"object","additionalProperties":true,"description":"Data of the message.","x-example":{"subject":"Welcome to Appwrite","content":"Hi there, welcome to Appwrite family."}},"status":{"type":"string","description":"Status of delivery.","x-example":"Message status can be one of the following: draft, processing, scheduled, sent, or failed."}},"required":["$id","$createdAt","$updatedAt","providerType","topics","users","targets","deliveredTotal","data","status"]},"topic":{"description":"Topic","type":"object","properties":{"$id":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Topic creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Topic update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"The name of the topic.","x-example":"events"},"emailTotal":{"type":"integer","description":"Total count of email subscribers subscribed to the topic.","x-example":100,"format":"int32"},"smsTotal":{"type":"integer","description":"Total count of SMS subscribers subscribed to the topic.","x-example":100,"format":"int32"},"pushTotal":{"type":"integer","description":"Total count of push subscribers subscribed to the topic.","x-example":100,"format":"int32"},"subscribe":{"type":"array","description":"Subscribe permissions.","items":{"type":"string"},"x-example":"users"}},"required":["$id","$createdAt","$updatedAt","name","emailTotal","smsTotal","pushTotal","subscribe"]},"subscriber":{"description":"Subscriber","type":"object","properties":{"$id":{"type":"string","description":"Subscriber ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Subscriber creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Subscriber update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"targetId":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"target":{"type":"object","description":"Target.","x-example":{"$id":"259125845563242502","$createdAt":"2020-10-15T06:38:00.000+00:00","$updatedAt":"2020-10-15T06:38:00.000+00:00","providerType":"email","providerId":"259125845563242502","name":"ageon-app-email","identifier":"random-mail@email.org","userId":"5e5ea5c16897e"},"items":{"type":"object","$ref":"#\/definitions\/target"}},"userId":{"type":"string","description":"Topic ID.","x-example":"5e5ea5c16897e"},"userName":{"type":"string","description":"User Name.","x-example":"Aegon Targaryen"},"topicId":{"type":"string","description":"Topic ID.","x-example":"259125845563242502"},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"}},"required":["$id","$createdAt","$updatedAt","targetId","target","userId","userName","topicId","providerType"]},"target":{"description":"Target","type":"object","properties":{"$id":{"type":"string","description":"Target ID.","x-example":"259125845563242502"},"$createdAt":{"type":"string","description":"Target creation time in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"$updatedAt":{"type":"string","description":"Target update date in ISO 8601 format.","x-example":"2020-10-15T06:38:00.000+00:00"},"name":{"type":"string","description":"Target Name.","x-example":"Aegon apple token"},"userId":{"type":"string","description":"User ID.","x-example":"259125845563242502"},"providerId":{"type":"string","description":"Provider ID.","x-example":"259125845563242502","x-nullable":true},"providerType":{"type":"string","description":"The target provider type. Can be one of the following: `email`, `sms` or `push`.","x-example":"email"},"identifier":{"type":"string","description":"The target identifier.","x-example":"token"}},"required":["$id","$createdAt","$updatedAt","name","userId","providerType","identifier"]}},"externalDocs":{"description":"Full API docs, specs and tutorials","url":"https:\/\/appwrite.io\/docs"}} \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/java/account/create-anonymous-session.md b/docs/examples/1.6.x/client-android/java/account/create-anonymous-session.md new file mode 100644 index 0000000000..5475d1bbd4 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-anonymous-session.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createAnonymousSession(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/create-email-password-session.md b/docs/examples/1.6.x/client-android/java/account/create-email-password-session.md new file mode 100644 index 0000000000..f4c59eb130 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-email-password-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createEmailPasswordSession( + "email@example.com", // email + "password", // password + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create-email-token.md b/docs/examples/1.6.x/client-android/java/account/create-email-token.md new file mode 100644 index 0000000000..d1b91c9419 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-email-token.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createEmailToken( + "<USER_ID>", // userId + "email@example.com", // email + false, // phrase (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create-j-w-t.md b/docs/examples/1.6.x/client-android/java/account/create-j-w-t.md new file mode 100644 index 0000000000..481259e68c --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-j-w-t.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createJWT(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-android/java/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..3c91e9bf7e --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-magic-u-r-l-token.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createMagicURLToken( + "<USER_ID>", // userId + "email@example.com", // email + "https://example.com", // url (optional) + false, // phrase (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-android/java/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..35ec26cfb5 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-mfa-authenticator.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; +import io.appwrite.enums.AuthenticatorType; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createMfaAuthenticator( + AuthenticatorType.TOTP, // type + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-android/java/account/create-mfa-challenge.md new file mode 100644 index 0000000000..f930b566de --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-mfa-challenge.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; +import io.appwrite.enums.AuthenticationFactor; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createMfaChallenge( + AuthenticationFactor.EMAIL, // factor + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/java/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..48f8582e96 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-mfa-recovery-codes.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/create-o-auth2session.md b/docs/examples/1.6.x/client-android/java/account/create-o-auth2session.md new file mode 100644 index 0000000000..fafd8e1753 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-o-auth2session.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; +import io.appwrite.enums.OAuthProvider; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createOAuth2Session( + OAuthProvider.AMAZON, // provider + "https://example.com", // success (optional) + "https://example.com", // failure (optional) + listOf(), // scopes (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create-o-auth2token.md b/docs/examples/1.6.x/client-android/java/account/create-o-auth2token.md new file mode 100644 index 0000000000..72fe76e6d7 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-o-auth2token.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; +import io.appwrite.enums.OAuthProvider; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createOAuth2Token( + OAuthProvider.AMAZON, // provider + "https://example.com", // success (optional) + "https://example.com", // failure (optional) + listOf(), // scopes (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create-phone-token.md b/docs/examples/1.6.x/client-android/java/account/create-phone-token.md new file mode 100644 index 0000000000..92eeee8603 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-phone-token.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createPhoneToken( + "<USER_ID>", // userId + "+12065550100", // phone + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create-phone-verification.md b/docs/examples/1.6.x/client-android/java/account/create-phone-verification.md new file mode 100644 index 0000000000..c560065a05 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-phone-verification.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createPhoneVerification(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/create-push-target.md b/docs/examples/1.6.x/client-android/java/account/create-push-target.md new file mode 100644 index 0000000000..127aec0506 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-push-target.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createPushTarget( + "<TARGET_ID>", // targetId + "<IDENTIFIER>", // identifier + "<PROVIDER_ID>", // providerId (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create-recovery.md b/docs/examples/1.6.x/client-android/java/account/create-recovery.md new file mode 100644 index 0000000000..09f8fb9959 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-recovery.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createRecovery( + "email@example.com", // email + "https://example.com", // url + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create-session.md b/docs/examples/1.6.x/client-android/java/account/create-session.md new file mode 100644 index 0000000000..f54f57cc39 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createSession( + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create-verification.md b/docs/examples/1.6.x/client-android/java/account/create-verification.md new file mode 100644 index 0000000000..c52ee2bf3a --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create-verification.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createVerification( + "https://example.com", // url + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/create.md b/docs/examples/1.6.x/client-android/java/account/create.md new file mode 100644 index 0000000000..15d9b73f1d --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/create.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.create( + "<USER_ID>", // userId + "email@example.com", // email + "", // password + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/delete-identity.md b/docs/examples/1.6.x/client-android/java/account/delete-identity.md new file mode 100644 index 0000000000..a84f57b263 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/delete-identity.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.deleteIdentity( + "<IDENTITY_ID>", // identityId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-android/java/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..b7c7442270 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/delete-mfa-authenticator.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; +import io.appwrite.enums.AuthenticatorType; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.deleteMfaAuthenticator( + AuthenticatorType.TOTP, // type + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/delete-push-target.md b/docs/examples/1.6.x/client-android/java/account/delete-push-target.md new file mode 100644 index 0000000000..0b51801855 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/delete-push-target.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.deletePushTarget( + "<TARGET_ID>", // targetId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/delete-session.md b/docs/examples/1.6.x/client-android/java/account/delete-session.md new file mode 100644 index 0000000000..602752ec7d --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/delete-session.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.deleteSession( + "<SESSION_ID>", // sessionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/delete-sessions.md b/docs/examples/1.6.x/client-android/java/account/delete-sessions.md new file mode 100644 index 0000000000..8c48aaf1ec --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/delete-sessions.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.deleteSessions(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/java/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..f42101c5d4 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/get-mfa-recovery-codes.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.getMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/get-prefs.md b/docs/examples/1.6.x/client-android/java/account/get-prefs.md new file mode 100644 index 0000000000..6a40dc7c4a --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/get-prefs.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.getPrefs(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/get-session.md b/docs/examples/1.6.x/client-android/java/account/get-session.md new file mode 100644 index 0000000000..912a52dcb0 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/get-session.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.getSession( + "<SESSION_ID>", // sessionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/get.md b/docs/examples/1.6.x/client-android/java/account/get.md new file mode 100644 index 0000000000..9a99a755ae --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/get.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.get(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/list-identities.md b/docs/examples/1.6.x/client-android/java/account/list-identities.md new file mode 100644 index 0000000000..38ccc92562 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/list-identities.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.listIdentities( + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/list-logs.md b/docs/examples/1.6.x/client-android/java/account/list-logs.md new file mode 100644 index 0000000000..7f39d843f2 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/list-logs.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.listLogs( + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/list-mfa-factors.md b/docs/examples/1.6.x/client-android/java/account/list-mfa-factors.md new file mode 100644 index 0000000000..f5319880d1 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/list-mfa-factors.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.listMfaFactors(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/list-sessions.md b/docs/examples/1.6.x/client-android/java/account/list-sessions.md new file mode 100644 index 0000000000..6571458d97 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/list-sessions.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.listSessions(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/update-email.md b/docs/examples/1.6.x/client-android/java/account/update-email.md new file mode 100644 index 0000000000..5e99b73045 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-email.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateEmail( + "email@example.com", // email + "password", // password + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-m-f-a.md b/docs/examples/1.6.x/client-android/java/account/update-m-f-a.md new file mode 100644 index 0000000000..f8420b0ccb --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-m-f-a.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateMFA( + false, // mfa + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-android/java/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..1d408270cb --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-magic-u-r-l-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateMagicURLSession( + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-android/java/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..09506e5ca5 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-mfa-authenticator.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; +import io.appwrite.enums.AuthenticatorType; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateMfaAuthenticator( + AuthenticatorType.TOTP, // type + "<OTP>", // otp + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-android/java/account/update-mfa-challenge.md new file mode 100644 index 0000000000..9fc3e39c36 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-mfa-challenge.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateMfaChallenge( + "<CHALLENGE_ID>", // challengeId + "<OTP>", // otp + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/java/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..36795a05ab --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-mfa-recovery-codes.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/update-name.md b/docs/examples/1.6.x/client-android/java/account/update-name.md new file mode 100644 index 0000000000..f9a018503f --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-name.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateName( + "<NAME>", // name + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-password.md b/docs/examples/1.6.x/client-android/java/account/update-password.md new file mode 100644 index 0000000000..676caad9ce --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-password.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updatePassword( + "", // password + "password", // oldPassword (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-phone-session.md b/docs/examples/1.6.x/client-android/java/account/update-phone-session.md new file mode 100644 index 0000000000..5f9e43300a --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-phone-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updatePhoneSession( + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-phone-verification.md b/docs/examples/1.6.x/client-android/java/account/update-phone-verification.md new file mode 100644 index 0000000000..739b6d88f4 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-phone-verification.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updatePhoneVerification( + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-phone.md b/docs/examples/1.6.x/client-android/java/account/update-phone.md new file mode 100644 index 0000000000..adbb0982fe --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-phone.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updatePhone( + "+12065550100", // phone + "password", // password + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-prefs.md b/docs/examples/1.6.x/client-android/java/account/update-prefs.md new file mode 100644 index 0000000000..ad42651c8e --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-prefs.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updatePrefs( + mapOf( "a" to "b" ), // prefs + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-push-target.md b/docs/examples/1.6.x/client-android/java/account/update-push-target.md new file mode 100644 index 0000000000..735757202d --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-push-target.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updatePushTarget( + "<TARGET_ID>", // targetId + "<IDENTIFIER>", // identifier + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-recovery.md b/docs/examples/1.6.x/client-android/java/account/update-recovery.md new file mode 100644 index 0000000000..f8067d09cf --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-recovery.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateRecovery( + "<USER_ID>", // userId + "<SECRET>", // secret + "", // password + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-session.md b/docs/examples/1.6.x/client-android/java/account/update-session.md new file mode 100644 index 0000000000..2b6df41bbc --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-session.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateSession( + "<SESSION_ID>", // sessionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/account/update-status.md b/docs/examples/1.6.x/client-android/java/account/update-status.md new file mode 100644 index 0000000000..38cf5cfdf9 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-status.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateStatus(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/account/update-verification.md b/docs/examples/1.6.x/client-android/java/account/update-verification.md new file mode 100644 index 0000000000..8cfbbb69d7 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/account/update-verification.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateVerification( + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-browser.md b/docs/examples/1.6.x/client-android/java/avatars/get-browser.md new file mode 100644 index 0000000000..a11df7e31b --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/avatars/get-browser.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; +import io.appwrite.enums.Browser; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Avatars avatars = new Avatars(client); + +avatars.getBrowser( + Browser.AVANT_BROWSER, // code + 0, // width (optional) + 0, // height (optional) + 0, // quality (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-credit-card.md b/docs/examples/1.6.x/client-android/java/avatars/get-credit-card.md new file mode 100644 index 0000000000..f1e2b392da --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/avatars/get-credit-card.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; +import io.appwrite.enums.CreditCard; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Avatars avatars = new Avatars(client); + +avatars.getCreditCard( + CreditCard.AMERICAN_EXPRESS, // code + 0, // width (optional) + 0, // height (optional) + 0, // quality (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-favicon.md b/docs/examples/1.6.x/client-android/java/avatars/get-favicon.md new file mode 100644 index 0000000000..5cfd60b86a --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/avatars/get-favicon.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Avatars avatars = new Avatars(client); + +avatars.getFavicon( + "https://example.com", // url + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-flag.md b/docs/examples/1.6.x/client-android/java/avatars/get-flag.md new file mode 100644 index 0000000000..492ecc0410 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/avatars/get-flag.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; +import io.appwrite.enums.Flag; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Avatars avatars = new Avatars(client); + +avatars.getFlag( + Flag.AFGHANISTAN, // code + 0, // width (optional) + 0, // height (optional) + 0, // quality (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-image.md b/docs/examples/1.6.x/client-android/java/avatars/get-image.md new file mode 100644 index 0000000000..4fc1e35f35 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/avatars/get-image.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Avatars avatars = new Avatars(client); + +avatars.getImage( + "https://example.com", // url + 0, // width (optional) + 0, // height (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-initials.md b/docs/examples/1.6.x/client-android/java/avatars/get-initials.md new file mode 100644 index 0000000000..9b286089ed --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/avatars/get-initials.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Avatars avatars = new Avatars(client); + +avatars.getInitials( + "<NAME>", // name (optional) + 0, // width (optional) + 0, // height (optional) + "", // background (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-q-r.md b/docs/examples/1.6.x/client-android/java/avatars/get-q-r.md new file mode 100644 index 0000000000..29446d54d7 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/avatars/get-q-r.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Avatars avatars = new Avatars(client); + +avatars.getQR( + "<TEXT>", // text + 1, // size (optional) + 0, // margin (optional) + false, // download (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/databases/create-document.md b/docs/examples/1.6.x/client-android/java/databases/create-document.md new file mode 100644 index 0000000000..87d33bdc60 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/databases/create-document.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Databases databases = new Databases(client); + +databases.createDocument( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "<DOCUMENT_ID>", // documentId + mapOf( "a" to "b" ), // data + listOf("read("any")"), // permissions (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/databases/delete-document.md b/docs/examples/1.6.x/client-android/java/databases/delete-document.md new file mode 100644 index 0000000000..2fb3accf32 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/databases/delete-document.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Databases databases = new Databases(client); + +databases.deleteDocument( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "<DOCUMENT_ID>", // documentId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/databases/get-document.md b/docs/examples/1.6.x/client-android/java/databases/get-document.md new file mode 100644 index 0000000000..0edce73467 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/databases/get-document.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Databases databases = new Databases(client); + +databases.getDocument( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "<DOCUMENT_ID>", // documentId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/databases/list-documents.md b/docs/examples/1.6.x/client-android/java/databases/list-documents.md new file mode 100644 index 0000000000..f256e1413c --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/databases/list-documents.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Databases databases = new Databases(client); + +databases.listDocuments( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/databases/update-document.md b/docs/examples/1.6.x/client-android/java/databases/update-document.md new file mode 100644 index 0000000000..16f89df2c8 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/databases/update-document.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Databases databases = new Databases(client); + +databases.updateDocument( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "<DOCUMENT_ID>", // documentId + mapOf( "a" to "b" ), // data (optional) + listOf("read("any")"), // permissions (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/functions/create-execution.md b/docs/examples/1.6.x/client-android/java/functions/create-execution.md new file mode 100644 index 0000000000..5d4cc4d3bf --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/functions/create-execution.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Functions functions = new Functions(client); + +functions.createExecution( + "<FUNCTION_ID>", // functionId + "<BODY>", // body (optional) + false, // async (optional) + "<PATH>", // path (optional) + ExecutionMethod.GET, // method (optional) + mapOf( "a" to "b" ), // headers (optional) + "", // scheduledAt (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/functions/get-execution.md b/docs/examples/1.6.x/client-android/java/functions/get-execution.md new file mode 100644 index 0000000000..82314451cb --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/functions/get-execution.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Functions functions = new Functions(client); + +functions.getExecution( + "<FUNCTION_ID>", // functionId + "<EXECUTION_ID>", // executionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/functions/list-executions.md b/docs/examples/1.6.x/client-android/java/functions/list-executions.md new file mode 100644 index 0000000000..ac793fa789 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/functions/list-executions.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Functions functions = new Functions(client); + +functions.listExecutions( + "<FUNCTION_ID>", // functionId + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/graphql/mutation.md b/docs/examples/1.6.x/client-android/java/graphql/mutation.md new file mode 100644 index 0000000000..5e49fcb848 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/graphql/mutation.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Graphql; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Graphql graphql = new Graphql(client); + +graphql.mutation( + mapOf( "a" to "b" ), // query + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/graphql/query.md b/docs/examples/1.6.x/client-android/java/graphql/query.md new file mode 100644 index 0000000000..2d39c167c7 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/graphql/query.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Graphql; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Graphql graphql = new Graphql(client); + +graphql.query( + mapOf( "a" to "b" ), // query + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/locale/get.md b/docs/examples/1.6.x/client-android/java/locale/get.md new file mode 100644 index 0000000000..4883b2191a --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/locale/get.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Locale locale = new Locale(client); + +locale.get(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-codes.md b/docs/examples/1.6.x/client-android/java/locale/list-codes.md new file mode 100644 index 0000000000..caddf6c6f6 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/locale/list-codes.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Locale locale = new Locale(client); + +locale.listCodes(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-continents.md b/docs/examples/1.6.x/client-android/java/locale/list-continents.md new file mode 100644 index 0000000000..634f471d77 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/locale/list-continents.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Locale locale = new Locale(client); + +locale.listContinents(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-android/java/locale/list-countries-e-u.md new file mode 100644 index 0000000000..798ea3464b --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/locale/list-countries-e-u.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Locale locale = new Locale(client); + +locale.listCountriesEU(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-countries-phones.md b/docs/examples/1.6.x/client-android/java/locale/list-countries-phones.md new file mode 100644 index 0000000000..08285470f3 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/locale/list-countries-phones.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Locale locale = new Locale(client); + +locale.listCountriesPhones(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-countries.md b/docs/examples/1.6.x/client-android/java/locale/list-countries.md new file mode 100644 index 0000000000..b56ab5c5c3 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/locale/list-countries.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Locale locale = new Locale(client); + +locale.listCountries(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-currencies.md b/docs/examples/1.6.x/client-android/java/locale/list-currencies.md new file mode 100644 index 0000000000..ab014b5f95 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/locale/list-currencies.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Locale locale = new Locale(client); + +locale.listCurrencies(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-languages.md b/docs/examples/1.6.x/client-android/java/locale/list-languages.md new file mode 100644 index 0000000000..8ef5723a5d --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/locale/list-languages.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Locale locale = new Locale(client); + +locale.listLanguages(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); +})); diff --git a/docs/examples/1.6.x/client-android/java/messaging/create-subscriber.md b/docs/examples/1.6.x/client-android/java/messaging/create-subscriber.md new file mode 100644 index 0000000000..d1ea18b5e4 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/messaging/create-subscriber.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Messaging messaging = new Messaging(client); + +messaging.createSubscriber( + "<TOPIC_ID>", // topicId + "<SUBSCRIBER_ID>", // subscriberId + "<TARGET_ID>", // targetId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-android/java/messaging/delete-subscriber.md new file mode 100644 index 0000000000..5fa1b57955 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/messaging/delete-subscriber.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Messaging messaging = new Messaging(client); + +messaging.deleteSubscriber( + "<TOPIC_ID>", // topicId + "<SUBSCRIBER_ID>", // subscriberId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/storage/create-file.md b/docs/examples/1.6.x/client-android/java/storage/create-file.md new file mode 100644 index 0000000000..716ef6ca39 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/storage/create-file.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.models.InputFile; +import io.appwrite.services.Storage; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Storage storage = new Storage(client); + +storage.createFile( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + InputFile.fromPath("file.png"), // file + listOf("read("any")"), // permissions (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/storage/delete-file.md b/docs/examples/1.6.x/client-android/java/storage/delete-file.md new file mode 100644 index 0000000000..e4b4a2bfbe --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/storage/delete-file.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Storage storage = new Storage(client); + +storage.deleteFile( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/storage/get-file-download.md b/docs/examples/1.6.x/client-android/java/storage/get-file-download.md new file mode 100644 index 0000000000..304bbfea96 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/storage/get-file-download.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Storage storage = new Storage(client); + +storage.getFileDownload( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/storage/get-file-preview.md b/docs/examples/1.6.x/client-android/java/storage/get-file-preview.md new file mode 100644 index 0000000000..267b16f4e7 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/storage/get-file-preview.md @@ -0,0 +1,34 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Storage storage = new Storage(client); + +storage.getFilePreview( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + 0, // width (optional) + 0, // height (optional) + ImageGravity.CENTER, // gravity (optional) + 0, // quality (optional) + 0, // borderWidth (optional) + "", // borderColor (optional) + 0, // borderRadius (optional) + 0, // opacity (optional) + -360, // rotation (optional) + "", // background (optional) + ImageFormat.JPG, // output (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/storage/get-file-view.md b/docs/examples/1.6.x/client-android/java/storage/get-file-view.md new file mode 100644 index 0000000000..ae40098548 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/storage/get-file-view.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Storage storage = new Storage(client); + +storage.getFileView( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/storage/get-file.md b/docs/examples/1.6.x/client-android/java/storage/get-file.md new file mode 100644 index 0000000000..86118c04d5 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/storage/get-file.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Storage storage = new Storage(client); + +storage.getFile( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/storage/list-files.md b/docs/examples/1.6.x/client-android/java/storage/list-files.md new file mode 100644 index 0000000000..3ef0aceb46 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/storage/list-files.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Storage storage = new Storage(client); + +storage.listFiles( + "<BUCKET_ID>", // bucketId + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/storage/update-file.md b/docs/examples/1.6.x/client-android/java/storage/update-file.md new file mode 100644 index 0000000000..6a90a6170b --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/storage/update-file.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Storage storage = new Storage(client); + +storage.updateFile( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + "<NAME>", // name (optional) + listOf("read("any")"), // permissions (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/create-membership.md b/docs/examples/1.6.x/client-android/java/teams/create-membership.md new file mode 100644 index 0000000000..bca117a452 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/create-membership.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.createMembership( + "<TEAM_ID>", // teamId + listOf(), // roles + "email@example.com", // email (optional) + "<USER_ID>", // userId (optional) + "+12065550100", // phone (optional) + "https://example.com", // url (optional) + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/create.md b/docs/examples/1.6.x/client-android/java/teams/create.md new file mode 100644 index 0000000000..6644e24580 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/create.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.create( + "<TEAM_ID>", // teamId + "<NAME>", // name + listOf(), // roles (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/delete-membership.md b/docs/examples/1.6.x/client-android/java/teams/delete-membership.md new file mode 100644 index 0000000000..953f4615d7 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/delete-membership.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.deleteMembership( + "<TEAM_ID>", // teamId + "<MEMBERSHIP_ID>", // membershipId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/delete.md b/docs/examples/1.6.x/client-android/java/teams/delete.md new file mode 100644 index 0000000000..d4b6076903 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/delete.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.delete( + "<TEAM_ID>", // teamId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/get-membership.md b/docs/examples/1.6.x/client-android/java/teams/get-membership.md new file mode 100644 index 0000000000..425e6f3028 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/get-membership.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.getMembership( + "<TEAM_ID>", // teamId + "<MEMBERSHIP_ID>", // membershipId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/get-prefs.md b/docs/examples/1.6.x/client-android/java/teams/get-prefs.md new file mode 100644 index 0000000000..a36be581c6 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/get-prefs.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.getPrefs( + "<TEAM_ID>", // teamId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/get.md b/docs/examples/1.6.x/client-android/java/teams/get.md new file mode 100644 index 0000000000..7ecfbab1cb --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/get.md @@ -0,0 +1,22 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.get( + "<TEAM_ID>", // teamId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/list-memberships.md b/docs/examples/1.6.x/client-android/java/teams/list-memberships.md new file mode 100644 index 0000000000..6a7e056d72 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/list-memberships.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.listMemberships( + "<TEAM_ID>", // teamId + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/list.md b/docs/examples/1.6.x/client-android/java/teams/list.md new file mode 100644 index 0000000000..94b65d6909 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/list.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.list( + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/update-membership-status.md b/docs/examples/1.6.x/client-android/java/teams/update-membership-status.md new file mode 100644 index 0000000000..ffb722a07c --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/update-membership-status.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.updateMembershipStatus( + "<TEAM_ID>", // teamId + "<MEMBERSHIP_ID>", // membershipId + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/update-membership.md b/docs/examples/1.6.x/client-android/java/teams/update-membership.md new file mode 100644 index 0000000000..478a94d6db --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/update-membership.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.updateMembership( + "<TEAM_ID>", // teamId + "<MEMBERSHIP_ID>", // membershipId + listOf(), // roles + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/update-name.md b/docs/examples/1.6.x/client-android/java/teams/update-name.md new file mode 100644 index 0000000000..219bece350 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/update-name.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.updateName( + "<TEAM_ID>", // teamId + "<NAME>", // name + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/java/teams/update-prefs.md b/docs/examples/1.6.x/client-android/java/teams/update-prefs.md new file mode 100644 index 0000000000..e4fb344d18 --- /dev/null +++ b/docs/examples/1.6.x/client-android/java/teams/update-prefs.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Teams teams = new Teams(client); + +teams.updatePrefs( + "<TEAM_ID>", // teamId + mapOf( "a" to "b" ), // prefs + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + Log.d("Appwrite", result.toString()); + }) +); + diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-anonymous-session.md b/docs/examples/1.6.x/client-android/kotlin/account/create-anonymous-session.md new file mode 100644 index 0000000000..6731b6c067 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-anonymous-session.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createAnonymousSession() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-email-password-session.md b/docs/examples/1.6.x/client-android/kotlin/account/create-email-password-session.md new file mode 100644 index 0000000000..88123a5c96 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-email-password-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createEmailPasswordSession( + email = "email@example.com", + password = "password", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-email-token.md b/docs/examples/1.6.x/client-android/kotlin/account/create-email-token.md new file mode 100644 index 0000000000..adaa5eb7e6 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-email-token.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createEmailToken( + userId = "<USER_ID>", + email = "email@example.com", + phrase = false, // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-j-w-t.md b/docs/examples/1.6.x/client-android/kotlin/account/create-j-w-t.md new file mode 100644 index 0000000000..34e6b1ae51 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-j-w-t.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createJWT() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-android/kotlin/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..10c9427f5e --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-magic-u-r-l-token.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createMagicURLToken( + userId = "<USER_ID>", + email = "email@example.com", + url = "https://example.com", // (optional) + phrase = false, // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..2b60be3878 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-authenticator.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account +import io.appwrite.enums.AuthenticatorType + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createMfaAuthenticator( + type = AuthenticatorType.TOTP, +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-challenge.md new file mode 100644 index 0000000000..f7554de2fc --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-challenge.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account +import io.appwrite.enums.AuthenticationFactor + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createMfaChallenge( + factor = AuthenticationFactor.EMAIL, +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..5618b3baa4 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2session.md b/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2session.md new file mode 100644 index 0000000000..e2aebc9c88 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2session.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account +import io.appwrite.enums.OAuthProvider + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +account.createOAuth2Session( + provider = OAuthProvider.AMAZON, + success = "https://example.com", // (optional) + failure = "https://example.com", // (optional) + scopes = listOf(), // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2token.md b/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2token.md new file mode 100644 index 0000000000..71e58db6a3 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2token.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account +import io.appwrite.enums.OAuthProvider + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +account.createOAuth2Token( + provider = OAuthProvider.AMAZON, + success = "https://example.com", // (optional) + failure = "https://example.com", // (optional) + scopes = listOf(), // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-phone-token.md b/docs/examples/1.6.x/client-android/kotlin/account/create-phone-token.md new file mode 100644 index 0000000000..16e744c889 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-phone-token.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createPhoneToken( + userId = "<USER_ID>", + phone = "+12065550100", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-phone-verification.md b/docs/examples/1.6.x/client-android/kotlin/account/create-phone-verification.md new file mode 100644 index 0000000000..74a05a0187 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-phone-verification.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createPhoneVerification() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-push-target.md b/docs/examples/1.6.x/client-android/kotlin/account/create-push-target.md new file mode 100644 index 0000000000..80b8221112 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-push-target.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createPushTarget( + targetId = "<TARGET_ID>", + identifier = "<IDENTIFIER>", + providerId = "<PROVIDER_ID>", // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-recovery.md b/docs/examples/1.6.x/client-android/kotlin/account/create-recovery.md new file mode 100644 index 0000000000..9b4f0dbf1f --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-recovery.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createRecovery( + email = "email@example.com", + url = "https://example.com", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-session.md b/docs/examples/1.6.x/client-android/kotlin/account/create-session.md new file mode 100644 index 0000000000..8eab36b3bb --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createSession( + userId = "<USER_ID>", + secret = "<SECRET>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-verification.md b/docs/examples/1.6.x/client-android/kotlin/account/create-verification.md new file mode 100644 index 0000000000..5c2d869b98 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create-verification.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.createVerification( + url = "https://example.com", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create.md b/docs/examples/1.6.x/client-android/kotlin/account/create.md new file mode 100644 index 0000000000..27079085a2 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/create.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.create( + userId = "<USER_ID>", + email = "email@example.com", + password = "", + name = "<NAME>", // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/delete-identity.md b/docs/examples/1.6.x/client-android/kotlin/account/delete-identity.md new file mode 100644 index 0000000000..decb1b0402 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/delete-identity.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.deleteIdentity( + identityId = "<IDENTITY_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-android/kotlin/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..a9a9fd8eab --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/delete-mfa-authenticator.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account +import io.appwrite.enums.AuthenticatorType + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.deleteMfaAuthenticator( + type = AuthenticatorType.TOTP, +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/delete-push-target.md b/docs/examples/1.6.x/client-android/kotlin/account/delete-push-target.md new file mode 100644 index 0000000000..a1e5519b67 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/delete-push-target.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.deletePushTarget( + targetId = "<TARGET_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/delete-session.md b/docs/examples/1.6.x/client-android/kotlin/account/delete-session.md new file mode 100644 index 0000000000..4d49833c88 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/delete-session.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.deleteSession( + sessionId = "<SESSION_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/delete-sessions.md b/docs/examples/1.6.x/client-android/kotlin/account/delete-sessions.md new file mode 100644 index 0000000000..d8bf87189a --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/delete-sessions.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.deleteSessions() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/kotlin/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..bdd2908601 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/get-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.getMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/get-prefs.md b/docs/examples/1.6.x/client-android/kotlin/account/get-prefs.md new file mode 100644 index 0000000000..a4fefc5150 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/get-prefs.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.getPrefs() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/get-session.md b/docs/examples/1.6.x/client-android/kotlin/account/get-session.md new file mode 100644 index 0000000000..b18c532175 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/get-session.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.getSession( + sessionId = "<SESSION_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/get.md b/docs/examples/1.6.x/client-android/kotlin/account/get.md new file mode 100644 index 0000000000..1718bdd0c3 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/get.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.get() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/list-identities.md b/docs/examples/1.6.x/client-android/kotlin/account/list-identities.md new file mode 100644 index 0000000000..e553a88818 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/list-identities.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.listIdentities( + queries = listOf(), // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/list-logs.md b/docs/examples/1.6.x/client-android/kotlin/account/list-logs.md new file mode 100644 index 0000000000..2ee8214336 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/list-logs.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.listLogs( + queries = listOf(), // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/list-mfa-factors.md b/docs/examples/1.6.x/client-android/kotlin/account/list-mfa-factors.md new file mode 100644 index 0000000000..eddefdc88c --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/list-mfa-factors.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.listMfaFactors() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/list-sessions.md b/docs/examples/1.6.x/client-android/kotlin/account/list-sessions.md new file mode 100644 index 0000000000..b4841445d5 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/list-sessions.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.listSessions() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-email.md b/docs/examples/1.6.x/client-android/kotlin/account/update-email.md new file mode 100644 index 0000000000..b8f759f9eb --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-email.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updateEmail( + email = "email@example.com", + password = "password", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-m-f-a.md b/docs/examples/1.6.x/client-android/kotlin/account/update-m-f-a.md new file mode 100644 index 0000000000..8940cf4743 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-m-f-a.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updateMFA( + mfa = false, +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-android/kotlin/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..09029e4070 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-magic-u-r-l-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updateMagicURLSession( + userId = "<USER_ID>", + secret = "<SECRET>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..5889931a21 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-authenticator.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account +import io.appwrite.enums.AuthenticatorType + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updateMfaAuthenticator( + type = AuthenticatorType.TOTP, + otp = "<OTP>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-challenge.md new file mode 100644 index 0000000000..d63401b283 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-challenge.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updateMfaChallenge( + challengeId = "<CHALLENGE_ID>", + otp = "<OTP>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..69b41c9224 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updateMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-name.md b/docs/examples/1.6.x/client-android/kotlin/account/update-name.md new file mode 100644 index 0000000000..6658a1b3fc --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-name.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updateName( + name = "<NAME>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-password.md b/docs/examples/1.6.x/client-android/kotlin/account/update-password.md new file mode 100644 index 0000000000..fe3b8ceb06 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-password.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updatePassword( + password = "", + oldPassword = "password", // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-phone-session.md b/docs/examples/1.6.x/client-android/kotlin/account/update-phone-session.md new file mode 100644 index 0000000000..7414b2e0c0 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-phone-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updatePhoneSession( + userId = "<USER_ID>", + secret = "<SECRET>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-phone-verification.md b/docs/examples/1.6.x/client-android/kotlin/account/update-phone-verification.md new file mode 100644 index 0000000000..e1b264bbde --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-phone-verification.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updatePhoneVerification( + userId = "<USER_ID>", + secret = "<SECRET>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-phone.md b/docs/examples/1.6.x/client-android/kotlin/account/update-phone.md new file mode 100644 index 0000000000..c4ae4f5ea4 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-phone.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updatePhone( + phone = "+12065550100", + password = "password", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-prefs.md b/docs/examples/1.6.x/client-android/kotlin/account/update-prefs.md new file mode 100644 index 0000000000..62129a298e --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-prefs.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updatePrefs( + prefs = mapOf( "a" to "b" ), +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-push-target.md b/docs/examples/1.6.x/client-android/kotlin/account/update-push-target.md new file mode 100644 index 0000000000..8dfa97c767 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-push-target.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updatePushTarget( + targetId = "<TARGET_ID>", + identifier = "<IDENTIFIER>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-recovery.md b/docs/examples/1.6.x/client-android/kotlin/account/update-recovery.md new file mode 100644 index 0000000000..6c83496584 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-recovery.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updateRecovery( + userId = "<USER_ID>", + secret = "<SECRET>", + password = "", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-session.md b/docs/examples/1.6.x/client-android/kotlin/account/update-session.md new file mode 100644 index 0000000000..85dec29278 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-session.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updateSession( + sessionId = "<SESSION_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-status.md b/docs/examples/1.6.x/client-android/kotlin/account/update-status.md new file mode 100644 index 0000000000..4bf9faf07f --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-status.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updateStatus() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-verification.md b/docs/examples/1.6.x/client-android/kotlin/account/update-verification.md new file mode 100644 index 0000000000..4bd5459a6c --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/account/update-verification.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val result = account.updateVerification( + userId = "<USER_ID>", + secret = "<SECRET>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-browser.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-browser.md new file mode 100644 index 0000000000..6f2a45cd3f --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/avatars/get-browser.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars +import io.appwrite.enums.Browser + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val avatars = Avatars(client) + +val result = avatars.getBrowser( + code = Browser.AVANT_BROWSER, + width = 0, // (optional) + height = 0, // (optional) + quality = 0, // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-credit-card.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-credit-card.md new file mode 100644 index 0000000000..a85c8c8638 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/avatars/get-credit-card.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars +import io.appwrite.enums.CreditCard + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val avatars = Avatars(client) + +val result = avatars.getCreditCard( + code = CreditCard.AMERICAN_EXPRESS, + width = 0, // (optional) + height = 0, // (optional) + quality = 0, // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-favicon.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-favicon.md new file mode 100644 index 0000000000..eee47e1dca --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/avatars/get-favicon.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val avatars = Avatars(client) + +val result = avatars.getFavicon( + url = "https://example.com", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-flag.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-flag.md new file mode 100644 index 0000000000..0689ba13cd --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/avatars/get-flag.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars +import io.appwrite.enums.Flag + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val avatars = Avatars(client) + +val result = avatars.getFlag( + code = Flag.AFGHANISTAN, + width = 0, // (optional) + height = 0, // (optional) + quality = 0, // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-image.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-image.md new file mode 100644 index 0000000000..7042757e73 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/avatars/get-image.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val avatars = Avatars(client) + +val result = avatars.getImage( + url = "https://example.com", + width = 0, // (optional) + height = 0, // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-initials.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-initials.md new file mode 100644 index 0000000000..fd52a3b0a7 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/avatars/get-initials.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val avatars = Avatars(client) + +val result = avatars.getInitials( + name = "<NAME>", // (optional) + width = 0, // (optional) + height = 0, // (optional) + background = "", // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-q-r.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-q-r.md new file mode 100644 index 0000000000..3be18c159a --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/avatars/get-q-r.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val avatars = Avatars(client) + +val result = avatars.getQR( + text = "<TEXT>", + size = 1, // (optional) + margin = 0, // (optional) + download = false, // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/databases/create-document.md b/docs/examples/1.6.x/client-android/kotlin/databases/create-document.md new file mode 100644 index 0000000000..69c17efd1c --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/databases/create-document.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val databases = Databases(client) + +val result = databases.createDocument( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + documentId = "<DOCUMENT_ID>", + data = mapOf( "a" to "b" ), + permissions = listOf("read("any")"), // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/databases/delete-document.md b/docs/examples/1.6.x/client-android/kotlin/databases/delete-document.md new file mode 100644 index 0000000000..3733e2f28a --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/databases/delete-document.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val databases = Databases(client) + +val result = databases.deleteDocument( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + documentId = "<DOCUMENT_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/databases/get-document.md b/docs/examples/1.6.x/client-android/kotlin/databases/get-document.md new file mode 100644 index 0000000000..a11de0e6ce --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/databases/get-document.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val databases = Databases(client) + +val result = databases.getDocument( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + documentId = "<DOCUMENT_ID>", + queries = listOf(), // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/databases/list-documents.md b/docs/examples/1.6.x/client-android/kotlin/databases/list-documents.md new file mode 100644 index 0000000000..6615d443ac --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/databases/list-documents.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val databases = Databases(client) + +val result = databases.listDocuments( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + queries = listOf(), // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/databases/update-document.md b/docs/examples/1.6.x/client-android/kotlin/databases/update-document.md new file mode 100644 index 0000000000..5f9aab2c43 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/databases/update-document.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val databases = Databases(client) + +val result = databases.updateDocument( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + documentId = "<DOCUMENT_ID>", + data = mapOf( "a" to "b" ), // (optional) + permissions = listOf("read("any")"), // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/functions/create-execution.md b/docs/examples/1.6.x/client-android/kotlin/functions/create-execution.md new file mode 100644 index 0000000000..e4ddc6a7e5 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/functions/create-execution.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val functions = Functions(client) + +val result = functions.createExecution( + functionId = "<FUNCTION_ID>", + body = "<BODY>", // (optional) + async = false, // (optional) + path = "<PATH>", // (optional) + method = ExecutionMethod.GET, // (optional) + headers = mapOf( "a" to "b" ), // (optional) + scheduledAt = "", // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/functions/get-execution.md b/docs/examples/1.6.x/client-android/kotlin/functions/get-execution.md new file mode 100644 index 0000000000..6ca4bed8ad --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/functions/get-execution.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val functions = Functions(client) + +val result = functions.getExecution( + functionId = "<FUNCTION_ID>", + executionId = "<EXECUTION_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/functions/list-executions.md b/docs/examples/1.6.x/client-android/kotlin/functions/list-executions.md new file mode 100644 index 0000000000..4adc722a7e --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/functions/list-executions.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val functions = Functions(client) + +val result = functions.listExecutions( + functionId = "<FUNCTION_ID>", + queries = listOf(), // (optional) + search = "<SEARCH>", // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/graphql/mutation.md b/docs/examples/1.6.x/client-android/kotlin/graphql/mutation.md new file mode 100644 index 0000000000..2036e8e225 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/graphql/mutation.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Graphql + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val graphql = Graphql(client) + +val result = graphql.mutation( + query = mapOf( "a" to "b" ), +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/graphql/query.md b/docs/examples/1.6.x/client-android/kotlin/graphql/query.md new file mode 100644 index 0000000000..4a37ff3334 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/graphql/query.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Graphql + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val graphql = Graphql(client) + +val result = graphql.query( + query = mapOf( "a" to "b" ), +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/get.md b/docs/examples/1.6.x/client-android/kotlin/locale/get.md new file mode 100644 index 0000000000..aeee656f38 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/locale/get.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val locale = Locale(client) + +val result = locale.get() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-codes.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-codes.md new file mode 100644 index 0000000000..312ee65435 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/locale/list-codes.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val locale = Locale(client) + +val result = locale.listCodes() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-continents.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-continents.md new file mode 100644 index 0000000000..fa72e8e558 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/locale/list-continents.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val locale = Locale(client) + +val result = locale.listContinents() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-e-u.md new file mode 100644 index 0000000000..fc78895b8f --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-e-u.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val locale = Locale(client) + +val result = locale.listCountriesEU() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-phones.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-phones.md new file mode 100644 index 0000000000..c91603de3a --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-phones.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val locale = Locale(client) + +val result = locale.listCountriesPhones() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-countries.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-countries.md new file mode 100644 index 0000000000..8447eae584 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/locale/list-countries.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val locale = Locale(client) + +val result = locale.listCountries() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-currencies.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-currencies.md new file mode 100644 index 0000000000..631cd0d3ef --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/locale/list-currencies.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val locale = Locale(client) + +val result = locale.listCurrencies() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-languages.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-languages.md new file mode 100644 index 0000000000..c6c1560b08 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/locale/list-languages.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val locale = Locale(client) + +val result = locale.listLanguages() diff --git a/docs/examples/1.6.x/client-android/kotlin/messaging/create-subscriber.md b/docs/examples/1.6.x/client-android/kotlin/messaging/create-subscriber.md new file mode 100644 index 0000000000..e0798af1ee --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/messaging/create-subscriber.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val messaging = Messaging(client) + +val result = messaging.createSubscriber( + topicId = "<TOPIC_ID>", + subscriberId = "<SUBSCRIBER_ID>", + targetId = "<TARGET_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-android/kotlin/messaging/delete-subscriber.md new file mode 100644 index 0000000000..cf84d81bf7 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/messaging/delete-subscriber.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val messaging = Messaging(client) + +val result = messaging.deleteSubscriber( + topicId = "<TOPIC_ID>", + subscriberId = "<SUBSCRIBER_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/create-file.md b/docs/examples/1.6.x/client-android/kotlin/storage/create-file.md new file mode 100644 index 0000000000..d9b50e5251 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/storage/create-file.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.models.InputFile +import io.appwrite.services.Storage + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val storage = Storage(client) + +val result = storage.createFile( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>", + file = InputFile.fromPath("file.png"), + permissions = listOf("read("any")"), // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/delete-file.md b/docs/examples/1.6.x/client-android/kotlin/storage/delete-file.md new file mode 100644 index 0000000000..6309658b7a --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/storage/delete-file.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val storage = Storage(client) + +val result = storage.deleteFile( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/get-file-download.md b/docs/examples/1.6.x/client-android/kotlin/storage/get-file-download.md new file mode 100644 index 0000000000..305fdb9fc5 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/storage/get-file-download.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val storage = Storage(client) + +val result = storage.getFileDownload( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/get-file-preview.md b/docs/examples/1.6.x/client-android/kotlin/storage/get-file-preview.md new file mode 100644 index 0000000000..9cd86ff4ff --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/storage/get-file-preview.md @@ -0,0 +1,25 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val storage = Storage(client) + +val result = storage.getFilePreview( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>", + width = 0, // (optional) + height = 0, // (optional) + gravity = ImageGravity.CENTER, // (optional) + quality = 0, // (optional) + borderWidth = 0, // (optional) + borderColor = "", // (optional) + borderRadius = 0, // (optional) + opacity = 0, // (optional) + rotation = -360, // (optional) + background = "", // (optional) + output = ImageFormat.JPG, // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/get-file-view.md b/docs/examples/1.6.x/client-android/kotlin/storage/get-file-view.md new file mode 100644 index 0000000000..b8769cd5e1 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/storage/get-file-view.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val storage = Storage(client) + +val result = storage.getFileView( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/get-file.md b/docs/examples/1.6.x/client-android/kotlin/storage/get-file.md new file mode 100644 index 0000000000..4fab8a6690 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/storage/get-file.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val storage = Storage(client) + +val result = storage.getFile( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/list-files.md b/docs/examples/1.6.x/client-android/kotlin/storage/list-files.md new file mode 100644 index 0000000000..78d875e730 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/storage/list-files.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val storage = Storage(client) + +val result = storage.listFiles( + bucketId = "<BUCKET_ID>", + queries = listOf(), // (optional) + search = "<SEARCH>", // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/update-file.md b/docs/examples/1.6.x/client-android/kotlin/storage/update-file.md new file mode 100644 index 0000000000..7f34dee16d --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/storage/update-file.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val storage = Storage(client) + +val result = storage.updateFile( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>", + name = "<NAME>", // (optional) + permissions = listOf("read("any")"), // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/create-membership.md b/docs/examples/1.6.x/client-android/kotlin/teams/create-membership.md new file mode 100644 index 0000000000..5858c23496 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/create-membership.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.createMembership( + teamId = "<TEAM_ID>", + roles = listOf(), + email = "email@example.com", // (optional) + userId = "<USER_ID>", // (optional) + phone = "+12065550100", // (optional) + url = "https://example.com", // (optional) + name = "<NAME>", // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/create.md b/docs/examples/1.6.x/client-android/kotlin/teams/create.md new file mode 100644 index 0000000000..a45c22c3a6 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/create.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.create( + teamId = "<TEAM_ID>", + name = "<NAME>", + roles = listOf(), // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/delete-membership.md b/docs/examples/1.6.x/client-android/kotlin/teams/delete-membership.md new file mode 100644 index 0000000000..0d191e663f --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/delete-membership.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.deleteMembership( + teamId = "<TEAM_ID>", + membershipId = "<MEMBERSHIP_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/delete.md b/docs/examples/1.6.x/client-android/kotlin/teams/delete.md new file mode 100644 index 0000000000..87a3026704 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/delete.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.delete( + teamId = "<TEAM_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/get-membership.md b/docs/examples/1.6.x/client-android/kotlin/teams/get-membership.md new file mode 100644 index 0000000000..25e8b3ab7c --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/get-membership.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.getMembership( + teamId = "<TEAM_ID>", + membershipId = "<MEMBERSHIP_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/get-prefs.md b/docs/examples/1.6.x/client-android/kotlin/teams/get-prefs.md new file mode 100644 index 0000000000..447c4f2ab7 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/get-prefs.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.getPrefs( + teamId = "<TEAM_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/get.md b/docs/examples/1.6.x/client-android/kotlin/teams/get.md new file mode 100644 index 0000000000..aa18a3142d --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/get.md @@ -0,0 +1,13 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.get( + teamId = "<TEAM_ID>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/list-memberships.md b/docs/examples/1.6.x/client-android/kotlin/teams/list-memberships.md new file mode 100644 index 0000000000..2f83d8cd1c --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/list-memberships.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.listMemberships( + teamId = "<TEAM_ID>", + queries = listOf(), // (optional) + search = "<SEARCH>", // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/list.md b/docs/examples/1.6.x/client-android/kotlin/teams/list.md new file mode 100644 index 0000000000..569e607e03 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/list.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.list( + queries = listOf(), // (optional) + search = "<SEARCH>", // (optional) +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/update-membership-status.md b/docs/examples/1.6.x/client-android/kotlin/teams/update-membership-status.md new file mode 100644 index 0000000000..8d091aa78e --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/update-membership-status.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.updateMembershipStatus( + teamId = "<TEAM_ID>", + membershipId = "<MEMBERSHIP_ID>", + userId = "<USER_ID>", + secret = "<SECRET>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/update-membership.md b/docs/examples/1.6.x/client-android/kotlin/teams/update-membership.md new file mode 100644 index 0000000000..1f6c2d32f0 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/update-membership.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.updateMembership( + teamId = "<TEAM_ID>", + membershipId = "<MEMBERSHIP_ID>", + roles = listOf(), +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/update-name.md b/docs/examples/1.6.x/client-android/kotlin/teams/update-name.md new file mode 100644 index 0000000000..470ab17bbb --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/update-name.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.updateName( + teamId = "<TEAM_ID>", + name = "<NAME>", +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/update-prefs.md b/docs/examples/1.6.x/client-android/kotlin/teams/update-prefs.md new file mode 100644 index 0000000000..6ef809e5b0 --- /dev/null +++ b/docs/examples/1.6.x/client-android/kotlin/teams/update-prefs.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client(context) + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val teams = Teams(client) + +val result = teams.updatePrefs( + teamId = "<TEAM_ID>", + prefs = mapOf( "a" to "b" ), +) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-apple/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..6392cc4728 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-anonymous-session.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.createAnonymousSession() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-apple/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..2ff62e4c3d --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-email-password-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.createEmailPasswordSession( + email: "email@example.com", + password: "password" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-email-token.md b/docs/examples/1.6.x/client-apple/examples/account/create-email-token.md new file mode 100644 index 0000000000..1da4ecb425 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-email-token.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.createEmailToken( + userId: "<USER_ID>", + email: "email@example.com", + phrase: false // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-apple/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..ade54e673e --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-j-w-t.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let jwt = try await account.createJWT() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-apple/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..83d763c871 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.createMagicURLToken( + userId: "<USER_ID>", + email: "email@example.com", + url: "https://example.com", // optional + phrase: false // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-apple/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..0bf8badb19 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-mfa-authenticator.md @@ -0,0 +1,13 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let mfaType = try await account.createMfaAuthenticator( + type: .totp +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-apple/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..3798884fde --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-mfa-challenge.md @@ -0,0 +1,13 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let mfaChallenge = try await account.createMfaChallenge( + factor: .email +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-apple/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..7f54ce5096 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let mfaRecoveryCodes = try await account.createMfaRecoveryCodes() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2session.md new file mode 100644 index 0000000000..640b17dc22 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2session.md @@ -0,0 +1,16 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let success = try await account.createOAuth2Session( + provider: .amazon, + success: "https://example.com", // optional + failure: "https://example.com", // optional + scopes: [] // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..4224c6b4c3 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2token.md @@ -0,0 +1,16 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let success = try await account.createOAuth2Token( + provider: .amazon, + success: "https://example.com", // optional + failure: "https://example.com", // optional + scopes: [] // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-apple/examples/account/create-phone-token.md new file mode 100644 index 0000000000..f8cff783f4 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-phone-token.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.createPhoneToken( + userId: "<USER_ID>", + phone: "+12065550100" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-apple/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..7f70d610ee --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-phone-verification.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.createPhoneVerification() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-push-target.md b/docs/examples/1.6.x/client-apple/examples/account/create-push-target.md new file mode 100644 index 0000000000..4221cea941 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-push-target.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let target = try await account.createPushTarget( + targetId: "<TARGET_ID>", + identifier: "<IDENTIFIER>", + providerId: "<PROVIDER_ID>" // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-recovery.md b/docs/examples/1.6.x/client-apple/examples/account/create-recovery.md new file mode 100644 index 0000000000..b53e7ee0c2 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-recovery.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.createRecovery( + email: "email@example.com", + url: "https://example.com" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-session.md b/docs/examples/1.6.x/client-apple/examples/account/create-session.md new file mode 100644 index 0000000000..2bdecc74d3 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.createSession( + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-verification.md b/docs/examples/1.6.x/client-apple/examples/account/create-verification.md new file mode 100644 index 0000000000..6e0ef05e05 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create-verification.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.createVerification( + url: "https://example.com" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/create.md b/docs/examples/1.6.x/client-apple/examples/account/create.md new file mode 100644 index 0000000000..cb8dd109bb --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/create.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let user = try await account.create( + userId: "<USER_ID>", + email: "email@example.com", + password: "", + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/delete-identity.md b/docs/examples/1.6.x/client-apple/examples/account/delete-identity.md new file mode 100644 index 0000000000..1cca046bc2 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/delete-identity.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let result = try await account.deleteIdentity( + identityId: "<IDENTITY_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-apple/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..805c673a78 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,13 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let result = try await account.deleteMfaAuthenticator( + type: .totp +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-apple/examples/account/delete-push-target.md new file mode 100644 index 0000000000..4b5a8e6837 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/delete-push-target.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let result = try await account.deletePushTarget( + targetId: "<TARGET_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/delete-session.md b/docs/examples/1.6.x/client-apple/examples/account/delete-session.md new file mode 100644 index 0000000000..0fa94094fb --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/delete-session.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let result = try await account.deleteSession( + sessionId: "<SESSION_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-apple/examples/account/delete-sessions.md new file mode 100644 index 0000000000..cb49194862 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/delete-sessions.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let result = try await account.deleteSessions() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-apple/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..978fadd160 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let mfaRecoveryCodes = try await account.getMfaRecoveryCodes() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/get-prefs.md b/docs/examples/1.6.x/client-apple/examples/account/get-prefs.md new file mode 100644 index 0000000000..c9d4f62ebc --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/get-prefs.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let preferences = try await account.getPrefs() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/get-session.md b/docs/examples/1.6.x/client-apple/examples/account/get-session.md new file mode 100644 index 0000000000..b3a521973e --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/get-session.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.getSession( + sessionId: "<SESSION_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/get.md b/docs/examples/1.6.x/client-apple/examples/account/get.md new file mode 100644 index 0000000000..1a4f52e295 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/get.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let user = try await account.get() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/list-identities.md b/docs/examples/1.6.x/client-apple/examples/account/list-identities.md new file mode 100644 index 0000000000..94f5a8467d --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/list-identities.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let identityList = try await account.listIdentities( + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/list-logs.md b/docs/examples/1.6.x/client-apple/examples/account/list-logs.md new file mode 100644 index 0000000000..7d903695b3 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/list-logs.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let logList = try await account.listLogs( + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-apple/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..050ea14752 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/list-mfa-factors.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let mfaFactors = try await account.listMfaFactors() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/list-sessions.md b/docs/examples/1.6.x/client-apple/examples/account/list-sessions.md new file mode 100644 index 0000000000..891de058b2 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/list-sessions.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let sessionList = try await account.listSessions() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-email.md b/docs/examples/1.6.x/client-apple/examples/account/update-email.md new file mode 100644 index 0000000000..7d5811d7a8 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-email.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let user = try await account.updateEmail( + email: "email@example.com", + password: "password" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-apple/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..dddf0bc971 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-m-f-a.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let user = try await account.updateMFA( + mfa: false +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-apple/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..6571266959 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.updateMagicURLSession( + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-apple/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..10da12d217 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-mfa-authenticator.md @@ -0,0 +1,14 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let user = try await account.updateMfaAuthenticator( + type: .totp, + otp: "<OTP>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-apple/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..e75d9b647c --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-mfa-challenge.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let result = try await account.updateMfaChallenge( + challengeId: "<CHALLENGE_ID>", + otp: "<OTP>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-apple/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..374c2f746f --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let mfaRecoveryCodes = try await account.updateMfaRecoveryCodes() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-name.md b/docs/examples/1.6.x/client-apple/examples/account/update-name.md new file mode 100644 index 0000000000..6fe2f5e61d --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-name.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let user = try await account.updateName( + name: "<NAME>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-password.md b/docs/examples/1.6.x/client-apple/examples/account/update-password.md new file mode 100644 index 0000000000..cc1fe3d438 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-password.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let user = try await account.updatePassword( + password: "", + oldPassword: "password" // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-apple/examples/account/update-phone-session.md new file mode 100644 index 0000000000..df1feae1e3 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-phone-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.updatePhoneSession( + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-apple/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..d18c1e4841 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-phone-verification.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.updatePhoneVerification( + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-phone.md b/docs/examples/1.6.x/client-apple/examples/account/update-phone.md new file mode 100644 index 0000000000..ba22584e66 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-phone.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let user = try await account.updatePhone( + phone: "+12065550100", + password: "password" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-prefs.md b/docs/examples/1.6.x/client-apple/examples/account/update-prefs.md new file mode 100644 index 0000000000..b71f73d3e9 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-prefs.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let user = try await account.updatePrefs( + prefs: [:] +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-push-target.md b/docs/examples/1.6.x/client-apple/examples/account/update-push-target.md new file mode 100644 index 0000000000..70e206240d --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-push-target.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let target = try await account.updatePushTarget( + targetId: "<TARGET_ID>", + identifier: "<IDENTIFIER>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-recovery.md b/docs/examples/1.6.x/client-apple/examples/account/update-recovery.md new file mode 100644 index 0000000000..9386ca0ae9 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-recovery.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.updateRecovery( + userId: "<USER_ID>", + secret: "<SECRET>", + password: "" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-session.md b/docs/examples/1.6.x/client-apple/examples/account/update-session.md new file mode 100644 index 0000000000..d5d8a202de --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-session.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.updateSession( + sessionId: "<SESSION_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-status.md b/docs/examples/1.6.x/client-apple/examples/account/update-status.md new file mode 100644 index 0000000000..b654314d76 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-status.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let user = try await account.updateStatus() + diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-verification.md b/docs/examples/1.6.x/client-apple/examples/account/update-verification.md new file mode 100644 index 0000000000..6915a0c3e5 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/account/update-verification.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.updateVerification( + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-browser.md new file mode 100644 index 0000000000..3ce39028b6 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/avatars/get-browser.md @@ -0,0 +1,16 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let avatars = Avatars(client) + +let bytes = try await avatars.getBrowser( + code: .avantBrowser, + width: 0, // optional + height: 0, // optional + quality: 0 // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..76191aa64f --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/avatars/get-credit-card.md @@ -0,0 +1,16 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let avatars = Avatars(client) + +let bytes = try await avatars.getCreditCard( + code: .americanExpress, + width: 0, // optional + height: 0, // optional + quality: 0 // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..549b12364b --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/avatars/get-favicon.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let avatars = Avatars(client) + +let bytes = try await avatars.getFavicon( + url: "https://example.com" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-flag.md new file mode 100644 index 0000000000..bdf8dd0493 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/avatars/get-flag.md @@ -0,0 +1,16 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let avatars = Avatars(client) + +let bytes = try await avatars.getFlag( + code: .afghanistan, + width: 0, // optional + height: 0, // optional + quality: 0 // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-image.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-image.md new file mode 100644 index 0000000000..5098493a45 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/avatars/get-image.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let avatars = Avatars(client) + +let bytes = try await avatars.getImage( + url: "https://example.com", + width: 0, // optional + height: 0 // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-initials.md new file mode 100644 index 0000000000..02aafd89f0 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/avatars/get-initials.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let avatars = Avatars(client) + +let bytes = try await avatars.getInitials( + name: "<NAME>", // optional + width: 0, // optional + height: 0, // optional + background: "" // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..9a1e414b35 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/avatars/get-q-r.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let avatars = Avatars(client) + +let bytes = try await avatars.getQR( + text: "<TEXT>", + size: 1, // optional + margin: 0, // optional + download: false // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/databases/create-document.md b/docs/examples/1.6.x/client-apple/examples/databases/create-document.md new file mode 100644 index 0000000000..ea5161de06 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/databases/create-document.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let databases = Databases(client) + +let document = try await databases.createDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: [:], + permissions: ["read("any")"] // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/databases/delete-document.md b/docs/examples/1.6.x/client-apple/examples/databases/delete-document.md new file mode 100644 index 0000000000..f97130378b --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/databases/delete-document.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let databases = Databases(client) + +let result = try await databases.deleteDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/databases/get-document.md b/docs/examples/1.6.x/client-apple/examples/databases/get-document.md new file mode 100644 index 0000000000..2355b938fe --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/databases/get-document.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let databases = Databases(client) + +let document = try await databases.getDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/databases/list-documents.md b/docs/examples/1.6.x/client-apple/examples/databases/list-documents.md new file mode 100644 index 0000000000..bbb60ef9ad --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/databases/list-documents.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let databases = Databases(client) + +let documentList = try await databases.listDocuments( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/databases/update-document.md b/docs/examples/1.6.x/client-apple/examples/databases/update-document.md new file mode 100644 index 0000000000..768787e2b3 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/databases/update-document.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let databases = Databases(client) + +let document = try await databases.updateDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: [:], // optional + permissions: ["read("any")"] // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/functions/create-execution.md b/docs/examples/1.6.x/client-apple/examples/functions/create-execution.md new file mode 100644 index 0000000000..2f2d32d19e --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/functions/create-execution.md @@ -0,0 +1,19 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let functions = Functions(client) + +let execution = try await functions.createExecution( + functionId: "<FUNCTION_ID>", + body: "<BODY>", // optional + async: false, // optional + path: "<PATH>", // optional + method: .gET, // optional + headers: [:], // optional + scheduledAt: "" // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/functions/get-execution.md b/docs/examples/1.6.x/client-apple/examples/functions/get-execution.md new file mode 100644 index 0000000000..b711ce210d --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/functions/get-execution.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let functions = Functions(client) + +let execution = try await functions.getExecution( + functionId: "<FUNCTION_ID>", + executionId: "<EXECUTION_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/functions/list-executions.md b/docs/examples/1.6.x/client-apple/examples/functions/list-executions.md new file mode 100644 index 0000000000..043c8911ae --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/functions/list-executions.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let functions = Functions(client) + +let executionList = try await functions.listExecutions( + functionId: "<FUNCTION_ID>", + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/graphql/mutation.md b/docs/examples/1.6.x/client-apple/examples/graphql/mutation.md new file mode 100644 index 0000000000..29434c6bb0 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/graphql/mutation.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let graphql = Graphql(client) + +let any = try await graphql.mutation( + query: [:] +) + diff --git a/docs/examples/1.6.x/client-apple/examples/graphql/query.md b/docs/examples/1.6.x/client-apple/examples/graphql/query.md new file mode 100644 index 0000000000..85c6ab4e53 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/graphql/query.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let graphql = Graphql(client) + +let any = try await graphql.query( + query: [:] +) + diff --git a/docs/examples/1.6.x/client-apple/examples/locale/get.md b/docs/examples/1.6.x/client-apple/examples/locale/get.md new file mode 100644 index 0000000000..6c352fbef3 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/locale/get.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let locale = Locale(client) + +let locale = try await locale.get() + diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-codes.md b/docs/examples/1.6.x/client-apple/examples/locale/list-codes.md new file mode 100644 index 0000000000..2f168d9b4d --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/locale/list-codes.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let locale = Locale(client) + +let localeCodeList = try await locale.listCodes() + diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-continents.md b/docs/examples/1.6.x/client-apple/examples/locale/list-continents.md new file mode 100644 index 0000000000..714d9e1ee1 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/locale/list-continents.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let locale = Locale(client) + +let continentList = try await locale.listContinents() + diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-apple/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..d390094bbd --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/locale/list-countries-e-u.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let locale = Locale(client) + +let countryList = try await locale.listCountriesEU() + diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-apple/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..96060b5ae7 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/locale/list-countries-phones.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let locale = Locale(client) + +let phoneList = try await locale.listCountriesPhones() + diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-countries.md b/docs/examples/1.6.x/client-apple/examples/locale/list-countries.md new file mode 100644 index 0000000000..fc9b18accf --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/locale/list-countries.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let locale = Locale(client) + +let countryList = try await locale.listCountries() + diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-apple/examples/locale/list-currencies.md new file mode 100644 index 0000000000..d316235bfc --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/locale/list-currencies.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let locale = Locale(client) + +let currencyList = try await locale.listCurrencies() + diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-languages.md b/docs/examples/1.6.x/client-apple/examples/locale/list-languages.md new file mode 100644 index 0000000000..62e929aac7 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/locale/list-languages.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let locale = Locale(client) + +let languageList = try await locale.listLanguages() + diff --git a/docs/examples/1.6.x/client-apple/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-apple/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..1a135e8766 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/messaging/create-subscriber.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let messaging = Messaging(client) + +let subscriber = try await messaging.createSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>", + targetId: "<TARGET_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-apple/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..fe6261a13f --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/messaging/delete-subscriber.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let messaging = Messaging(client) + +let result = try await messaging.deleteSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/storage/create-file.md b/docs/examples/1.6.x/client-apple/examples/storage/create-file.md new file mode 100644 index 0000000000..07f3ea78c2 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/storage/create-file.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let storage = Storage(client) + +let file = try await storage.createFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + file: InputFile.fromPath("file.png"), + permissions: ["read("any")"] // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/storage/delete-file.md b/docs/examples/1.6.x/client-apple/examples/storage/delete-file.md new file mode 100644 index 0000000000..323b92e84a --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/storage/delete-file.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let storage = Storage(client) + +let result = try await storage.deleteFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-apple/examples/storage/get-file-download.md new file mode 100644 index 0000000000..32c033be4a --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/storage/get-file-download.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let storage = Storage(client) + +let bytes = try await storage.getFileDownload( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-apple/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..4b66426448 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/storage/get-file-preview.md @@ -0,0 +1,25 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let storage = Storage(client) + +let bytes = try await storage.getFilePreview( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + width: 0, // optional + height: 0, // optional + gravity: .center, // optional + quality: 0, // optional + borderWidth: 0, // optional + borderColor: "", // optional + borderRadius: 0, // optional + opacity: 0, // optional + rotation: -360, // optional + background: "", // optional + output: .jpg // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-apple/examples/storage/get-file-view.md new file mode 100644 index 0000000000..c0a949dfa0 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/storage/get-file-view.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let storage = Storage(client) + +let bytes = try await storage.getFileView( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/storage/get-file.md b/docs/examples/1.6.x/client-apple/examples/storage/get-file.md new file mode 100644 index 0000000000..bf2e60f603 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/storage/get-file.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let storage = Storage(client) + +let file = try await storage.getFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/storage/list-files.md b/docs/examples/1.6.x/client-apple/examples/storage/list-files.md new file mode 100644 index 0000000000..d03995ebbd --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/storage/list-files.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let storage = Storage(client) + +let fileList = try await storage.listFiles( + bucketId: "<BUCKET_ID>", + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/storage/update-file.md b/docs/examples/1.6.x/client-apple/examples/storage/update-file.md new file mode 100644 index 0000000000..e71eecc2c5 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/storage/update-file.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let storage = Storage(client) + +let file = try await storage.updateFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + name: "<NAME>", // optional + permissions: ["read("any")"] // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/create-membership.md b/docs/examples/1.6.x/client-apple/examples/teams/create-membership.md new file mode 100644 index 0000000000..e57eca8cba --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/create-membership.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let membership = try await teams.createMembership( + teamId: "<TEAM_ID>", + roles: [], + email: "email@example.com", // optional + userId: "<USER_ID>", // optional + phone: "+12065550100", // optional + url: "https://example.com", // optional + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/create.md b/docs/examples/1.6.x/client-apple/examples/teams/create.md new file mode 100644 index 0000000000..4ae559b8a3 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/create.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let team = try await teams.create( + teamId: "<TEAM_ID>", + name: "<NAME>", + roles: [] // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-apple/examples/teams/delete-membership.md new file mode 100644 index 0000000000..a7cdaa8731 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/delete-membership.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let result = try await teams.deleteMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/delete.md b/docs/examples/1.6.x/client-apple/examples/teams/delete.md new file mode 100644 index 0000000000..f7e3265e35 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/delete.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let result = try await teams.delete( + teamId: "<TEAM_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/get-membership.md b/docs/examples/1.6.x/client-apple/examples/teams/get-membership.md new file mode 100644 index 0000000000..0fb4b51416 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/get-membership.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let membership = try await teams.getMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-apple/examples/teams/get-prefs.md new file mode 100644 index 0000000000..151cb3ffe2 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/get-prefs.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let preferences = try await teams.getPrefs( + teamId: "<TEAM_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/get.md b/docs/examples/1.6.x/client-apple/examples/teams/get.md new file mode 100644 index 0000000000..361837875d --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/get.md @@ -0,0 +1,12 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let team = try await teams.get( + teamId: "<TEAM_ID>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-apple/examples/teams/list-memberships.md new file mode 100644 index 0000000000..a0573b6e96 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/list-memberships.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let membershipList = try await teams.listMemberships( + teamId: "<TEAM_ID>", + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/list.md b/docs/examples/1.6.x/client-apple/examples/teams/list.md new file mode 100644 index 0000000000..bbd2dd6056 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/list.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let teamList = try await teams.list( + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-apple/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..25a1246407 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/update-membership-status.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let membership = try await teams.updateMembershipStatus( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/update-membership.md b/docs/examples/1.6.x/client-apple/examples/teams/update-membership.md new file mode 100644 index 0000000000..0a52d6c547 --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/update-membership.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let membership = try await teams.updateMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + roles: [] +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/update-name.md b/docs/examples/1.6.x/client-apple/examples/teams/update-name.md new file mode 100644 index 0000000000..245919d60f --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/update-name.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let team = try await teams.updateName( + teamId: "<TEAM_ID>", + name: "<NAME>" +) + diff --git a/docs/examples/1.6.x/client-apple/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-apple/examples/teams/update-prefs.md new file mode 100644 index 0000000000..2e71dde1cc --- /dev/null +++ b/docs/examples/1.6.x/client-apple/examples/teams/update-prefs.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let teams = Teams(client) + +let preferences = try await teams.updatePrefs( + teamId: "<TEAM_ID>", + prefs: [:] +) + diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-flutter/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..173b07afd2 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-anonymous-session.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.createAnonymousSession(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-flutter/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..6b49879093 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-email-password-session.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.createEmailPasswordSession( + email: 'email@example.com', + password: 'password', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-email-token.md b/docs/examples/1.6.x/client-flutter/examples/account/create-email-token.md new file mode 100644 index 0000000000..497d91a4ce --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-email-token.md @@ -0,0 +1,13 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.createEmailToken( + userId: '<USER_ID>', + email: 'email@example.com', + phrase: false, // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-flutter/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..5af6e3d3a8 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-j-w-t.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Jwt result = await account.createJWT(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-flutter/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..8ac49e8282 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,14 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.createMagicURLToken( + userId: '<USER_ID>', + email: 'email@example.com', + url: 'https://example.com', // optional + phrase: false, // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..4ea7989886 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-authenticator.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +MfaType result = await account.createMfaAuthenticator( + type: AuthenticatorType.totp, +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..bbd95ea729 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-challenge.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +MfaChallenge result = await account.createMfaChallenge( + factor: AuthenticationFactor.email, +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..aa3b78b12d --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +MfaRecoveryCodes result = await account.createMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2session.md new file mode 100644 index 0000000000..2679f9eb6e --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2session.md @@ -0,0 +1,14 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +await account.createOAuth2Session( + provider: OAuthProvider.amazon, + success: 'https://example.com', // optional + failure: 'https://example.com', // optional + scopes: [], // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..4f62b8116d --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2token.md @@ -0,0 +1,14 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +await account.createOAuth2Token( + provider: OAuthProvider.amazon, + success: 'https://example.com', // optional + failure: 'https://example.com', // optional + scopes: [], // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-flutter/examples/account/create-phone-token.md new file mode 100644 index 0000000000..5a096ceb8c --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-phone-token.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.createPhoneToken( + userId: '<USER_ID>', + phone: '+12065550100', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-flutter/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..f80bbaadac --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-phone-verification.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.createPhoneVerification(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-push-target.md b/docs/examples/1.6.x/client-flutter/examples/account/create-push-target.md new file mode 100644 index 0000000000..33a98cf77c --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-push-target.md @@ -0,0 +1,13 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Target result = await account.createPushTarget( + targetId: '<TARGET_ID>', + identifier: '<IDENTIFIER>', + providerId: '<PROVIDER_ID>', // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-recovery.md b/docs/examples/1.6.x/client-flutter/examples/account/create-recovery.md new file mode 100644 index 0000000000..70c52faa77 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-recovery.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.createRecovery( + email: 'email@example.com', + url: 'https://example.com', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-session.md b/docs/examples/1.6.x/client-flutter/examples/account/create-session.md new file mode 100644 index 0000000000..b8170cc176 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-session.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.createSession( + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-verification.md b/docs/examples/1.6.x/client-flutter/examples/account/create-verification.md new file mode 100644 index 0000000000..99ba3cbe4e --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create-verification.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.createVerification( + url: 'https://example.com', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create.md b/docs/examples/1.6.x/client-flutter/examples/account/create.md new file mode 100644 index 0000000000..324d0d995f --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/create.md @@ -0,0 +1,14 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +User result = await account.create( + userId: '<USER_ID>', + email: 'email@example.com', + password: '', + name: '<NAME>', // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/delete-identity.md b/docs/examples/1.6.x/client-flutter/examples/account/delete-identity.md new file mode 100644 index 0000000000..ae5cd50dac --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/delete-identity.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +await account.deleteIdentity( + identityId: '<IDENTITY_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-flutter/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..66a0e89727 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +await account.deleteMfaAuthenticator( + type: AuthenticatorType.totp, +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-flutter/examples/account/delete-push-target.md new file mode 100644 index 0000000000..d80c97ecea --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/delete-push-target.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +await account.deletePushTarget( + targetId: '<TARGET_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/delete-session.md b/docs/examples/1.6.x/client-flutter/examples/account/delete-session.md new file mode 100644 index 0000000000..5bf9811550 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/delete-session.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +await account.deleteSession( + sessionId: '<SESSION_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-flutter/examples/account/delete-sessions.md new file mode 100644 index 0000000000..c00d285691 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/delete-sessions.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +await account.deleteSessions(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-flutter/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..f4e99b6e2d --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +MfaRecoveryCodes result = await account.getMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/get-prefs.md b/docs/examples/1.6.x/client-flutter/examples/account/get-prefs.md new file mode 100644 index 0000000000..2790e097bc --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/get-prefs.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Preferences result = await account.getPrefs(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/get-session.md b/docs/examples/1.6.x/client-flutter/examples/account/get-session.md new file mode 100644 index 0000000000..0be63f7225 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/get-session.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.getSession( + sessionId: '<SESSION_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/get.md b/docs/examples/1.6.x/client-flutter/examples/account/get.md new file mode 100644 index 0000000000..0bd26c0273 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/get.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +User result = await account.get(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/list-identities.md b/docs/examples/1.6.x/client-flutter/examples/account/list-identities.md new file mode 100644 index 0000000000..758b054b9a --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/list-identities.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +IdentityList result = await account.listIdentities( + queries: [], // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/list-logs.md b/docs/examples/1.6.x/client-flutter/examples/account/list-logs.md new file mode 100644 index 0000000000..7a4ac11ab1 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/list-logs.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +LogList result = await account.listLogs( + queries: [], // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-flutter/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..d66e8862b1 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/list-mfa-factors.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +MfaFactors result = await account.listMfaFactors(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/list-sessions.md b/docs/examples/1.6.x/client-flutter/examples/account/list-sessions.md new file mode 100644 index 0000000000..4c363ccf63 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/list-sessions.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +SessionList result = await account.listSessions(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-email.md b/docs/examples/1.6.x/client-flutter/examples/account/update-email.md new file mode 100644 index 0000000000..2b5b73ec78 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-email.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +User result = await account.updateEmail( + email: 'email@example.com', + password: 'password', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-flutter/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..5f65b7e90d --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-m-f-a.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +User result = await account.updateMFA( + mfa: false, +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-flutter/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..0f584d7514 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.updateMagicURLSession( + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..9fb8f54cb5 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-authenticator.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +User result = await account.updateMfaAuthenticator( + type: AuthenticatorType.totp, + otp: '<OTP>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..6eac346670 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-challenge.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + + result = await account.updateMfaChallenge( + challengeId: '<CHALLENGE_ID>', + otp: '<OTP>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..29c0cff280 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +MfaRecoveryCodes result = await account.updateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-name.md b/docs/examples/1.6.x/client-flutter/examples/account/update-name.md new file mode 100644 index 0000000000..bf8048d079 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-name.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +User result = await account.updateName( + name: '<NAME>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-password.md b/docs/examples/1.6.x/client-flutter/examples/account/update-password.md new file mode 100644 index 0000000000..0e4106012d --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-password.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +User result = await account.updatePassword( + password: '', + oldPassword: 'password', // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-flutter/examples/account/update-phone-session.md new file mode 100644 index 0000000000..1ea87ddf84 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-phone-session.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.updatePhoneSession( + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-flutter/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..d6681a633d --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-phone-verification.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.updatePhoneVerification( + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-phone.md b/docs/examples/1.6.x/client-flutter/examples/account/update-phone.md new file mode 100644 index 0000000000..0e530464de --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-phone.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +User result = await account.updatePhone( + phone: '+12065550100', + password: 'password', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-prefs.md b/docs/examples/1.6.x/client-flutter/examples/account/update-prefs.md new file mode 100644 index 0000000000..15d3a8f530 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-prefs.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +User result = await account.updatePrefs( + prefs: {}, +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-push-target.md b/docs/examples/1.6.x/client-flutter/examples/account/update-push-target.md new file mode 100644 index 0000000000..78d1b7929a --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-push-target.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Target result = await account.updatePushTarget( + targetId: '<TARGET_ID>', + identifier: '<IDENTIFIER>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-recovery.md b/docs/examples/1.6.x/client-flutter/examples/account/update-recovery.md new file mode 100644 index 0000000000..d12c24d3d6 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-recovery.md @@ -0,0 +1,13 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.updateRecovery( + userId: '<USER_ID>', + secret: '<SECRET>', + password: '', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-session.md b/docs/examples/1.6.x/client-flutter/examples/account/update-session.md new file mode 100644 index 0000000000..bb600667ba --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-session.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.updateSession( + sessionId: '<SESSION_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-status.md b/docs/examples/1.6.x/client-flutter/examples/account/update-status.md new file mode 100644 index 0000000000..da59e537c4 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-status.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +User result = await account.updateStatus(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-verification.md b/docs/examples/1.6.x/client-flutter/examples/account/update-verification.md new file mode 100644 index 0000000000..98174f9f2f --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/account/update-verification.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.updateVerification( + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-browser.md new file mode 100644 index 0000000000..20b039a3d7 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/avatars/get-browser.md @@ -0,0 +1,33 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Avatars avatars = Avatars(client); + +// Downloading file +UInt8List bytes = await avatars.getBrowser( + code: Browser.avantBrowser, + width: 0, // optional + height: 0, // optional + quality: 0, // optional +) + +final file = File('path_to_file/filename.ext'); +file.writeAsBytesSync(bytes); + +// Displaying image preview +FutureBuilder( + future: avatars.getBrowser( + code: Browser.avantBrowser, + width:0 , // optional + height:0 , // optional + quality:0 , // optional +), // Works for both public file and private file, for private files you need to be logged in + builder: (context, snapshot) { + return snapshot.hasData && snapshot.data != null + ? Image.memory(snapshot.data) + : CircularProgressIndicator(); + } +); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..9f645f40a5 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/avatars/get-credit-card.md @@ -0,0 +1,33 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Avatars avatars = Avatars(client); + +// Downloading file +UInt8List bytes = await avatars.getCreditCard( + code: CreditCard.americanExpress, + width: 0, // optional + height: 0, // optional + quality: 0, // optional +) + +final file = File('path_to_file/filename.ext'); +file.writeAsBytesSync(bytes); + +// Displaying image preview +FutureBuilder( + future: avatars.getCreditCard( + code: CreditCard.americanExpress, + width:0 , // optional + height:0 , // optional + quality:0 , // optional +), // Works for both public file and private file, for private files you need to be logged in + builder: (context, snapshot) { + return snapshot.hasData && snapshot.data != null + ? Image.memory(snapshot.data) + : CircularProgressIndicator(); + } +); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..b4003ee0dd --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/avatars/get-favicon.md @@ -0,0 +1,27 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Avatars avatars = Avatars(client); + +// Downloading file +UInt8List bytes = await avatars.getFavicon( + url: 'https://example.com', +) + +final file = File('path_to_file/filename.ext'); +file.writeAsBytesSync(bytes); + +// Displaying image preview +FutureBuilder( + future: avatars.getFavicon( + url:'https://example.com' , +), // Works for both public file and private file, for private files you need to be logged in + builder: (context, snapshot) { + return snapshot.hasData && snapshot.data != null + ? Image.memory(snapshot.data) + : CircularProgressIndicator(); + } +); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-flag.md new file mode 100644 index 0000000000..9751ae2320 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/avatars/get-flag.md @@ -0,0 +1,33 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Avatars avatars = Avatars(client); + +// Downloading file +UInt8List bytes = await avatars.getFlag( + code: Flag.afghanistan, + width: 0, // optional + height: 0, // optional + quality: 0, // optional +) + +final file = File('path_to_file/filename.ext'); +file.writeAsBytesSync(bytes); + +// Displaying image preview +FutureBuilder( + future: avatars.getFlag( + code: Flag.afghanistan, + width:0 , // optional + height:0 , // optional + quality:0 , // optional +), // Works for both public file and private file, for private files you need to be logged in + builder: (context, snapshot) { + return snapshot.hasData && snapshot.data != null + ? Image.memory(snapshot.data) + : CircularProgressIndicator(); + } +); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-image.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-image.md new file mode 100644 index 0000000000..4c1404188f --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/avatars/get-image.md @@ -0,0 +1,31 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Avatars avatars = Avatars(client); + +// Downloading file +UInt8List bytes = await avatars.getImage( + url: 'https://example.com', + width: 0, // optional + height: 0, // optional +) + +final file = File('path_to_file/filename.ext'); +file.writeAsBytesSync(bytes); + +// Displaying image preview +FutureBuilder( + future: avatars.getImage( + url:'https://example.com' , + width:0 , // optional + height:0 , // optional +), // Works for both public file and private file, for private files you need to be logged in + builder: (context, snapshot) { + return snapshot.hasData && snapshot.data != null + ? Image.memory(snapshot.data) + : CircularProgressIndicator(); + } +); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-initials.md new file mode 100644 index 0000000000..c7df00f111 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/avatars/get-initials.md @@ -0,0 +1,33 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Avatars avatars = Avatars(client); + +// Downloading file +UInt8List bytes = await avatars.getInitials( + name: '<NAME>', // optional + width: 0, // optional + height: 0, // optional + background: '', // optional +) + +final file = File('path_to_file/filename.ext'); +file.writeAsBytesSync(bytes); + +// Displaying image preview +FutureBuilder( + future: avatars.getInitials( + name:'<NAME>' , // optional + width:0 , // optional + height:0 , // optional + background:'' , // optional +), // Works for both public file and private file, for private files you need to be logged in + builder: (context, snapshot) { + return snapshot.hasData && snapshot.data != null + ? Image.memory(snapshot.data) + : CircularProgressIndicator(); + } +); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..fa4c3f41d6 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/avatars/get-q-r.md @@ -0,0 +1,33 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Avatars avatars = Avatars(client); + +// Downloading file +UInt8List bytes = await avatars.getQR( + text: '<TEXT>', + size: 1, // optional + margin: 0, // optional + download: false, // optional +) + +final file = File('path_to_file/filename.ext'); +file.writeAsBytesSync(bytes); + +// Displaying image preview +FutureBuilder( + future: avatars.getQR( + text:'<TEXT>' , + size:1 , // optional + margin:0 , // optional + download:false , // optional +), // Works for both public file and private file, for private files you need to be logged in + builder: (context, snapshot) { + return snapshot.hasData && snapshot.data != null + ? Image.memory(snapshot.data) + : CircularProgressIndicator(); + } +); diff --git a/docs/examples/1.6.x/client-flutter/examples/databases/create-document.md b/docs/examples/1.6.x/client-flutter/examples/databases/create-document.md new file mode 100644 index 0000000000..7970d0330f --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/databases/create-document.md @@ -0,0 +1,15 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Databases databases = Databases(client); + +Document result = await databases.createDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>', + data: {}, + permissions: ["read("any")"], // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/databases/delete-document.md b/docs/examples/1.6.x/client-flutter/examples/databases/delete-document.md new file mode 100644 index 0000000000..138a5aeb5a --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/databases/delete-document.md @@ -0,0 +1,13 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Databases databases = Databases(client); + +await databases.deleteDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/databases/get-document.md b/docs/examples/1.6.x/client-flutter/examples/databases/get-document.md new file mode 100644 index 0000000000..7cdd4b04a5 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/databases/get-document.md @@ -0,0 +1,14 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Databases databases = Databases(client); + +Document result = await databases.getDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>', + queries: [], // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/databases/list-documents.md b/docs/examples/1.6.x/client-flutter/examples/databases/list-documents.md new file mode 100644 index 0000000000..ec23cf0e0e --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/databases/list-documents.md @@ -0,0 +1,13 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Databases databases = Databases(client); + +DocumentList result = await databases.listDocuments( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + queries: [], // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/databases/update-document.md b/docs/examples/1.6.x/client-flutter/examples/databases/update-document.md new file mode 100644 index 0000000000..b4179209f3 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/databases/update-document.md @@ -0,0 +1,15 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Databases databases = Databases(client); + +Document result = await databases.updateDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>', + data: {}, // optional + permissions: ["read("any")"], // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/functions/create-execution.md b/docs/examples/1.6.x/client-flutter/examples/functions/create-execution.md new file mode 100644 index 0000000000..d53f4bf9d4 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/functions/create-execution.md @@ -0,0 +1,17 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Functions functions = Functions(client); + +Execution result = await functions.createExecution( + functionId: '<FUNCTION_ID>', + body: '<BODY>', // optional + xasync: false, // optional + path: '<PATH>', // optional + method: ExecutionMethod.gET, // optional + headers: {}, // optional + scheduledAt: '', // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/functions/get-execution.md b/docs/examples/1.6.x/client-flutter/examples/functions/get-execution.md new file mode 100644 index 0000000000..84747806fd --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/functions/get-execution.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Functions functions = Functions(client); + +Execution result = await functions.getExecution( + functionId: '<FUNCTION_ID>', + executionId: '<EXECUTION_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/functions/list-executions.md b/docs/examples/1.6.x/client-flutter/examples/functions/list-executions.md new file mode 100644 index 0000000000..a99078ce9d --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/functions/list-executions.md @@ -0,0 +1,13 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Functions functions = Functions(client); + +ExecutionList result = await functions.listExecutions( + functionId: '<FUNCTION_ID>', + queries: [], // optional + search: '<SEARCH>', // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/graphql/mutation.md b/docs/examples/1.6.x/client-flutter/examples/graphql/mutation.md new file mode 100644 index 0000000000..bde93e5048 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/graphql/mutation.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Graphql graphql = Graphql(client); + +Any result = await graphql.mutation( + query: {}, +); diff --git a/docs/examples/1.6.x/client-flutter/examples/graphql/query.md b/docs/examples/1.6.x/client-flutter/examples/graphql/query.md new file mode 100644 index 0000000000..35088d914e --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/graphql/query.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Graphql graphql = Graphql(client); + +Any result = await graphql.query( + query: {}, +); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/get.md b/docs/examples/1.6.x/client-flutter/examples/locale/get.md new file mode 100644 index 0000000000..81ca122971 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/locale/get.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Locale locale = Locale(client); + +Locale result = await locale.get(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-codes.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-codes.md new file mode 100644 index 0000000000..5b6d975503 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/locale/list-codes.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Locale locale = Locale(client); + +LocaleCodeList result = await locale.listCodes(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-continents.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-continents.md new file mode 100644 index 0000000000..c4a4ef85ea --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/locale/list-continents.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Locale locale = Locale(client); + +ContinentList result = await locale.listContinents(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..eee429419f --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-e-u.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Locale locale = Locale(client); + +CountryList result = await locale.listCountriesEU(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..5136d62ad0 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-phones.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Locale locale = Locale(client); + +PhoneList result = await locale.listCountriesPhones(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-countries.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-countries.md new file mode 100644 index 0000000000..c3eed1ec9d --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/locale/list-countries.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Locale locale = Locale(client); + +CountryList result = await locale.listCountries(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-currencies.md new file mode 100644 index 0000000000..e2300b4e7b --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/locale/list-currencies.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Locale locale = Locale(client); + +CurrencyList result = await locale.listCurrencies(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-languages.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-languages.md new file mode 100644 index 0000000000..83284e2f5d --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/locale/list-languages.md @@ -0,0 +1,9 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Locale locale = Locale(client); + +LanguageList result = await locale.listLanguages(); diff --git a/docs/examples/1.6.x/client-flutter/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-flutter/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..85822f8e0f --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/messaging/create-subscriber.md @@ -0,0 +1,13 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Messaging messaging = Messaging(client); + +Subscriber result = await messaging.createSubscriber( + topicId: '<TOPIC_ID>', + subscriberId: '<SUBSCRIBER_ID>', + targetId: '<TARGET_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-flutter/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..8551b2efb5 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/messaging/delete-subscriber.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Messaging messaging = Messaging(client); + +await messaging.deleteSubscriber( + topicId: '<TOPIC_ID>', + subscriberId: '<SUBSCRIBER_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/create-file.md b/docs/examples/1.6.x/client-flutter/examples/storage/create-file.md new file mode 100644 index 0000000000..77468915b1 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/storage/create-file.md @@ -0,0 +1,15 @@ +import 'dart:io'; +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Storage storage = Storage(client); + +File result = await storage.createFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', + file: InputFile(path: './path-to-files/image.jpg', filename: 'image.jpg'), + permissions: ["read("any")"], // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/delete-file.md b/docs/examples/1.6.x/client-flutter/examples/storage/delete-file.md new file mode 100644 index 0000000000..5e2525ea5b --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/storage/delete-file.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Storage storage = Storage(client); + +await storage.deleteFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-flutter/examples/storage/get-file-download.md new file mode 100644 index 0000000000..d8d18aa42e --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/storage/get-file-download.md @@ -0,0 +1,29 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Storage storage = Storage(client); + +// Downloading file +UInt8List bytes = await storage.getFileDownload( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', +) + +final file = File('path_to_file/filename.ext'); +file.writeAsBytesSync(bytes); + +// Displaying image preview +FutureBuilder( + future: storage.getFileDownload( + bucketId:'<BUCKET_ID>' , + fileId:'<FILE_ID>' , +), // Works for both public file and private file, for private files you need to be logged in + builder: (context, snapshot) { + return snapshot.hasData && snapshot.data != null + ? Image.memory(snapshot.data) + : CircularProgressIndicator(); + } +); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-flutter/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..09c8ddaeac --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/storage/get-file-preview.md @@ -0,0 +1,51 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Storage storage = Storage(client); + +// Downloading file +UInt8List bytes = await storage.getFilePreview( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', + width: 0, // optional + height: 0, // optional + gravity: ImageGravity.center, // optional + quality: 0, // optional + borderWidth: 0, // optional + borderColor: '', // optional + borderRadius: 0, // optional + opacity: 0, // optional + rotation: -360, // optional + background: '', // optional + output: ImageFormat.jpg, // optional +) + +final file = File('path_to_file/filename.ext'); +file.writeAsBytesSync(bytes); + +// Displaying image preview +FutureBuilder( + future: storage.getFilePreview( + bucketId:'<BUCKET_ID>' , + fileId:'<FILE_ID>' , + width:0 , // optional + height:0 , // optional + gravity: ImageGravity.center, // optional + quality:0 , // optional + borderWidth:0 , // optional + borderColor:'' , // optional + borderRadius:0 , // optional + opacity:0 , // optional + rotation:-360 , // optional + background:'' , // optional + output: ImageFormat.jpg, // optional +), // Works for both public file and private file, for private files you need to be logged in + builder: (context, snapshot) { + return snapshot.hasData && snapshot.data != null + ? Image.memory(snapshot.data) + : CircularProgressIndicator(); + } +); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-flutter/examples/storage/get-file-view.md new file mode 100644 index 0000000000..802bfa89ef --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/storage/get-file-view.md @@ -0,0 +1,29 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Storage storage = Storage(client); + +// Downloading file +UInt8List bytes = await storage.getFileView( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', +) + +final file = File('path_to_file/filename.ext'); +file.writeAsBytesSync(bytes); + +// Displaying image preview +FutureBuilder( + future: storage.getFileView( + bucketId:'<BUCKET_ID>' , + fileId:'<FILE_ID>' , +), // Works for both public file and private file, for private files you need to be logged in + builder: (context, snapshot) { + return snapshot.hasData && snapshot.data != null + ? Image.memory(snapshot.data) + : CircularProgressIndicator(); + } +); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/get-file.md b/docs/examples/1.6.x/client-flutter/examples/storage/get-file.md new file mode 100644 index 0000000000..6127932b87 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/storage/get-file.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Storage storage = Storage(client); + +File result = await storage.getFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/list-files.md b/docs/examples/1.6.x/client-flutter/examples/storage/list-files.md new file mode 100644 index 0000000000..a72d279fe5 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/storage/list-files.md @@ -0,0 +1,13 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Storage storage = Storage(client); + +FileList result = await storage.listFiles( + bucketId: '<BUCKET_ID>', + queries: [], // optional + search: '<SEARCH>', // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/update-file.md b/docs/examples/1.6.x/client-flutter/examples/storage/update-file.md new file mode 100644 index 0000000000..320f24fb1e --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/storage/update-file.md @@ -0,0 +1,14 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Storage storage = Storage(client); + +File result = await storage.updateFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', + name: '<NAME>', // optional + permissions: ["read("any")"], // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/create-membership.md b/docs/examples/1.6.x/client-flutter/examples/teams/create-membership.md new file mode 100644 index 0000000000..b59c69c1ee --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/create-membership.md @@ -0,0 +1,17 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +Membership result = await teams.createMembership( + teamId: '<TEAM_ID>', + roles: [], + email: 'email@example.com', // optional + userId: '<USER_ID>', // optional + phone: '+12065550100', // optional + url: 'https://example.com', // optional + name: '<NAME>', // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/create.md b/docs/examples/1.6.x/client-flutter/examples/teams/create.md new file mode 100644 index 0000000000..2cd7e4b2b2 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/create.md @@ -0,0 +1,13 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +Team result = await teams.create( + teamId: '<TEAM_ID>', + name: '<NAME>', + roles: [], // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-flutter/examples/teams/delete-membership.md new file mode 100644 index 0000000000..6dfe00fda6 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/delete-membership.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +await teams.deleteMembership( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/delete.md b/docs/examples/1.6.x/client-flutter/examples/teams/delete.md new file mode 100644 index 0000000000..3f6de53a4b --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/delete.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +await teams.delete( + teamId: '<TEAM_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/get-membership.md b/docs/examples/1.6.x/client-flutter/examples/teams/get-membership.md new file mode 100644 index 0000000000..120c1294a0 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/get-membership.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +Membership result = await teams.getMembership( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-flutter/examples/teams/get-prefs.md new file mode 100644 index 0000000000..a8d41f2880 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/get-prefs.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +Preferences result = await teams.getPrefs( + teamId: '<TEAM_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/get.md b/docs/examples/1.6.x/client-flutter/examples/teams/get.md new file mode 100644 index 0000000000..c29cefa4a1 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/get.md @@ -0,0 +1,11 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +Team result = await teams.get( + teamId: '<TEAM_ID>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-flutter/examples/teams/list-memberships.md new file mode 100644 index 0000000000..98557687f2 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/list-memberships.md @@ -0,0 +1,13 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +MembershipList result = await teams.listMemberships( + teamId: '<TEAM_ID>', + queries: [], // optional + search: '<SEARCH>', // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/list.md b/docs/examples/1.6.x/client-flutter/examples/teams/list.md new file mode 100644 index 0000000000..3b70d3450d --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/list.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +TeamList result = await teams.list( + queries: [], // optional + search: '<SEARCH>', // optional +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-flutter/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..4e397747bb --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/update-membership-status.md @@ -0,0 +1,14 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +Membership result = await teams.updateMembershipStatus( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>', + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/update-membership.md b/docs/examples/1.6.x/client-flutter/examples/teams/update-membership.md new file mode 100644 index 0000000000..93514b96e3 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/update-membership.md @@ -0,0 +1,13 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +Membership result = await teams.updateMembership( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>', + roles: [], +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/update-name.md b/docs/examples/1.6.x/client-flutter/examples/teams/update-name.md new file mode 100644 index 0000000000..13623107eb --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/update-name.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +Team result = await teams.updateName( + teamId: '<TEAM_ID>', + name: '<NAME>', +); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-flutter/examples/teams/update-prefs.md new file mode 100644 index 0000000000..071bd95129 --- /dev/null +++ b/docs/examples/1.6.x/client-flutter/examples/teams/update-prefs.md @@ -0,0 +1,12 @@ +import 'package:appwrite/appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Teams teams = Teams(client); + +Preferences result = await teams.updatePrefs( + teamId: '<TEAM_ID>', + prefs: {}, +); diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-graphql/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..92c12acee5 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-anonymous-session.md @@ -0,0 +1,33 @@ +mutation { + accountCreateAnonymousSession { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-graphql/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..931bb4add0 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-email-password-session.md @@ -0,0 +1,36 @@ +mutation { + accountCreateEmailPasswordSession( + email: "email@example.com", + password: "password" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-email-token.md b/docs/examples/1.6.x/client-graphql/examples/account/create-email-token.md new file mode 100644 index 0000000000..de320b45ed --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-email-token.md @@ -0,0 +1,14 @@ +mutation { + accountCreateEmailToken( + userId: "<USER_ID>", + email: "email@example.com", + phrase: false + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-graphql/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..a5204f1256 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-j-w-t.md @@ -0,0 +1,5 @@ +mutation { + accountCreateJWT { + jwt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-graphql/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..4024a5b3a9 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,15 @@ +mutation { + accountCreateMagicURLToken( + userId: "<USER_ID>", + email: "email@example.com", + url: "https://example.com", + phrase: false + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..6b29292494 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-authenticator.md @@ -0,0 +1,8 @@ +mutation { + accountCreateMfaAuthenticator( + type: "totp" + ) { + secret + uri + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..eb5cba127d --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-challenge.md @@ -0,0 +1,10 @@ +mutation { + accountCreateMfaChallenge( + factor: "email" + ) { + _id + _createdAt + userId + expire + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..f39b7d080d --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,5 @@ +mutation { + accountCreateMfaRecoveryCodes { + recoveryCodes + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-graphql/examples/account/create-phone-token.md new file mode 100644 index 0000000000..b56c4eb4e4 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-phone-token.md @@ -0,0 +1,13 @@ +mutation { + accountCreatePhoneToken( + userId: "<USER_ID>", + phone: "+12065550100" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-graphql/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..a4cad59b1a --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-phone-verification.md @@ -0,0 +1,10 @@ +mutation { + accountCreatePhoneVerification { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-push-target.md b/docs/examples/1.6.x/client-graphql/examples/account/create-push-target.md new file mode 100644 index 0000000000..8a0fad387c --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-push-target.md @@ -0,0 +1,16 @@ +mutation { + accountCreatePushTarget( + targetId: "<TARGET_ID>", + identifier: "<IDENTIFIER>", + providerId: "<PROVIDER_ID>" + ) { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-recovery.md b/docs/examples/1.6.x/client-graphql/examples/account/create-recovery.md new file mode 100644 index 0000000000..ad31fd82d7 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-recovery.md @@ -0,0 +1,13 @@ +mutation { + accountCreateRecovery( + email: "email@example.com", + url: "https://example.com" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-session.md b/docs/examples/1.6.x/client-graphql/examples/account/create-session.md new file mode 100644 index 0000000000..f473d14207 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-session.md @@ -0,0 +1,36 @@ +mutation { + accountCreateSession( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-verification.md b/docs/examples/1.6.x/client-graphql/examples/account/create-verification.md new file mode 100644 index 0000000000..df50dda529 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create-verification.md @@ -0,0 +1,12 @@ +mutation { + accountCreateVerification( + url: "https://example.com" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create.md b/docs/examples/1.6.x/client-graphql/examples/account/create.md new file mode 100644 index 0000000000..3f8e3c3cf7 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/create.md @@ -0,0 +1,39 @@ +mutation { + accountCreate( + userId: "<USER_ID>", + email: "email@example.com", + password: "", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/delete-identity.md b/docs/examples/1.6.x/client-graphql/examples/account/delete-identity.md new file mode 100644 index 0000000000..f3c2e2e7b9 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/delete-identity.md @@ -0,0 +1,7 @@ +mutation { + accountDeleteIdentity( + identityId: "<IDENTITY_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-graphql/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..fc5486623a --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,7 @@ +mutation { + accountDeleteMfaAuthenticator( + type: "totp" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-graphql/examples/account/delete-push-target.md new file mode 100644 index 0000000000..894c0b2e02 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/delete-push-target.md @@ -0,0 +1,7 @@ +mutation { + accountDeletePushTarget( + targetId: "<TARGET_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/delete-session.md b/docs/examples/1.6.x/client-graphql/examples/account/delete-session.md new file mode 100644 index 0000000000..09aff38fdd --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/delete-session.md @@ -0,0 +1,7 @@ +mutation { + accountDeleteSession( + sessionId: "<SESSION_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-graphql/examples/account/delete-sessions.md new file mode 100644 index 0000000000..b0d61daa81 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/delete-sessions.md @@ -0,0 +1,5 @@ +mutation { + accountDeleteSessions { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-graphql/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..e2de72b57f --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,5 @@ +query { + accountGetMfaRecoveryCodes { + recoveryCodes + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/get-prefs.md b/docs/examples/1.6.x/client-graphql/examples/account/get-prefs.md new file mode 100644 index 0000000000..6cb48d2b58 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/get-prefs.md @@ -0,0 +1,5 @@ +query { + accountGetPrefs { + data + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/get-session.md b/docs/examples/1.6.x/client-graphql/examples/account/get-session.md new file mode 100644 index 0000000000..65c824f68b --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/get-session.md @@ -0,0 +1,35 @@ +query { + accountGetSession( + sessionId: "<SESSION_ID>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/get.md b/docs/examples/1.6.x/client-graphql/examples/account/get.md new file mode 100644 index 0000000000..e4db8f0e41 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/get.md @@ -0,0 +1,34 @@ +query { + accountGet { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/list-identities.md b/docs/examples/1.6.x/client-graphql/examples/account/list-identities.md new file mode 100644 index 0000000000..b7a2a6d39a --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/list-identities.md @@ -0,0 +1,19 @@ +query { + accountListIdentities( + queries: [] + ) { + total + identities { + _id + _createdAt + _updatedAt + userId + provider + providerUid + providerEmail + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/list-logs.md b/docs/examples/1.6.x/client-graphql/examples/account/list-logs.md new file mode 100644 index 0000000000..1e17b2f69f --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/list-logs.md @@ -0,0 +1,30 @@ +query { + accountListLogs( + queries: [] + ) { + total + logs { + event + userId + userEmail + userName + mode + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-graphql/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..2a78b901b3 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/list-mfa-factors.md @@ -0,0 +1,8 @@ +query { + accountListMfaFactors { + totp + phone + email + recoveryCode + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/list-sessions.md b/docs/examples/1.6.x/client-graphql/examples/account/list-sessions.md new file mode 100644 index 0000000000..6d45f1d4ae --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/list-sessions.md @@ -0,0 +1,36 @@ +query { + accountListSessions { + total + sessions { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-email.md b/docs/examples/1.6.x/client-graphql/examples/account/update-email.md new file mode 100644 index 0000000000..b207bad4bb --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-email.md @@ -0,0 +1,37 @@ +mutation { + accountUpdateEmail( + email: "email@example.com", + password: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-graphql/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..d2cd3d6ae5 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-m-f-a.md @@ -0,0 +1,36 @@ +mutation { + accountUpdateMFA( + mfa: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-graphql/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..075bc91d17 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,36 @@ +mutation { + accountUpdateMagicURLSession( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..c74062c7d4 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-authenticator.md @@ -0,0 +1,37 @@ +mutation { + accountUpdateMfaAuthenticator( + type: "totp", + otp: "<OTP>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..8237431bcf --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-challenge.md @@ -0,0 +1,8 @@ +mutation { + accountUpdateMfaChallenge( + challengeId: "<CHALLENGE_ID>", + otp: "<OTP>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..e706d2b9d7 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,5 @@ +mutation { + accountUpdateMfaRecoveryCodes { + recoveryCodes + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-name.md b/docs/examples/1.6.x/client-graphql/examples/account/update-name.md new file mode 100644 index 0000000000..850b5760a0 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-name.md @@ -0,0 +1,36 @@ +mutation { + accountUpdateName( + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-password.md b/docs/examples/1.6.x/client-graphql/examples/account/update-password.md new file mode 100644 index 0000000000..5904da0842 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-password.md @@ -0,0 +1,37 @@ +mutation { + accountUpdatePassword( + password: "", + oldPassword: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-graphql/examples/account/update-phone-session.md new file mode 100644 index 0000000000..199e774ab0 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-phone-session.md @@ -0,0 +1,36 @@ +mutation { + accountUpdatePhoneSession( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-graphql/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..dd62298bb9 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-phone-verification.md @@ -0,0 +1,13 @@ +mutation { + accountUpdatePhoneVerification( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-phone.md b/docs/examples/1.6.x/client-graphql/examples/account/update-phone.md new file mode 100644 index 0000000000..408a203300 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-phone.md @@ -0,0 +1,37 @@ +mutation { + accountUpdatePhone( + phone: "+12065550100", + password: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-prefs.md b/docs/examples/1.6.x/client-graphql/examples/account/update-prefs.md new file mode 100644 index 0000000000..40db7b43db --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-prefs.md @@ -0,0 +1,36 @@ +mutation { + accountUpdatePrefs( + prefs: "{}" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-push-target.md b/docs/examples/1.6.x/client-graphql/examples/account/update-push-target.md new file mode 100644 index 0000000000..059702dc97 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-push-target.md @@ -0,0 +1,15 @@ +mutation { + accountUpdatePushTarget( + targetId: "<TARGET_ID>", + identifier: "<IDENTIFIER>" + ) { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-recovery.md b/docs/examples/1.6.x/client-graphql/examples/account/update-recovery.md new file mode 100644 index 0000000000..2d15fdcaa1 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-recovery.md @@ -0,0 +1,14 @@ +mutation { + accountUpdateRecovery( + userId: "<USER_ID>", + secret: "<SECRET>", + password: "" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-session.md b/docs/examples/1.6.x/client-graphql/examples/account/update-session.md new file mode 100644 index 0000000000..29a8979872 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-session.md @@ -0,0 +1,35 @@ +mutation { + accountUpdateSession( + sessionId: "<SESSION_ID>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-status.md b/docs/examples/1.6.x/client-graphql/examples/account/update-status.md new file mode 100644 index 0000000000..aca8c098e7 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-status.md @@ -0,0 +1,34 @@ +mutation { + accountUpdateStatus { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-verification.md b/docs/examples/1.6.x/client-graphql/examples/account/update-verification.md new file mode 100644 index 0000000000..11e63c7da3 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/account/update-verification.md @@ -0,0 +1,13 @@ +mutation { + accountUpdateVerification( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-browser.md new file mode 100644 index 0000000000..817e1e54c2 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/avatars/get-browser.md @@ -0,0 +1,10 @@ +query { + avatarsGetBrowser( + code: "aa", + width: 0, + height: 0, + quality: 0 + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..e4b5dc18d9 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/avatars/get-credit-card.md @@ -0,0 +1,10 @@ +query { + avatarsGetCreditCard( + code: "amex", + width: 0, + height: 0, + quality: 0 + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..bfea71f498 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/avatars/get-favicon.md @@ -0,0 +1,7 @@ +query { + avatarsGetFavicon( + url: "https://example.com" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-flag.md new file mode 100644 index 0000000000..1502128581 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/avatars/get-flag.md @@ -0,0 +1,10 @@ +query { + avatarsGetFlag( + code: "af", + width: 0, + height: 0, + quality: 0 + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-image.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-image.md new file mode 100644 index 0000000000..3b9aa104dc --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/avatars/get-image.md @@ -0,0 +1,9 @@ +query { + avatarsGetImage( + url: "https://example.com", + width: 0, + height: 0 + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-initials.md new file mode 100644 index 0000000000..51ae36136b --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/avatars/get-initials.md @@ -0,0 +1,10 @@ +query { + avatarsGetInitials( + name: "<NAME>", + width: 0, + height: 0, + background: "" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..a19f218412 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/avatars/get-q-r.md @@ -0,0 +1,10 @@ +query { + avatarsGetQR( + text: "<TEXT>", + size: 1, + margin: 0, + download: false + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/databases/create-document.md b/docs/examples/1.6.x/client-graphql/examples/databases/create-document.md new file mode 100644 index 0000000000..4e2d90660b --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/databases/create-document.md @@ -0,0 +1,17 @@ +mutation { + databasesCreateDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: "{}", + permissions: ["read("any")"] + ) { + _id + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/databases/delete-document.md b/docs/examples/1.6.x/client-graphql/examples/databases/delete-document.md new file mode 100644 index 0000000000..848371bca0 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/databases/delete-document.md @@ -0,0 +1,9 @@ +mutation { + databasesDeleteDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/databases/get-document.md b/docs/examples/1.6.x/client-graphql/examples/databases/get-document.md new file mode 100644 index 0000000000..7cff0a18c1 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/databases/get-document.md @@ -0,0 +1,16 @@ +query { + databasesGetDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + queries: [] + ) { + _id + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/databases/list-documents.md b/docs/examples/1.6.x/client-graphql/examples/databases/list-documents.md new file mode 100644 index 0000000000..077d7c8f12 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/databases/list-documents.md @@ -0,0 +1,18 @@ +query { + databasesListDocuments( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [] + ) { + total + documents { + _id + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/databases/update-document.md b/docs/examples/1.6.x/client-graphql/examples/databases/update-document.md new file mode 100644 index 0000000000..5e80894620 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/databases/update-document.md @@ -0,0 +1,17 @@ +mutation { + databasesUpdateDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: "{}", + permissions: ["read("any")"] + ) { + _id + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/functions/create-execution.md b/docs/examples/1.6.x/client-graphql/examples/functions/create-execution.md new file mode 100644 index 0000000000..be459ee5ab --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/functions/create-execution.md @@ -0,0 +1,34 @@ +mutation { + functionsCreateExecution( + functionId: "<FUNCTION_ID>", + body: "<BODY>", + async: false, + path: "<PATH>", + method: "GET", + headers: "{}", + scheduledAt: "" + ) { + _id + _createdAt + _updatedAt + _permissions + functionId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/functions/get-execution.md b/docs/examples/1.6.x/client-graphql/examples/functions/get-execution.md new file mode 100644 index 0000000000..f9f8ef0552 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/functions/get-execution.md @@ -0,0 +1,29 @@ +query { + functionsGetExecution( + functionId: "<FUNCTION_ID>", + executionId: "<EXECUTION_ID>" + ) { + _id + _createdAt + _updatedAt + _permissions + functionId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/functions/list-executions.md b/docs/examples/1.6.x/client-graphql/examples/functions/list-executions.md new file mode 100644 index 0000000000..745ec32377 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/functions/list-executions.md @@ -0,0 +1,33 @@ +query { + functionsListExecutions( + functionId: "<FUNCTION_ID>", + queries: [], + search: "<SEARCH>" + ) { + total + executions { + _id + _createdAt + _updatedAt + _permissions + functionId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/get.md b/docs/examples/1.6.x/client-graphql/examples/locale/get.md new file mode 100644 index 0000000000..2b2bbcc1f1 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/locale/get.md @@ -0,0 +1,11 @@ +query { + localeGet { + ip + countryCode + country + continentCode + continent + eu + currency + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-codes.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-codes.md new file mode 100644 index 0000000000..0164cc3782 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/locale/list-codes.md @@ -0,0 +1,9 @@ +query { + localeListCodes { + total + localeCodes { + code + name + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-continents.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-continents.md new file mode 100644 index 0000000000..41f672c565 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/locale/list-continents.md @@ -0,0 +1,9 @@ +query { + localeListContinents { + total + continents { + name + code + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..00cd4652f9 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-e-u.md @@ -0,0 +1,9 @@ +query { + localeListCountriesEU { + total + countries { + name + code + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..33d2296850 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-phones.md @@ -0,0 +1,10 @@ +query { + localeListCountriesPhones { + total + phones { + code + countryCode + countryName + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-countries.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-countries.md new file mode 100644 index 0000000000..9312bc94b1 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/locale/list-countries.md @@ -0,0 +1,9 @@ +query { + localeListCountries { + total + countries { + name + code + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-currencies.md new file mode 100644 index 0000000000..cde3ab488a --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/locale/list-currencies.md @@ -0,0 +1,14 @@ +query { + localeListCurrencies { + total + currencies { + symbol + name + symbolNative + decimalDigits + rounding + code + namePlural + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-languages.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-languages.md new file mode 100644 index 0000000000..b0d76c522b --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/locale/list-languages.md @@ -0,0 +1,10 @@ +query { + localeListLanguages { + total + languages { + name + code + nativeName + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-graphql/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..b2712ebb48 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/messaging/create-subscriber.md @@ -0,0 +1,26 @@ +mutation { + messagingCreateSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>", + targetId: "<TARGET_ID>" + ) { + _id + _createdAt + _updatedAt + targetId + target { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + userId + userName + topicId + providerType + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-graphql/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..ededffcaac --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/messaging/delete-subscriber.md @@ -0,0 +1,8 @@ +mutation { + messagingDeleteSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/create-file.md b/docs/examples/1.6.x/client-graphql/examples/storage/create-file.md new file mode 100644 index 0000000000..ef4b5d1eb3 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/storage/create-file.md @@ -0,0 +1,25 @@ +POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> +Content-Length: *Length of your entity body in bytes* + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="operations" + +{ "query": "mutation { storageCreateFile(bucketId: $bucketId, fileId: $fileId, file: $file, permissions: $permissions) { id }" }, "variables": { "bucketId": "<BUCKET_ID>", "fileId": "<FILE_ID>", "file": null, "permissions": ["read("any")"] } } + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="map" + +{ "0": ["variables.file"], } + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="0"; filename="file.ext" + +File contents + +--cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/delete-file.md b/docs/examples/1.6.x/client-graphql/examples/storage/delete-file.md new file mode 100644 index 0000000000..17ec89931a --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/storage/delete-file.md @@ -0,0 +1,8 @@ +mutation { + storageDeleteFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-graphql/examples/storage/get-file-download.md new file mode 100644 index 0000000000..8325e8a230 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/storage/get-file-download.md @@ -0,0 +1,8 @@ +query { + storageGetFileDownload( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-graphql/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..df32e88350 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/storage/get-file-preview.md @@ -0,0 +1,19 @@ +query { + storageGetFilePreview( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + width: 0, + height: 0, + gravity: "center", + quality: 0, + borderWidth: 0, + borderColor: "", + borderRadius: 0, + opacity: 0, + rotation: -360, + background: "", + output: "jpg" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-graphql/examples/storage/get-file-view.md new file mode 100644 index 0000000000..434328a1ec --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/storage/get-file-view.md @@ -0,0 +1,8 @@ +query { + storageGetFileView( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/get-file.md b/docs/examples/1.6.x/client-graphql/examples/storage/get-file.md new file mode 100644 index 0000000000..60886b0f6f --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/storage/get-file.md @@ -0,0 +1,18 @@ +query { + storageGetFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" + ) { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + chunksTotal + chunksUploaded + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/list-files.md b/docs/examples/1.6.x/client-graphql/examples/storage/list-files.md new file mode 100644 index 0000000000..774cc51b97 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/storage/list-files.md @@ -0,0 +1,22 @@ +query { + storageListFiles( + bucketId: "<BUCKET_ID>", + queries: [], + search: "<SEARCH>" + ) { + total + files { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + chunksTotal + chunksUploaded + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/update-file.md b/docs/examples/1.6.x/client-graphql/examples/storage/update-file.md new file mode 100644 index 0000000000..b7832048c7 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/storage/update-file.md @@ -0,0 +1,20 @@ +mutation { + storageUpdateFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + name: "<NAME>", + permissions: ["read("any")"] + ) { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + chunksTotal + chunksUploaded + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/create-membership.md b/docs/examples/1.6.x/client-graphql/examples/teams/create-membership.md new file mode 100644 index 0000000000..fe741f080d --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/create-membership.md @@ -0,0 +1,25 @@ +mutation { + teamsCreateMembership( + teamId: "<TEAM_ID>", + roles: [], + email: "email@example.com", + userId: "<USER_ID>", + phone: "+12065550100", + url: "https://example.com", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + teamId + teamName + invited + joined + confirm + mfa + roles + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/create.md b/docs/examples/1.6.x/client-graphql/examples/teams/create.md new file mode 100644 index 0000000000..1f2a7ab3f2 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/create.md @@ -0,0 +1,16 @@ +mutation { + teamsCreate( + teamId: "<TEAM_ID>", + name: "<NAME>", + roles: [] + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-graphql/examples/teams/delete-membership.md new file mode 100644 index 0000000000..e391b6f6fa --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/delete-membership.md @@ -0,0 +1,8 @@ +mutation { + teamsDeleteMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/delete.md b/docs/examples/1.6.x/client-graphql/examples/teams/delete.md new file mode 100644 index 0000000000..df0d36c5b5 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/delete.md @@ -0,0 +1,7 @@ +mutation { + teamsDelete( + teamId: "<TEAM_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/get-membership.md b/docs/examples/1.6.x/client-graphql/examples/teams/get-membership.md new file mode 100644 index 0000000000..c33528609e --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/get-membership.md @@ -0,0 +1,20 @@ +query { + teamsGetMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + teamId + teamName + invited + joined + confirm + mfa + roles + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-graphql/examples/teams/get-prefs.md new file mode 100644 index 0000000000..fe498079cf --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/get-prefs.md @@ -0,0 +1,7 @@ +query { + teamsGetPrefs( + teamId: "<TEAM_ID>" + ) { + data + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/get.md b/docs/examples/1.6.x/client-graphql/examples/teams/get.md new file mode 100644 index 0000000000..a3fbb491e0 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/get.md @@ -0,0 +1,14 @@ +query { + teamsGet( + teamId: "<TEAM_ID>" + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-graphql/examples/teams/list-memberships.md new file mode 100644 index 0000000000..bf7f0d1eed --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/list-memberships.md @@ -0,0 +1,24 @@ +query { + teamsListMemberships( + teamId: "<TEAM_ID>", + queries: [], + search: "<SEARCH>" + ) { + total + memberships { + _id + _createdAt + _updatedAt + userId + userName + userEmail + teamId + teamName + invited + joined + confirm + mfa + roles + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/list.md b/docs/examples/1.6.x/client-graphql/examples/teams/list.md new file mode 100644 index 0000000000..e7005b5326 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/list.md @@ -0,0 +1,18 @@ +query { + teamsList( + queries: [], + search: "<SEARCH>" + ) { + total + teams { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-graphql/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..9b24450a86 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/update-membership-status.md @@ -0,0 +1,22 @@ +mutation { + teamsUpdateMembershipStatus( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + teamId + teamName + invited + joined + confirm + mfa + roles + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/update-membership.md b/docs/examples/1.6.x/client-graphql/examples/teams/update-membership.md new file mode 100644 index 0000000000..1c6a04f078 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/update-membership.md @@ -0,0 +1,21 @@ +mutation { + teamsUpdateMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + roles: [] + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + teamId + teamName + invited + joined + confirm + mfa + roles + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/update-name.md b/docs/examples/1.6.x/client-graphql/examples/teams/update-name.md new file mode 100644 index 0000000000..c40543b5cd --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/update-name.md @@ -0,0 +1,15 @@ +mutation { + teamsUpdateName( + teamId: "<TEAM_ID>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-graphql/examples/teams/update-prefs.md new file mode 100644 index 0000000000..95737e33f9 --- /dev/null +++ b/docs/examples/1.6.x/client-graphql/examples/teams/update-prefs.md @@ -0,0 +1,8 @@ +mutation { + teamsUpdatePrefs( + teamId: "<TEAM_ID>", + prefs: "{}" + ) { + data + } +} diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-react-native/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..d855c379d4 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-anonymous-session.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createAnonymousSession(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-react-native/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..9600a094c9 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-email-password-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createEmailPasswordSession( + 'email@example.com', // email + 'password' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-email-token.md b/docs/examples/1.6.x/client-react-native/examples/account/create-email-token.md new file mode 100644 index 0000000000..46756da4b1 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-email-token.md @@ -0,0 +1,15 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createEmailToken( + '<USER_ID>', // userId + 'email@example.com', // email + false // phrase (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-react-native/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..e8c7ea61aa --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-j-w-t.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createJWT(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-react-native/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..10d687f8f9 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,16 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMagicURLToken( + '<USER_ID>', // userId + 'email@example.com', // email + 'https://example.com', // url (optional) + false // phrase (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..cd0a0db104 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-authenticator.md @@ -0,0 +1,13 @@ +import { Client, Account, AuthenticatorType } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMfaAuthenticator( + AuthenticatorType.Totp // type +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..0a4d0e7965 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-challenge.md @@ -0,0 +1,13 @@ +import { Client, Account, AuthenticationFactor } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMfaChallenge( + AuthenticationFactor.Email // factor +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..3282913816 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMfaRecoveryCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2session.md new file mode 100644 index 0000000000..06d96a2e2c --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2session.md @@ -0,0 +1,15 @@ +import { Client, Account, OAuthProvider } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +account.createOAuth2Session( + OAuthProvider.Amazon, // provider + 'https://example.com', // success (optional) + 'https://example.com', // failure (optional) + [] // scopes (optional) +); + diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..8711a64697 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2token.md @@ -0,0 +1,15 @@ +import { Client, Account, OAuthProvider } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +account.createOAuth2Token( + OAuthProvider.Amazon, // provider + 'https://example.com', // success (optional) + 'https://example.com', // failure (optional) + [] // scopes (optional) +); + diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-react-native/examples/account/create-phone-token.md new file mode 100644 index 0000000000..7e888fe5f5 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-phone-token.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createPhoneToken( + '<USER_ID>', // userId + '+12065550100' // phone +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-react-native/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..f87609a889 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-phone-verification.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createPhoneVerification(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-push-target.md b/docs/examples/1.6.x/client-react-native/examples/account/create-push-target.md new file mode 100644 index 0000000000..23edfc5a8c --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-push-target.md @@ -0,0 +1,15 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createPushTarget( + '<TARGET_ID>', // targetId + '<IDENTIFIER>', // identifier + '<PROVIDER_ID>' // providerId (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-recovery.md b/docs/examples/1.6.x/client-react-native/examples/account/create-recovery.md new file mode 100644 index 0000000000..f720d29aff --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-recovery.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createRecovery( + 'email@example.com', // email + 'https://example.com' // url +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-session.md b/docs/examples/1.6.x/client-react-native/examples/account/create-session.md new file mode 100644 index 0000000000..ffa927c1f7 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-verification.md b/docs/examples/1.6.x/client-react-native/examples/account/create-verification.md new file mode 100644 index 0000000000..b0ccc747cc --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create-verification.md @@ -0,0 +1,13 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createVerification( + 'https://example.com' // url +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create.md b/docs/examples/1.6.x/client-react-native/examples/account/create.md new file mode 100644 index 0000000000..28392f294b --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/create.md @@ -0,0 +1,16 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.create( + '<USER_ID>', // userId + 'email@example.com', // email + '', // password + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/delete-identity.md b/docs/examples/1.6.x/client-react-native/examples/account/delete-identity.md new file mode 100644 index 0000000000..d64d421779 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/delete-identity.md @@ -0,0 +1,13 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteIdentity( + '<IDENTITY_ID>' // identityId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-react-native/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..576f6ab71a --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,13 @@ +import { Client, Account, AuthenticatorType } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteMfaAuthenticator( + AuthenticatorType.Totp // type +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-react-native/examples/account/delete-push-target.md new file mode 100644 index 0000000000..06d5ca4281 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/delete-push-target.md @@ -0,0 +1,13 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deletePushTarget( + '<TARGET_ID>' // targetId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/delete-session.md b/docs/examples/1.6.x/client-react-native/examples/account/delete-session.md new file mode 100644 index 0000000000..19c15ac240 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/delete-session.md @@ -0,0 +1,13 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteSession( + '<SESSION_ID>' // sessionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-react-native/examples/account/delete-sessions.md new file mode 100644 index 0000000000..707894f87e --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/delete-sessions.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteSessions(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-react-native/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..037c9f89b1 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.getMfaRecoveryCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/get-prefs.md b/docs/examples/1.6.x/client-react-native/examples/account/get-prefs.md new file mode 100644 index 0000000000..1e287b1356 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/get-prefs.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.getPrefs(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/get-session.md b/docs/examples/1.6.x/client-react-native/examples/account/get-session.md new file mode 100644 index 0000000000..5702e1cfa1 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/get-session.md @@ -0,0 +1,13 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.getSession( + '<SESSION_ID>' // sessionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/get.md b/docs/examples/1.6.x/client-react-native/examples/account/get.md new file mode 100644 index 0000000000..f6eb57d485 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/get.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.get(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/list-identities.md b/docs/examples/1.6.x/client-react-native/examples/account/list-identities.md new file mode 100644 index 0000000000..ed979959bc --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/list-identities.md @@ -0,0 +1,13 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listIdentities( + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/list-logs.md b/docs/examples/1.6.x/client-react-native/examples/account/list-logs.md new file mode 100644 index 0000000000..cbe8c1553e --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/list-logs.md @@ -0,0 +1,13 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listLogs( + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-react-native/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..1903b161a7 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/list-mfa-factors.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listMfaFactors(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/list-sessions.md b/docs/examples/1.6.x/client-react-native/examples/account/list-sessions.md new file mode 100644 index 0000000000..2a361ad9f9 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/list-sessions.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listSessions(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-email.md b/docs/examples/1.6.x/client-react-native/examples/account/update-email.md new file mode 100644 index 0000000000..1fe1395f48 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-email.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateEmail( + 'email@example.com', // email + 'password' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-react-native/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..a6b7d64cf7 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-m-f-a.md @@ -0,0 +1,13 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMFA( + false // mfa +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-react-native/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..93b3df9d6d --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMagicURLSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..babd600ded --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-authenticator.md @@ -0,0 +1,14 @@ +import { Client, Account, AuthenticatorType } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMfaAuthenticator( + AuthenticatorType.Totp, // type + '<OTP>' // otp +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..6fe5336d95 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-challenge.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMfaChallenge( + '<CHALLENGE_ID>', // challengeId + '<OTP>' // otp +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..ecd05692ef --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMfaRecoveryCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-name.md b/docs/examples/1.6.x/client-react-native/examples/account/update-name.md new file mode 100644 index 0000000000..6643ba6d33 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-name.md @@ -0,0 +1,13 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateName( + '<NAME>' // name +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-password.md b/docs/examples/1.6.x/client-react-native/examples/account/update-password.md new file mode 100644 index 0000000000..b462b0429a --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-password.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePassword( + '', // password + 'password' // oldPassword (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-react-native/examples/account/update-phone-session.md new file mode 100644 index 0000000000..ed9729a11b --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-phone-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePhoneSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-react-native/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..65caeddd8e --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-phone-verification.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePhoneVerification( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-phone.md b/docs/examples/1.6.x/client-react-native/examples/account/update-phone.md new file mode 100644 index 0000000000..8e08328e76 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-phone.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePhone( + '+12065550100', // phone + 'password' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-prefs.md b/docs/examples/1.6.x/client-react-native/examples/account/update-prefs.md new file mode 100644 index 0000000000..e5e7012bed --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-prefs.md @@ -0,0 +1,13 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePrefs( + {} // prefs +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-push-target.md b/docs/examples/1.6.x/client-react-native/examples/account/update-push-target.md new file mode 100644 index 0000000000..a795acd58d --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-push-target.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePushTarget( + '<TARGET_ID>', // targetId + '<IDENTIFIER>' // identifier +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-recovery.md b/docs/examples/1.6.x/client-react-native/examples/account/update-recovery.md new file mode 100644 index 0000000000..8956b4d9d1 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-recovery.md @@ -0,0 +1,15 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateRecovery( + '<USER_ID>', // userId + '<SECRET>', // secret + '' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-session.md b/docs/examples/1.6.x/client-react-native/examples/account/update-session.md new file mode 100644 index 0000000000..57d4593f34 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-session.md @@ -0,0 +1,13 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateSession( + '<SESSION_ID>' // sessionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-status.md b/docs/examples/1.6.x/client-react-native/examples/account/update-status.md new file mode 100644 index 0000000000..2cb1045ff8 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-status.md @@ -0,0 +1,11 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateStatus(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-verification.md b/docs/examples/1.6.x/client-react-native/examples/account/update-verification.md new file mode 100644 index 0000000000..80e885764b --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/account/update-verification.md @@ -0,0 +1,14 @@ +import { Client, Account } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateVerification( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-browser.md new file mode 100644 index 0000000000..404f9af77b --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/avatars/get-browser.md @@ -0,0 +1,16 @@ +import { Client, Avatars, Browser } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getBrowser( + Browser.AvantBrowser, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..a34ab2b603 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/avatars/get-credit-card.md @@ -0,0 +1,16 @@ +import { Client, Avatars, CreditCard } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getCreditCard( + CreditCard.AmericanExpress, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..c3ad663aff --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/avatars/get-favicon.md @@ -0,0 +1,13 @@ +import { Client, Avatars } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getFavicon( + 'https://example.com' // url +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-flag.md new file mode 100644 index 0000000000..23698ac670 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/avatars/get-flag.md @@ -0,0 +1,16 @@ +import { Client, Avatars, Flag } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getFlag( + Flag.Afghanistan, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-image.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-image.md new file mode 100644 index 0000000000..915f5b0d4a --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/avatars/get-image.md @@ -0,0 +1,15 @@ +import { Client, Avatars } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getImage( + 'https://example.com', // url + 0, // width (optional) + 0 // height (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-initials.md new file mode 100644 index 0000000000..c5190514f4 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/avatars/get-initials.md @@ -0,0 +1,16 @@ +import { Client, Avatars } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getInitials( + '<NAME>', // name (optional) + 0, // width (optional) + 0, // height (optional) + '' // background (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..1191da7787 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/avatars/get-q-r.md @@ -0,0 +1,16 @@ +import { Client, Avatars } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getQR( + '<TEXT>', // text + 1, // size (optional) + 0, // margin (optional) + false // download (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/databases/create-document.md b/docs/examples/1.6.x/client-react-native/examples/databases/create-document.md new file mode 100644 index 0000000000..9c6a747254 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/databases/create-document.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + {}, // data + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/databases/delete-document.md b/docs/examples/1.6.x/client-react-native/examples/databases/delete-document.md new file mode 100644 index 0000000000..dad2ecdf4e --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/databases/delete-document.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.deleteDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>' // documentId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/databases/get-document.md b/docs/examples/1.6.x/client-react-native/examples/databases/get-document.md new file mode 100644 index 0000000000..aa63eb2378 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/databases/get-document.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.getDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/databases/list-documents.md b/docs/examples/1.6.x/client-react-native/examples/databases/list-documents.md new file mode 100644 index 0000000000..2de7ad2441 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/databases/list-documents.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.listDocuments( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/databases/update-document.md b/docs/examples/1.6.x/client-react-native/examples/databases/update-document.md new file mode 100644 index 0000000000..7c8f51d4e9 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/databases/update-document.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + {}, // data (optional) + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/functions/create-execution.md b/docs/examples/1.6.x/client-react-native/examples/functions/create-execution.md new file mode 100644 index 0000000000..3d2c88768e --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/functions/create-execution.md @@ -0,0 +1,19 @@ +import { Client, Functions, ExecutionMethod } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.createExecution( + '<FUNCTION_ID>', // functionId + '<BODY>', // body (optional) + false, // async (optional) + '<PATH>', // path (optional) + ExecutionMethod.GET, // method (optional) + {}, // headers (optional) + '' // scheduledAt (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/functions/get-execution.md b/docs/examples/1.6.x/client-react-native/examples/functions/get-execution.md new file mode 100644 index 0000000000..4b9a00256e --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/functions/get-execution.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.getExecution( + '<FUNCTION_ID>', // functionId + '<EXECUTION_ID>' // executionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/functions/list-executions.md b/docs/examples/1.6.x/client-react-native/examples/functions/list-executions.md new file mode 100644 index 0000000000..5bf1c15a3b --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/functions/list-executions.md @@ -0,0 +1,15 @@ +import { Client, Functions } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.listExecutions( + '<FUNCTION_ID>', // functionId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/graphql/mutation.md b/docs/examples/1.6.x/client-react-native/examples/graphql/mutation.md new file mode 100644 index 0000000000..836d33adf9 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/graphql/mutation.md @@ -0,0 +1,13 @@ +import { Client, Graphql } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const graphql = new Graphql(client); + +const result = await graphql.mutation( + {} // query +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/graphql/query.md b/docs/examples/1.6.x/client-react-native/examples/graphql/query.md new file mode 100644 index 0000000000..a6a34d4ceb --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/graphql/query.md @@ -0,0 +1,13 @@ +import { Client, Graphql } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const graphql = new Graphql(client); + +const result = await graphql.query( + {} // query +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/get.md b/docs/examples/1.6.x/client-react-native/examples/locale/get.md new file mode 100644 index 0000000000..151e125104 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/locale/get.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.get(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-codes.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-codes.md new file mode 100644 index 0000000000..ade8c98a27 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/locale/list-codes.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-continents.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-continents.md new file mode 100644 index 0000000000..8924cbacef --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/locale/list-continents.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listContinents(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..24677ef501 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-e-u.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCountriesEU(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..2c4a2331cc --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-phones.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCountriesPhones(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-countries.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-countries.md new file mode 100644 index 0000000000..785faab399 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/locale/list-countries.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCountries(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-currencies.md new file mode 100644 index 0000000000..20a876e8f7 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/locale/list-currencies.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCurrencies(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-languages.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-languages.md new file mode 100644 index 0000000000..e15eb61bc0 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/locale/list-languages.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listLanguages(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-react-native/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..c6a1f94c32 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/messaging/create-subscriber.md @@ -0,0 +1,15 @@ +import { Client, Messaging } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>', // subscriberId + '<TARGET_ID>' // targetId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-react-native/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..4232dccbcb --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/messaging/delete-subscriber.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.deleteSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>' // subscriberId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/create-file.md b/docs/examples/1.6.x/client-react-native/examples/storage/create-file.md new file mode 100644 index 0000000000..abeee020e7 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/storage/create-file.md @@ -0,0 +1,16 @@ +import { Client, Storage } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.createFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + await pickSingle(), // file + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/delete-file.md b/docs/examples/1.6.x/client-react-native/examples/storage/delete-file.md new file mode 100644 index 0000000000..af7136c87b --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/storage/delete-file.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.deleteFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-react-native/examples/storage/get-file-download.md new file mode 100644 index 0000000000..740cb26058 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/storage/get-file-download.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = storage.getFileDownload( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-react-native/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..0fb97a1633 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/storage/get-file-preview.md @@ -0,0 +1,25 @@ +import { Client, Storage, ImageGravity, ImageFormat } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = storage.getFilePreview( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + 0, // width (optional) + 0, // height (optional) + ImageGravity.Center, // gravity (optional) + 0, // quality (optional) + 0, // borderWidth (optional) + '', // borderColor (optional) + 0, // borderRadius (optional) + 0, // opacity (optional) + -360, // rotation (optional) + '', // background (optional) + ImageFormat.Jpg // output (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-react-native/examples/storage/get-file-view.md new file mode 100644 index 0000000000..4628bc0992 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/storage/get-file-view.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = storage.getFileView( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/get-file.md b/docs/examples/1.6.x/client-react-native/examples/storage/get-file.md new file mode 100644 index 0000000000..3f9c4a0498 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/storage/get-file.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.getFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/list-files.md b/docs/examples/1.6.x/client-react-native/examples/storage/list-files.md new file mode 100644 index 0000000000..0d81716948 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/storage/list-files.md @@ -0,0 +1,15 @@ +import { Client, Storage } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.listFiles( + '<BUCKET_ID>', // bucketId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/update-file.md b/docs/examples/1.6.x/client-react-native/examples/storage/update-file.md new file mode 100644 index 0000000000..4e6ed70572 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/storage/update-file.md @@ -0,0 +1,16 @@ +import { Client, Storage } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.updateFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + '<NAME>', // name (optional) + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/create-membership.md b/docs/examples/1.6.x/client-react-native/examples/teams/create-membership.md new file mode 100644 index 0000000000..0759c035a8 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/create-membership.md @@ -0,0 +1,19 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.createMembership( + '<TEAM_ID>', // teamId + [], // roles + 'email@example.com', // email (optional) + '<USER_ID>', // userId (optional) + '+12065550100', // phone (optional) + 'https://example.com', // url (optional) + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/create.md b/docs/examples/1.6.x/client-react-native/examples/teams/create.md new file mode 100644 index 0000000000..3e24dcab9e --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/create.md @@ -0,0 +1,15 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.create( + '<TEAM_ID>', // teamId + '<NAME>', // name + [] // roles (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-react-native/examples/teams/delete-membership.md new file mode 100644 index 0000000000..92b00c71f1 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/delete-membership.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.deleteMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/delete.md b/docs/examples/1.6.x/client-react-native/examples/teams/delete.md new file mode 100644 index 0000000000..e51e465173 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/delete.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.delete( + '<TEAM_ID>' // teamId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/get-membership.md b/docs/examples/1.6.x/client-react-native/examples/teams/get-membership.md new file mode 100644 index 0000000000..b5fb0dd481 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/get-membership.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.getMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-react-native/examples/teams/get-prefs.md new file mode 100644 index 0000000000..1baee59dee --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/get-prefs.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.getPrefs( + '<TEAM_ID>' // teamId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/get.md b/docs/examples/1.6.x/client-react-native/examples/teams/get.md new file mode 100644 index 0000000000..a4aabd072d --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/get.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.get( + '<TEAM_ID>' // teamId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-react-native/examples/teams/list-memberships.md new file mode 100644 index 0000000000..7d16a57c21 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/list-memberships.md @@ -0,0 +1,15 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.listMemberships( + '<TEAM_ID>', // teamId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/list.md b/docs/examples/1.6.x/client-react-native/examples/teams/list.md new file mode 100644 index 0000000000..fcf459e244 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/list.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-react-native/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..e60e31b4fb --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/update-membership-status.md @@ -0,0 +1,16 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updateMembershipStatus( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/update-membership.md b/docs/examples/1.6.x/client-react-native/examples/teams/update-membership.md new file mode 100644 index 0000000000..4201207a14 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/update-membership.md @@ -0,0 +1,15 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updateMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId + [] // roles +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/update-name.md b/docs/examples/1.6.x/client-react-native/examples/teams/update-name.md new file mode 100644 index 0000000000..a8ecbc27ca --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/update-name.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updateName( + '<TEAM_ID>', // teamId + '<NAME>' // name +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-react-native/examples/teams/update-prefs.md new file mode 100644 index 0000000000..944ed43281 --- /dev/null +++ b/docs/examples/1.6.x/client-react-native/examples/teams/update-prefs.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "react-native-appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updatePrefs( + '<TEAM_ID>', // teamId + {} // prefs +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-rest/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..772e31903e --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-anonymous-session.md @@ -0,0 +1,6 @@ +POST /v1/account/sessions/anonymous HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-rest/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..bee865dac0 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-email-password-session.md @@ -0,0 +1,10 @@ +POST /v1/account/sessions/email HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "email": "email@example.com", + "password": "password" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-email-token.md b/docs/examples/1.6.x/client-rest/examples/account/create-email-token.md new file mode 100644 index 0000000000..206711b906 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-email-token.md @@ -0,0 +1,11 @@ +POST /v1/account/tokens/email HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "phrase": false +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-rest/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..83169a46f9 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-j-w-t.md @@ -0,0 +1,6 @@ +POST /v1/account/jwts HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-rest/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..43b946c7b6 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,12 @@ +POST /v1/account/tokens/magic-url HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "url": "https://example.com", + "phrase": false +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-rest/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..baacbbe18b --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-mfa-authenticator.md @@ -0,0 +1,8 @@ +POST /v1/account/mfa/authenticators/{type} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-rest/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..991710a0cb --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-mfa-challenge.md @@ -0,0 +1,9 @@ +POST /v1/account/mfa/challenge HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "factor": "email" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-rest/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..b7214f244d --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,8 @@ +POST /v1/account/mfa/recovery-codes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2session.md new file mode 100644 index 0000000000..d7b113f675 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2session.md @@ -0,0 +1,6 @@ +GET /v1/account/sessions/oauth2/{provider} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..99abb6d4a9 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2token.md @@ -0,0 +1,6 @@ +GET /v1/account/tokens/oauth2/{provider} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-rest/examples/account/create-phone-token.md new file mode 100644 index 0000000000..4a9a99c949 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-phone-token.md @@ -0,0 +1,10 @@ +POST /v1/account/tokens/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "phone": "+12065550100" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-rest/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..3811b6a523 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-phone-verification.md @@ -0,0 +1,8 @@ +POST /v1/account/verification/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-push-target.md b/docs/examples/1.6.x/client-rest/examples/account/create-push-target.md new file mode 100644 index 0000000000..0c92fa059e --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-push-target.md @@ -0,0 +1,12 @@ +POST /v1/account/targets/push HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: + +{ + "targetId": "<TARGET_ID>", + "identifier": "<IDENTIFIER>", + "providerId": "<PROVIDER_ID>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-recovery.md b/docs/examples/1.6.x/client-rest/examples/account/create-recovery.md new file mode 100644 index 0000000000..f8f0a9cdd6 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-recovery.md @@ -0,0 +1,12 @@ +POST /v1/account/recovery HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "email": "email@example.com", + "url": "https://example.com" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-session.md b/docs/examples/1.6.x/client-rest/examples/account/create-session.md new file mode 100644 index 0000000000..2a9108c0f4 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-session.md @@ -0,0 +1,10 @@ +POST /v1/account/sessions/token HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-verification.md b/docs/examples/1.6.x/client-rest/examples/account/create-verification.md new file mode 100644 index 0000000000..7582b81d01 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create-verification.md @@ -0,0 +1,11 @@ +POST /v1/account/verification HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "url": "https://example.com" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create.md b/docs/examples/1.6.x/client-rest/examples/account/create.md new file mode 100644 index 0000000000..ec4b11df00 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/create.md @@ -0,0 +1,12 @@ +POST /v1/account HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": , + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/delete-identity.md b/docs/examples/1.6.x/client-rest/examples/account/delete-identity.md new file mode 100644 index 0000000000..01df4d7e90 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/delete-identity.md @@ -0,0 +1,8 @@ +DELETE /v1/account/identities/{identityId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-rest/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..25b1733019 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,8 @@ +DELETE /v1/account/mfa/authenticators/{type} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-rest/examples/account/delete-push-target.md new file mode 100644 index 0000000000..fa972cedb3 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/delete-push-target.md @@ -0,0 +1,7 @@ +DELETE /v1/account/targets/{targetId}/push HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: + diff --git a/docs/examples/1.6.x/client-rest/examples/account/delete-session.md b/docs/examples/1.6.x/client-rest/examples/account/delete-session.md new file mode 100644 index 0000000000..f8d4c0035f --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/delete-session.md @@ -0,0 +1,8 @@ +DELETE /v1/account/sessions/{sessionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-rest/examples/account/delete-sessions.md new file mode 100644 index 0000000000..1e9d00b1ca --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/delete-sessions.md @@ -0,0 +1,8 @@ +DELETE /v1/account/sessions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-rest/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..cb27036775 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,8 @@ +GET /v1/account/mfa/recovery-codes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/get-prefs.md b/docs/examples/1.6.x/client-rest/examples/account/get-prefs.md new file mode 100644 index 0000000000..c0513aa8b6 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/get-prefs.md @@ -0,0 +1,8 @@ +GET /v1/account/prefs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/get-session.md b/docs/examples/1.6.x/client-rest/examples/account/get-session.md new file mode 100644 index 0000000000..64950545ec --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/get-session.md @@ -0,0 +1,8 @@ +GET /v1/account/sessions/{sessionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/get.md b/docs/examples/1.6.x/client-rest/examples/account/get.md new file mode 100644 index 0000000000..40841841e5 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/get.md @@ -0,0 +1,8 @@ +GET /v1/account HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/list-identities.md b/docs/examples/1.6.x/client-rest/examples/account/list-identities.md new file mode 100644 index 0000000000..2ea442b347 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/list-identities.md @@ -0,0 +1,8 @@ +GET /v1/account/identities HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/list-logs.md b/docs/examples/1.6.x/client-rest/examples/account/list-logs.md new file mode 100644 index 0000000000..9d1589e9a2 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/list-logs.md @@ -0,0 +1,8 @@ +GET /v1/account/logs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-rest/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..5b12a4948a --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/list-mfa-factors.md @@ -0,0 +1,8 @@ +GET /v1/account/mfa/factors HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/list-sessions.md b/docs/examples/1.6.x/client-rest/examples/account/list-sessions.md new file mode 100644 index 0000000000..39ee92bb20 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/list-sessions.md @@ -0,0 +1,8 @@ +GET /v1/account/sessions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-email.md b/docs/examples/1.6.x/client-rest/examples/account/update-email.md new file mode 100644 index 0000000000..4c9723d856 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-email.md @@ -0,0 +1,12 @@ +PATCH /v1/account/email HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "email": "email@example.com", + "password": "password" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-rest/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..668cc887a0 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-m-f-a.md @@ -0,0 +1,11 @@ +PATCH /v1/account/mfa HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "mfa": false +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-rest/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..b568b35c55 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,10 @@ +PUT /v1/account/sessions/magic-url HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-rest/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..3048091fb7 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-mfa-authenticator.md @@ -0,0 +1,11 @@ +PUT /v1/account/mfa/authenticators/{type} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "otp": "<OTP>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-rest/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..33d5fe45d5 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-mfa-challenge.md @@ -0,0 +1,12 @@ +PUT /v1/account/mfa/challenge HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "challengeId": "<CHALLENGE_ID>", + "otp": "<OTP>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-rest/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..353908edcf --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,8 @@ +PATCH /v1/account/mfa/recovery-codes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-name.md b/docs/examples/1.6.x/client-rest/examples/account/update-name.md new file mode 100644 index 0000000000..43d100c8f5 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-name.md @@ -0,0 +1,11 @@ +PATCH /v1/account/name HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-password.md b/docs/examples/1.6.x/client-rest/examples/account/update-password.md new file mode 100644 index 0000000000..e35d9a8c76 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-password.md @@ -0,0 +1,12 @@ +PATCH /v1/account/password HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "password": , + "oldPassword": "password" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-rest/examples/account/update-phone-session.md new file mode 100644 index 0000000000..540267f6d8 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-phone-session.md @@ -0,0 +1,10 @@ +PUT /v1/account/sessions/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-rest/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..301f0b1057 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-phone-verification.md @@ -0,0 +1,12 @@ +PUT /v1/account/verification/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-phone.md b/docs/examples/1.6.x/client-rest/examples/account/update-phone.md new file mode 100644 index 0000000000..ea35a1b8ca --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-phone.md @@ -0,0 +1,12 @@ +PATCH /v1/account/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "phone": "+12065550100", + "password": "password" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-prefs.md b/docs/examples/1.6.x/client-rest/examples/account/update-prefs.md new file mode 100644 index 0000000000..87af8ec625 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-prefs.md @@ -0,0 +1,11 @@ +PATCH /v1/account/prefs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "prefs": {} +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-push-target.md b/docs/examples/1.6.x/client-rest/examples/account/update-push-target.md new file mode 100644 index 0000000000..c3121581d7 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-push-target.md @@ -0,0 +1,10 @@ +PUT /v1/account/targets/{targetId}/push HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: + +{ + "identifier": "<IDENTIFIER>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-recovery.md b/docs/examples/1.6.x/client-rest/examples/account/update-recovery.md new file mode 100644 index 0000000000..77ae28a33d --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-recovery.md @@ -0,0 +1,13 @@ +PUT /v1/account/recovery HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>", + "password": +} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-session.md b/docs/examples/1.6.x/client-rest/examples/account/update-session.md new file mode 100644 index 0000000000..d8a7b97f3c --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-session.md @@ -0,0 +1,8 @@ +PATCH /v1/account/sessions/{sessionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-status.md b/docs/examples/1.6.x/client-rest/examples/account/update-status.md new file mode 100644 index 0000000000..b10060a866 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-status.md @@ -0,0 +1,8 @@ +PATCH /v1/account/status HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-verification.md b/docs/examples/1.6.x/client-rest/examples/account/update-verification.md new file mode 100644 index 0000000000..cd6c2f9e88 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/account/update-verification.md @@ -0,0 +1,12 @@ +PUT /v1/account/verification HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-browser.md new file mode 100644 index 0000000000..130e05757a --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/avatars/get-browser.md @@ -0,0 +1,8 @@ +GET /v1/avatars/browsers/{code} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..1f6b38fd87 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/avatars/get-credit-card.md @@ -0,0 +1,8 @@ +GET /v1/avatars/credit-cards/{code} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..6aafed5f0d --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/avatars/get-favicon.md @@ -0,0 +1,8 @@ +GET /v1/avatars/favicon HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-flag.md new file mode 100644 index 0000000000..e3af6e099d --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/avatars/get-flag.md @@ -0,0 +1,8 @@ +GET /v1/avatars/flags/{code} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-image.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-image.md new file mode 100644 index 0000000000..8d20675f53 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/avatars/get-image.md @@ -0,0 +1,8 @@ +GET /v1/avatars/image HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-initials.md new file mode 100644 index 0000000000..41cd233524 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/avatars/get-initials.md @@ -0,0 +1,8 @@ +GET /v1/avatars/initials HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..b90d67dc59 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/avatars/get-q-r.md @@ -0,0 +1,8 @@ +GET /v1/avatars/qr HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/databases/create-document.md b/docs/examples/1.6.x/client-rest/examples/databases/create-document.md new file mode 100644 index 0000000000..50de44da45 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/databases/create-document.md @@ -0,0 +1,13 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "documentId": "<DOCUMENT_ID>", + "data": {}, + "permissions": ["read(\"any\")"] +} diff --git a/docs/examples/1.6.x/client-rest/examples/databases/delete-document.md b/docs/examples/1.6.x/client-rest/examples/databases/delete-document.md new file mode 100644 index 0000000000..bd877ffd96 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/databases/delete-document.md @@ -0,0 +1,8 @@ +DELETE /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/databases/get-document.md b/docs/examples/1.6.x/client-rest/examples/databases/get-document.md new file mode 100644 index 0000000000..6de3095a04 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/databases/get-document.md @@ -0,0 +1,8 @@ +GET /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/databases/list-documents.md b/docs/examples/1.6.x/client-rest/examples/databases/list-documents.md new file mode 100644 index 0000000000..c338837769 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/databases/list-documents.md @@ -0,0 +1,8 @@ +GET /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/databases/update-document.md b/docs/examples/1.6.x/client-rest/examples/databases/update-document.md new file mode 100644 index 0000000000..4c5882f582 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/databases/update-document.md @@ -0,0 +1,12 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "data": {}, + "permissions": ["read(\"any\")"] +} diff --git a/docs/examples/1.6.x/client-rest/examples/functions/create-execution.md b/docs/examples/1.6.x/client-rest/examples/functions/create-execution.md new file mode 100644 index 0000000000..541d13c30e --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/functions/create-execution.md @@ -0,0 +1,16 @@ +POST /v1/functions/{functionId}/executions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "body": "<BODY>", + "async": false, + "path": "<PATH>", + "method": "GET", + "headers": {}, + "scheduledAt": +} diff --git a/docs/examples/1.6.x/client-rest/examples/functions/get-execution.md b/docs/examples/1.6.x/client-rest/examples/functions/get-execution.md new file mode 100644 index 0000000000..d59c883178 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/functions/get-execution.md @@ -0,0 +1,8 @@ +GET /v1/functions/{functionId}/executions/{executionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/functions/list-executions.md b/docs/examples/1.6.x/client-rest/examples/functions/list-executions.md new file mode 100644 index 0000000000..3c43c0f341 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/functions/list-executions.md @@ -0,0 +1,8 @@ +GET /v1/functions/{functionId}/executions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/graphql/mutation.md b/docs/examples/1.6.x/client-rest/examples/graphql/mutation.md new file mode 100644 index 0000000000..573dc07757 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/graphql/mutation.md @@ -0,0 +1,12 @@ +POST /v1/graphql/mutation HTTP/1.1 +Host: cloud.appwrite.io +X-Sdk-Graphql: true +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "query": {} +} diff --git a/docs/examples/1.6.x/client-rest/examples/graphql/query.md b/docs/examples/1.6.x/client-rest/examples/graphql/query.md new file mode 100644 index 0000000000..270ec569bf --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/graphql/query.md @@ -0,0 +1,12 @@ +POST /v1/graphql HTTP/1.1 +Host: cloud.appwrite.io +X-Sdk-Graphql: true +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "query": {} +} diff --git a/docs/examples/1.6.x/client-rest/examples/locale/get.md b/docs/examples/1.6.x/client-rest/examples/locale/get.md new file mode 100644 index 0000000000..c00b16494d --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/locale/get.md @@ -0,0 +1,8 @@ +GET /v1/locale HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-codes.md b/docs/examples/1.6.x/client-rest/examples/locale/list-codes.md new file mode 100644 index 0000000000..e10c3674be --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/locale/list-codes.md @@ -0,0 +1,8 @@ +GET /v1/locale/codes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-continents.md b/docs/examples/1.6.x/client-rest/examples/locale/list-continents.md new file mode 100644 index 0000000000..3b698d0fd3 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/locale/list-continents.md @@ -0,0 +1,8 @@ +GET /v1/locale/continents HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-rest/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..912c285b19 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/locale/list-countries-e-u.md @@ -0,0 +1,8 @@ +GET /v1/locale/countries/eu HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-rest/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..b99bf997d0 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/locale/list-countries-phones.md @@ -0,0 +1,8 @@ +GET /v1/locale/countries/phones HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-countries.md b/docs/examples/1.6.x/client-rest/examples/locale/list-countries.md new file mode 100644 index 0000000000..ab51b4c691 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/locale/list-countries.md @@ -0,0 +1,8 @@ +GET /v1/locale/countries HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-rest/examples/locale/list-currencies.md new file mode 100644 index 0000000000..f89cfed892 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/locale/list-currencies.md @@ -0,0 +1,8 @@ +GET /v1/locale/currencies HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-languages.md b/docs/examples/1.6.x/client-rest/examples/locale/list-languages.md new file mode 100644 index 0000000000..724aadbdd4 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/locale/list-languages.md @@ -0,0 +1,8 @@ +GET /v1/locale/languages HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-rest/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..8f4e462189 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/messaging/create-subscriber.md @@ -0,0 +1,12 @@ +POST /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-JWT: <YOUR_JWT> +X-Appwrite-Session: + +{ + "subscriberId": "<SUBSCRIBER_ID>", + "targetId": "<TARGET_ID>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-rest/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..55497e0987 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/messaging/delete-subscriber.md @@ -0,0 +1,8 @@ +DELETE /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-JWT: <YOUR_JWT> +X-Appwrite-Session: + diff --git a/docs/examples/1.6.x/client-rest/examples/storage/create-file.md b/docs/examples/1.6.x/client-rest/examples/storage/create-file.md new file mode 100644 index 0000000000..bde7a9dea5 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/storage/create-file.md @@ -0,0 +1,26 @@ +POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> +Content-Length: *Length of your entity body in bytes* + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="fileId" + +"<FILE_ID>" + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="file" + +cf 94 84 24 8d c4 91 10 0f dc 54 26 6c 8e 4b bc +e8 ee 55 94 29 e7 94 89 19 26 28 01 26 29 3f 16... + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="permissions[]" + +["read(\"any\")"] + +--cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/client-rest/examples/storage/delete-file.md b/docs/examples/1.6.x/client-rest/examples/storage/delete-file.md new file mode 100644 index 0000000000..5c8d28d9a4 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/storage/delete-file.md @@ -0,0 +1,8 @@ +DELETE /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-rest/examples/storage/get-file-download.md new file mode 100644 index 0000000000..4ddc88e346 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/storage/get-file-download.md @@ -0,0 +1,8 @@ +GET /v1/storage/buckets/{bucketId}/files/{fileId}/download HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-rest/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..3e73987a17 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/storage/get-file-preview.md @@ -0,0 +1,8 @@ +GET /v1/storage/buckets/{bucketId}/files/{fileId}/preview HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-rest/examples/storage/get-file-view.md new file mode 100644 index 0000000000..ad1069da81 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/storage/get-file-view.md @@ -0,0 +1,8 @@ +GET /v1/storage/buckets/{bucketId}/files/{fileId}/view HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/storage/get-file.md b/docs/examples/1.6.x/client-rest/examples/storage/get-file.md new file mode 100644 index 0000000000..91b68c1256 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/storage/get-file.md @@ -0,0 +1,8 @@ +GET /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/storage/list-files.md b/docs/examples/1.6.x/client-rest/examples/storage/list-files.md new file mode 100644 index 0000000000..5147eaaaed --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/storage/list-files.md @@ -0,0 +1,8 @@ +GET /v1/storage/buckets/{bucketId}/files HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/storage/update-file.md b/docs/examples/1.6.x/client-rest/examples/storage/update-file.md new file mode 100644 index 0000000000..f3f68f4ece --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/storage/update-file.md @@ -0,0 +1,12 @@ +PUT /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "name": "<NAME>", + "permissions": ["read(\"any\")"] +} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/create-membership.md b/docs/examples/1.6.x/client-rest/examples/teams/create-membership.md new file mode 100644 index 0000000000..84dbc980fc --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/create-membership.md @@ -0,0 +1,16 @@ +POST /v1/teams/{teamId}/memberships HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "email": "email@example.com", + "userId": "<USER_ID>", + "phone": "+12065550100", + "roles": [], + "url": "https://example.com", + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/create.md b/docs/examples/1.6.x/client-rest/examples/teams/create.md new file mode 100644 index 0000000000..3a63ba1f82 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/create.md @@ -0,0 +1,13 @@ +POST /v1/teams HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "teamId": "<TEAM_ID>", + "name": "<NAME>", + "roles": [] +} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-rest/examples/teams/delete-membership.md new file mode 100644 index 0000000000..66f87aebea --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/delete-membership.md @@ -0,0 +1,8 @@ +DELETE /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/teams/delete.md b/docs/examples/1.6.x/client-rest/examples/teams/delete.md new file mode 100644 index 0000000000..1c4e209c63 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/delete.md @@ -0,0 +1,8 @@ +DELETE /v1/teams/{teamId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/teams/get-membership.md b/docs/examples/1.6.x/client-rest/examples/teams/get-membership.md new file mode 100644 index 0000000000..a05c53298a --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/get-membership.md @@ -0,0 +1,8 @@ +GET /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-rest/examples/teams/get-prefs.md new file mode 100644 index 0000000000..d143f6b904 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/get-prefs.md @@ -0,0 +1,8 @@ +GET /v1/teams/{teamId}/prefs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/teams/get.md b/docs/examples/1.6.x/client-rest/examples/teams/get.md new file mode 100644 index 0000000000..a7c2a0e9b7 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/get.md @@ -0,0 +1,8 @@ +GET /v1/teams/{teamId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-rest/examples/teams/list-memberships.md new file mode 100644 index 0000000000..8350fb4cb3 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/list-memberships.md @@ -0,0 +1,8 @@ +GET /v1/teams/{teamId}/memberships HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/teams/list.md b/docs/examples/1.6.x/client-rest/examples/teams/list.md new file mode 100644 index 0000000000..64ad9d801b --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/list.md @@ -0,0 +1,8 @@ +GET /v1/teams HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/client-rest/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-rest/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..5cc6b91536 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/update-membership-status.md @@ -0,0 +1,12 @@ +PATCH /v1/teams/{teamId}/memberships/{membershipId}/status HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/update-membership.md b/docs/examples/1.6.x/client-rest/examples/teams/update-membership.md new file mode 100644 index 0000000000..a2838a5853 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/update-membership.md @@ -0,0 +1,11 @@ +PATCH /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "roles": [] +} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/update-name.md b/docs/examples/1.6.x/client-rest/examples/teams/update-name.md new file mode 100644 index 0000000000..33f1c13a99 --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/update-name.md @@ -0,0 +1,11 @@ +PUT /v1/teams/{teamId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-rest/examples/teams/update-prefs.md new file mode 100644 index 0000000000..d6b42128be --- /dev/null +++ b/docs/examples/1.6.x/client-rest/examples/teams/update-prefs.md @@ -0,0 +1,11 @@ +PUT /v1/teams/{teamId}/prefs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "prefs": {} +} diff --git a/docs/examples/1.6.x/client-web/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-web/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..436b1039bd --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-anonymous-session.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createAnonymousSession(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-web/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..9f207531cc --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-email-password-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createEmailPasswordSession( + 'email@example.com', // email + 'password' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-email-token.md b/docs/examples/1.6.x/client-web/examples/account/create-email-token.md new file mode 100644 index 0000000000..be13a771ac --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-email-token.md @@ -0,0 +1,15 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createEmailToken( + '<USER_ID>', // userId + 'email@example.com', // email + false // phrase (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-web/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..41dfe9c999 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-j-w-t.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createJWT(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-web/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..1b8cfe0ad5 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,16 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMagicURLToken( + '<USER_ID>', // userId + 'email@example.com', // email + 'https://example.com', // url (optional) + false // phrase (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-web/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..5899ee71a7 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-mfa-authenticator.md @@ -0,0 +1,13 @@ +import { Client, Account, AuthenticatorType } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMfaAuthenticator( + AuthenticatorType.Totp // type +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-web/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..1b1d5e9110 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-mfa-challenge.md @@ -0,0 +1,13 @@ +import { Client, Account, AuthenticationFactor } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMfaChallenge( + AuthenticationFactor.Email // factor +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-web/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..de5c4f6ea9 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMfaRecoveryCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/client-web/examples/account/create-o-auth2session.md new file mode 100644 index 0000000000..1d1808bb36 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-o-auth2session.md @@ -0,0 +1,15 @@ +import { Client, Account, OAuthProvider } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +account.createOAuth2Session( + OAuthProvider.Amazon, // provider + 'https://example.com', // success (optional) + 'https://example.com', // failure (optional) + [] // scopes (optional) +); + diff --git a/docs/examples/1.6.x/client-web/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/client-web/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..be599de1f6 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-o-auth2token.md @@ -0,0 +1,15 @@ +import { Client, Account, OAuthProvider } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +account.createOAuth2Token( + OAuthProvider.Amazon, // provider + 'https://example.com', // success (optional) + 'https://example.com', // failure (optional) + [] // scopes (optional) +); + diff --git a/docs/examples/1.6.x/client-web/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-web/examples/account/create-phone-token.md new file mode 100644 index 0000000000..80ac3169d4 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-phone-token.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createPhoneToken( + '<USER_ID>', // userId + '+12065550100' // phone +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-web/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..008c725552 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-phone-verification.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createPhoneVerification(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-push-target.md b/docs/examples/1.6.x/client-web/examples/account/create-push-target.md new file mode 100644 index 0000000000..7b3dba20b3 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-push-target.md @@ -0,0 +1,15 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createPushTarget( + '<TARGET_ID>', // targetId + '<IDENTIFIER>', // identifier + '<PROVIDER_ID>' // providerId (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-recovery.md b/docs/examples/1.6.x/client-web/examples/account/create-recovery.md new file mode 100644 index 0000000000..6c7bf498aa --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-recovery.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createRecovery( + 'email@example.com', // email + 'https://example.com' // url +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-session.md b/docs/examples/1.6.x/client-web/examples/account/create-session.md new file mode 100644 index 0000000000..af03174675 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-verification.md b/docs/examples/1.6.x/client-web/examples/account/create-verification.md new file mode 100644 index 0000000000..04d924327e --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create-verification.md @@ -0,0 +1,13 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createVerification( + 'https://example.com' // url +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create.md b/docs/examples/1.6.x/client-web/examples/account/create.md new file mode 100644 index 0000000000..95f6bc7cb0 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/create.md @@ -0,0 +1,16 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.create( + '<USER_ID>', // userId + 'email@example.com', // email + '', // password + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/delete-identity.md b/docs/examples/1.6.x/client-web/examples/account/delete-identity.md new file mode 100644 index 0000000000..f2c3b9b593 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/delete-identity.md @@ -0,0 +1,13 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteIdentity( + '<IDENTITY_ID>' // identityId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-web/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..339aae0d92 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,13 @@ +import { Client, Account, AuthenticatorType } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteMfaAuthenticator( + AuthenticatorType.Totp // type +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-web/examples/account/delete-push-target.md new file mode 100644 index 0000000000..00b20d4481 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/delete-push-target.md @@ -0,0 +1,13 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deletePushTarget( + '<TARGET_ID>' // targetId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/delete-session.md b/docs/examples/1.6.x/client-web/examples/account/delete-session.md new file mode 100644 index 0000000000..55671b3e9b --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/delete-session.md @@ -0,0 +1,13 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteSession( + '<SESSION_ID>' // sessionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-web/examples/account/delete-sessions.md new file mode 100644 index 0000000000..e2c836c827 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/delete-sessions.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteSessions(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-web/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..de1ec84a00 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.getMfaRecoveryCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/get-prefs.md b/docs/examples/1.6.x/client-web/examples/account/get-prefs.md new file mode 100644 index 0000000000..f44caf2779 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/get-prefs.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.getPrefs(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/get-session.md b/docs/examples/1.6.x/client-web/examples/account/get-session.md new file mode 100644 index 0000000000..0acd251b28 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/get-session.md @@ -0,0 +1,13 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.getSession( + '<SESSION_ID>' // sessionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/get.md b/docs/examples/1.6.x/client-web/examples/account/get.md new file mode 100644 index 0000000000..239dd0586d --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/get.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.get(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/list-identities.md b/docs/examples/1.6.x/client-web/examples/account/list-identities.md new file mode 100644 index 0000000000..9fb9f57887 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/list-identities.md @@ -0,0 +1,13 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listIdentities( + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/list-logs.md b/docs/examples/1.6.x/client-web/examples/account/list-logs.md new file mode 100644 index 0000000000..fc4e762b67 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/list-logs.md @@ -0,0 +1,13 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listLogs( + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-web/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..d88379c22a --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/list-mfa-factors.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listMfaFactors(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/list-sessions.md b/docs/examples/1.6.x/client-web/examples/account/list-sessions.md new file mode 100644 index 0000000000..cd23e3a242 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/list-sessions.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listSessions(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-email.md b/docs/examples/1.6.x/client-web/examples/account/update-email.md new file mode 100644 index 0000000000..d5cab99605 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-email.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateEmail( + 'email@example.com', // email + 'password' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-web/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..3ebfbc8a8a --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-m-f-a.md @@ -0,0 +1,13 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMFA( + false // mfa +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-web/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..8acdc01c66 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMagicURLSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-web/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..0f9bece742 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-mfa-authenticator.md @@ -0,0 +1,14 @@ +import { Client, Account, AuthenticatorType } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMfaAuthenticator( + AuthenticatorType.Totp, // type + '<OTP>' // otp +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-web/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..c68d091660 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-mfa-challenge.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMfaChallenge( + '<CHALLENGE_ID>', // challengeId + '<OTP>' // otp +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-web/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..35b4a73b14 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMfaRecoveryCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-name.md b/docs/examples/1.6.x/client-web/examples/account/update-name.md new file mode 100644 index 0000000000..6f8f1582ea --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-name.md @@ -0,0 +1,13 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateName( + '<NAME>' // name +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-password.md b/docs/examples/1.6.x/client-web/examples/account/update-password.md new file mode 100644 index 0000000000..30337387ca --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-password.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePassword( + '', // password + 'password' // oldPassword (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-web/examples/account/update-phone-session.md new file mode 100644 index 0000000000..8d0d760e43 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-phone-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePhoneSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-web/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..af205e6e56 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-phone-verification.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePhoneVerification( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-phone.md b/docs/examples/1.6.x/client-web/examples/account/update-phone.md new file mode 100644 index 0000000000..134bfe6052 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-phone.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePhone( + '+12065550100', // phone + 'password' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-prefs.md b/docs/examples/1.6.x/client-web/examples/account/update-prefs.md new file mode 100644 index 0000000000..6d25ac9dbd --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-prefs.md @@ -0,0 +1,13 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePrefs( + {} // prefs +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-push-target.md b/docs/examples/1.6.x/client-web/examples/account/update-push-target.md new file mode 100644 index 0000000000..6009b63961 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-push-target.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePushTarget( + '<TARGET_ID>', // targetId + '<IDENTIFIER>' // identifier +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-recovery.md b/docs/examples/1.6.x/client-web/examples/account/update-recovery.md new file mode 100644 index 0000000000..db10194734 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-recovery.md @@ -0,0 +1,15 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateRecovery( + '<USER_ID>', // userId + '<SECRET>', // secret + '' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-session.md b/docs/examples/1.6.x/client-web/examples/account/update-session.md new file mode 100644 index 0000000000..7ace994fa8 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-session.md @@ -0,0 +1,13 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateSession( + '<SESSION_ID>' // sessionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-status.md b/docs/examples/1.6.x/client-web/examples/account/update-status.md new file mode 100644 index 0000000000..5cc295dad0 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-status.md @@ -0,0 +1,11 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateStatus(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-verification.md b/docs/examples/1.6.x/client-web/examples/account/update-verification.md new file mode 100644 index 0000000000..17b23e7455 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/account/update-verification.md @@ -0,0 +1,14 @@ +import { Client, Account } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateVerification( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-web/examples/avatars/get-browser.md new file mode 100644 index 0000000000..7339297953 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/avatars/get-browser.md @@ -0,0 +1,16 @@ +import { Client, Avatars, Browser } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getBrowser( + Browser.AvantBrowser, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-web/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..c998ff8c14 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/avatars/get-credit-card.md @@ -0,0 +1,16 @@ +import { Client, Avatars, CreditCard } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getCreditCard( + CreditCard.AmericanExpress, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-web/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..a4b002c66e --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/avatars/get-favicon.md @@ -0,0 +1,13 @@ +import { Client, Avatars } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getFavicon( + 'https://example.com' // url +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-web/examples/avatars/get-flag.md new file mode 100644 index 0000000000..6c00b33b10 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/avatars/get-flag.md @@ -0,0 +1,16 @@ +import { Client, Avatars, Flag } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getFlag( + Flag.Afghanistan, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-image.md b/docs/examples/1.6.x/client-web/examples/avatars/get-image.md new file mode 100644 index 0000000000..31a44ea129 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/avatars/get-image.md @@ -0,0 +1,15 @@ +import { Client, Avatars } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getImage( + 'https://example.com', // url + 0, // width (optional) + 0 // height (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-web/examples/avatars/get-initials.md new file mode 100644 index 0000000000..0597c168d0 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/avatars/get-initials.md @@ -0,0 +1,16 @@ +import { Client, Avatars } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getInitials( + '<NAME>', // name (optional) + 0, // width (optional) + 0, // height (optional) + '' // background (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-web/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..cdd31ad84e --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/avatars/get-q-r.md @@ -0,0 +1,16 @@ +import { Client, Avatars } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getQR( + '<TEXT>', // text + 1, // size (optional) + 0, // margin (optional) + false // download (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/databases/create-document.md b/docs/examples/1.6.x/client-web/examples/databases/create-document.md new file mode 100644 index 0000000000..4c819110b5 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/databases/create-document.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + {}, // data + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/databases/delete-document.md b/docs/examples/1.6.x/client-web/examples/databases/delete-document.md new file mode 100644 index 0000000000..b29fcec8e3 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/databases/delete-document.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.deleteDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>' // documentId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/databases/get-document.md b/docs/examples/1.6.x/client-web/examples/databases/get-document.md new file mode 100644 index 0000000000..9b043c82b9 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/databases/get-document.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.getDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/databases/list-documents.md b/docs/examples/1.6.x/client-web/examples/databases/list-documents.md new file mode 100644 index 0000000000..a8154c22db --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/databases/list-documents.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.listDocuments( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/databases/update-document.md b/docs/examples/1.6.x/client-web/examples/databases/update-document.md new file mode 100644 index 0000000000..d6c4d720fd --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/databases/update-document.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + {}, // data (optional) + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/functions/create-execution.md b/docs/examples/1.6.x/client-web/examples/functions/create-execution.md new file mode 100644 index 0000000000..7db9557c6b --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/functions/create-execution.md @@ -0,0 +1,19 @@ +import { Client, Functions, ExecutionMethod } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.createExecution( + '<FUNCTION_ID>', // functionId + '<BODY>', // body (optional) + false, // async (optional) + '<PATH>', // path (optional) + ExecutionMethod.GET, // method (optional) + {}, // headers (optional) + '' // scheduledAt (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/functions/get-execution.md b/docs/examples/1.6.x/client-web/examples/functions/get-execution.md new file mode 100644 index 0000000000..d558d5fbf2 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/functions/get-execution.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.getExecution( + '<FUNCTION_ID>', // functionId + '<EXECUTION_ID>' // executionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/functions/list-executions.md b/docs/examples/1.6.x/client-web/examples/functions/list-executions.md new file mode 100644 index 0000000000..830e3e16ac --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/functions/list-executions.md @@ -0,0 +1,15 @@ +import { Client, Functions } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.listExecutions( + '<FUNCTION_ID>', // functionId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/graphql/mutation.md b/docs/examples/1.6.x/client-web/examples/graphql/mutation.md new file mode 100644 index 0000000000..5b65286fb9 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/graphql/mutation.md @@ -0,0 +1,13 @@ +import { Client, Graphql } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const graphql = new Graphql(client); + +const result = await graphql.mutation( + {} // query +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/graphql/query.md b/docs/examples/1.6.x/client-web/examples/graphql/query.md new file mode 100644 index 0000000000..9de8dd77e9 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/graphql/query.md @@ -0,0 +1,13 @@ +import { Client, Graphql } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const graphql = new Graphql(client); + +const result = await graphql.query( + {} // query +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/get.md b/docs/examples/1.6.x/client-web/examples/locale/get.md new file mode 100644 index 0000000000..cf6b1047ca --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/locale/get.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.get(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-codes.md b/docs/examples/1.6.x/client-web/examples/locale/list-codes.md new file mode 100644 index 0000000000..8a6097918b --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/locale/list-codes.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-continents.md b/docs/examples/1.6.x/client-web/examples/locale/list-continents.md new file mode 100644 index 0000000000..b76e6d5246 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/locale/list-continents.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listContinents(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-web/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..6f0bd36b0c --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/locale/list-countries-e-u.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCountriesEU(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-web/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..fb2f9b1df9 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/locale/list-countries-phones.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCountriesPhones(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-countries.md b/docs/examples/1.6.x/client-web/examples/locale/list-countries.md new file mode 100644 index 0000000000..28dc75f4a2 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/locale/list-countries.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCountries(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-web/examples/locale/list-currencies.md new file mode 100644 index 0000000000..bf6b42c27f --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/locale/list-currencies.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCurrencies(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-languages.md b/docs/examples/1.6.x/client-web/examples/locale/list-languages.md new file mode 100644 index 0000000000..29bd0dad3d --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/locale/list-languages.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listLanguages(); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-web/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..231197717b --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/messaging/create-subscriber.md @@ -0,0 +1,15 @@ +import { Client, Messaging } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>', // subscriberId + '<TARGET_ID>' // targetId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-web/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..76c71ef2f2 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/messaging/delete-subscriber.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.deleteSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>' // subscriberId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/storage/create-file.md b/docs/examples/1.6.x/client-web/examples/storage/create-file.md new file mode 100644 index 0000000000..d6617e40b9 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/storage/create-file.md @@ -0,0 +1,16 @@ +import { Client, Storage } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.createFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + document.getElementById('uploader').files[0], // file + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/storage/delete-file.md b/docs/examples/1.6.x/client-web/examples/storage/delete-file.md new file mode 100644 index 0000000000..e45af2ca5d --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/storage/delete-file.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.deleteFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-web/examples/storage/get-file-download.md new file mode 100644 index 0000000000..f2bdbbd26d --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/storage/get-file-download.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = storage.getFileDownload( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-web/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..66b30ca539 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/storage/get-file-preview.md @@ -0,0 +1,25 @@ +import { Client, Storage, ImageGravity, ImageFormat } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = storage.getFilePreview( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + 0, // width (optional) + 0, // height (optional) + ImageGravity.Center, // gravity (optional) + 0, // quality (optional) + 0, // borderWidth (optional) + '', // borderColor (optional) + 0, // borderRadius (optional) + 0, // opacity (optional) + -360, // rotation (optional) + '', // background (optional) + ImageFormat.Jpg // output (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-web/examples/storage/get-file-view.md new file mode 100644 index 0000000000..d83fca52e9 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/storage/get-file-view.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = storage.getFileView( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/storage/get-file.md b/docs/examples/1.6.x/client-web/examples/storage/get-file.md new file mode 100644 index 0000000000..093017df67 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/storage/get-file.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.getFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/storage/list-files.md b/docs/examples/1.6.x/client-web/examples/storage/list-files.md new file mode 100644 index 0000000000..b3416759dc --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/storage/list-files.md @@ -0,0 +1,15 @@ +import { Client, Storage } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.listFiles( + '<BUCKET_ID>', // bucketId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/storage/update-file.md b/docs/examples/1.6.x/client-web/examples/storage/update-file.md new file mode 100644 index 0000000000..0136fb770f --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/storage/update-file.md @@ -0,0 +1,16 @@ +import { Client, Storage } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.updateFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + '<NAME>', // name (optional) + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/create-membership.md b/docs/examples/1.6.x/client-web/examples/teams/create-membership.md new file mode 100644 index 0000000000..f158f98be2 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/create-membership.md @@ -0,0 +1,19 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.createMembership( + '<TEAM_ID>', // teamId + [], // roles + 'email@example.com', // email (optional) + '<USER_ID>', // userId (optional) + '+12065550100', // phone (optional) + 'https://example.com', // url (optional) + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/create.md b/docs/examples/1.6.x/client-web/examples/teams/create.md new file mode 100644 index 0000000000..154c1795a2 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/create.md @@ -0,0 +1,15 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.create( + '<TEAM_ID>', // teamId + '<NAME>', // name + [] // roles (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-web/examples/teams/delete-membership.md new file mode 100644 index 0000000000..c6e60a6692 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/delete-membership.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.deleteMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/delete.md b/docs/examples/1.6.x/client-web/examples/teams/delete.md new file mode 100644 index 0000000000..b15112ebac --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/delete.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.delete( + '<TEAM_ID>' // teamId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/get-membership.md b/docs/examples/1.6.x/client-web/examples/teams/get-membership.md new file mode 100644 index 0000000000..c1ccff2e87 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/get-membership.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.getMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-web/examples/teams/get-prefs.md new file mode 100644 index 0000000000..6498106c30 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/get-prefs.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.getPrefs( + '<TEAM_ID>' // teamId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/get.md b/docs/examples/1.6.x/client-web/examples/teams/get.md new file mode 100644 index 0000000000..9131f99079 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/get.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.get( + '<TEAM_ID>' // teamId +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-web/examples/teams/list-memberships.md new file mode 100644 index 0000000000..2f76c01492 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/list-memberships.md @@ -0,0 +1,15 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.listMemberships( + '<TEAM_ID>', // teamId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/list.md b/docs/examples/1.6.x/client-web/examples/teams/list.md new file mode 100644 index 0000000000..3c362673bd --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/list.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-web/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..e4d67e36d4 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/update-membership-status.md @@ -0,0 +1,16 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updateMembershipStatus( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/update-membership.md b/docs/examples/1.6.x/client-web/examples/teams/update-membership.md new file mode 100644 index 0000000000..a1bac018a9 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/update-membership.md @@ -0,0 +1,15 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updateMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId + [] // roles +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/update-name.md b/docs/examples/1.6.x/client-web/examples/teams/update-name.md new file mode 100644 index 0000000000..a65b7c465e --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/update-name.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updateName( + '<TEAM_ID>', // teamId + '<NAME>' // name +); + +console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-web/examples/teams/update-prefs.md new file mode 100644 index 0000000000..002b4eb447 --- /dev/null +++ b/docs/examples/1.6.x/client-web/examples/teams/update-prefs.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "appwrite"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updatePrefs( + '<TEAM_ID>', // teamId + {} // prefs +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/console-cli/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..a7eb9c5be3 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-anonymous-session.md @@ -0,0 +1 @@ +appwrite account createAnonymousSession diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-email-password-session.md b/docs/examples/1.6.x/console-cli/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..951293b4b2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-email-password-session.md @@ -0,0 +1,3 @@ +appwrite account createEmailPasswordSession \ + --email email@example.com \ + --password password diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-email-token.md b/docs/examples/1.6.x/console-cli/examples/account/create-email-token.md new file mode 100644 index 0000000000..0aaf2476c9 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-email-token.md @@ -0,0 +1,4 @@ +appwrite account createEmailToken \ + --userId <USER_ID> \ + --email email@example.com \ + diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-j-w-t.md b/docs/examples/1.6.x/console-cli/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..7b5337993d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-j-w-t.md @@ -0,0 +1 @@ +appwrite account createJWT diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/console-cli/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..69203b085d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,5 @@ +appwrite account createMagicURLToken \ + --userId <USER_ID> \ + --email email@example.com \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/console-cli/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..7634217700 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-mfa-authenticator.md @@ -0,0 +1,2 @@ +appwrite account createMfaAuthenticator \ + --type totp diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/console-cli/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..8696be7ec1 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-mfa-challenge.md @@ -0,0 +1,2 @@ +appwrite account createMfaChallenge \ + --factor email diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..0ef25446fd --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1 @@ +appwrite account createMfaRecoveryCodes diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2session.md new file mode 100644 index 0000000000..9159b8f25f --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2session.md @@ -0,0 +1,5 @@ +appwrite account createOAuth2Session \ + --provider amazon \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..b36f350d99 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2token.md @@ -0,0 +1,5 @@ +appwrite account createOAuth2Token \ + --provider amazon \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-phone-token.md b/docs/examples/1.6.x/console-cli/examples/account/create-phone-token.md new file mode 100644 index 0000000000..23f7f19cac --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-phone-token.md @@ -0,0 +1,3 @@ +appwrite account createPhoneToken \ + --userId <USER_ID> \ + --phone +12065550100 diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-phone-verification.md b/docs/examples/1.6.x/console-cli/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..3c4402ba1f --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-phone-verification.md @@ -0,0 +1 @@ +appwrite account createPhoneVerification diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-push-target.md b/docs/examples/1.6.x/console-cli/examples/account/create-push-target.md new file mode 100644 index 0000000000..41c380b288 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-push-target.md @@ -0,0 +1,4 @@ +appwrite account createPushTarget \ + --targetId <TARGET_ID> \ + --identifier <IDENTIFIER> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-recovery.md b/docs/examples/1.6.x/console-cli/examples/account/create-recovery.md new file mode 100644 index 0000000000..ea8c145abb --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-recovery.md @@ -0,0 +1,3 @@ +appwrite account createRecovery \ + --email email@example.com \ + --url https://example.com diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-session.md b/docs/examples/1.6.x/console-cli/examples/account/create-session.md new file mode 100644 index 0000000000..426713ef50 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-session.md @@ -0,0 +1,3 @@ +appwrite account createSession \ + --userId <USER_ID> \ + --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-verification.md b/docs/examples/1.6.x/console-cli/examples/account/create-verification.md new file mode 100644 index 0000000000..402038b4b6 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create-verification.md @@ -0,0 +1,2 @@ +appwrite account createVerification \ + --url https://example.com diff --git a/docs/examples/1.6.x/console-cli/examples/account/create.md b/docs/examples/1.6.x/console-cli/examples/account/create.md new file mode 100644 index 0000000000..09686a2454 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/create.md @@ -0,0 +1,5 @@ +appwrite account create \ + --userId <USER_ID> \ + --email email@example.com \ + --password '' \ + diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete-identity.md b/docs/examples/1.6.x/console-cli/examples/account/delete-identity.md new file mode 100644 index 0000000000..acd8511dfb --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/delete-identity.md @@ -0,0 +1,2 @@ +appwrite account deleteIdentity \ + --identityId <IDENTITY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/console-cli/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..d4664855b5 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,2 @@ +appwrite account deleteMfaAuthenticator \ + --type totp diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete-push-target.md b/docs/examples/1.6.x/console-cli/examples/account/delete-push-target.md new file mode 100644 index 0000000000..610ea232d8 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/delete-push-target.md @@ -0,0 +1,2 @@ +appwrite account deletePushTarget \ + --targetId <TARGET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete-session.md b/docs/examples/1.6.x/console-cli/examples/account/delete-session.md new file mode 100644 index 0000000000..9774552408 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/delete-session.md @@ -0,0 +1,2 @@ +appwrite account deleteSession \ + --sessionId <SESSION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete-sessions.md b/docs/examples/1.6.x/console-cli/examples/account/delete-sessions.md new file mode 100644 index 0000000000..dd11877a5d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/delete-sessions.md @@ -0,0 +1 @@ +appwrite account deleteSessions diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete.md b/docs/examples/1.6.x/console-cli/examples/account/delete.md new file mode 100644 index 0000000000..dac412f7c2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/delete.md @@ -0,0 +1 @@ +appwrite account delete diff --git a/docs/examples/1.6.x/console-cli/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..0e61d658de --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1 @@ +appwrite account getMfaRecoveryCodes diff --git a/docs/examples/1.6.x/console-cli/examples/account/get-prefs.md b/docs/examples/1.6.x/console-cli/examples/account/get-prefs.md new file mode 100644 index 0000000000..6569925d99 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/get-prefs.md @@ -0,0 +1 @@ +appwrite account getPrefs diff --git a/docs/examples/1.6.x/console-cli/examples/account/get-session.md b/docs/examples/1.6.x/console-cli/examples/account/get-session.md new file mode 100644 index 0000000000..120dc8277f --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/get-session.md @@ -0,0 +1,2 @@ +appwrite account getSession \ + --sessionId <SESSION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/account/get.md b/docs/examples/1.6.x/console-cli/examples/account/get.md new file mode 100644 index 0000000000..c8b46e34c7 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/get.md @@ -0,0 +1 @@ +appwrite account get diff --git a/docs/examples/1.6.x/console-cli/examples/account/list-identities.md b/docs/examples/1.6.x/console-cli/examples/account/list-identities.md new file mode 100644 index 0000000000..877b443ea8 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/list-identities.md @@ -0,0 +1,2 @@ +appwrite account listIdentities \ + diff --git a/docs/examples/1.6.x/console-cli/examples/account/list-logs.md b/docs/examples/1.6.x/console-cli/examples/account/list-logs.md new file mode 100644 index 0000000000..e92f49063a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/list-logs.md @@ -0,0 +1,2 @@ +appwrite account listLogs \ + diff --git a/docs/examples/1.6.x/console-cli/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/console-cli/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..a29f287d24 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/list-mfa-factors.md @@ -0,0 +1 @@ +appwrite account listMfaFactors diff --git a/docs/examples/1.6.x/console-cli/examples/account/list-sessions.md b/docs/examples/1.6.x/console-cli/examples/account/list-sessions.md new file mode 100644 index 0000000000..87cbab0f66 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/list-sessions.md @@ -0,0 +1 @@ +appwrite account listSessions diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-email.md b/docs/examples/1.6.x/console-cli/examples/account/update-email.md new file mode 100644 index 0000000000..81938ff3a9 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-email.md @@ -0,0 +1,3 @@ +appwrite account updateEmail \ + --email email@example.com \ + --password password diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-m-f-a.md b/docs/examples/1.6.x/console-cli/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..f714d4dbe9 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-m-f-a.md @@ -0,0 +1,2 @@ +appwrite account updateMFA \ + --mfa false diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/console-cli/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..919bd70a30 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,3 @@ +appwrite account updateMagicURLSession \ + --userId <USER_ID> \ + --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/console-cli/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..b51796a79e --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-mfa-authenticator.md @@ -0,0 +1,3 @@ +appwrite account updateMfaAuthenticator \ + --type totp \ + --otp <OTP> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/console-cli/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..37e09ef4e8 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-mfa-challenge.md @@ -0,0 +1,3 @@ +appwrite account updateMfaChallenge \ + --challengeId <CHALLENGE_ID> \ + --otp <OTP> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..a129ca6f98 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1 @@ +appwrite account updateMfaRecoveryCodes diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-name.md b/docs/examples/1.6.x/console-cli/examples/account/update-name.md new file mode 100644 index 0000000000..6f3b5977f4 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-name.md @@ -0,0 +1,2 @@ +appwrite account updateName \ + --name <NAME> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-password.md b/docs/examples/1.6.x/console-cli/examples/account/update-password.md new file mode 100644 index 0000000000..340baec562 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-password.md @@ -0,0 +1,3 @@ +appwrite account updatePassword \ + --password '' \ + diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-phone-session.md b/docs/examples/1.6.x/console-cli/examples/account/update-phone-session.md new file mode 100644 index 0000000000..d70f33fab5 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-phone-session.md @@ -0,0 +1,3 @@ +appwrite account updatePhoneSession \ + --userId <USER_ID> \ + --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-phone-verification.md b/docs/examples/1.6.x/console-cli/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..cef2b5a40d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-phone-verification.md @@ -0,0 +1,3 @@ +appwrite account updatePhoneVerification \ + --userId <USER_ID> \ + --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-phone.md b/docs/examples/1.6.x/console-cli/examples/account/update-phone.md new file mode 100644 index 0000000000..93a619a801 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-phone.md @@ -0,0 +1,3 @@ +appwrite account updatePhone \ + --phone +12065550100 \ + --password password diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-prefs.md b/docs/examples/1.6.x/console-cli/examples/account/update-prefs.md new file mode 100644 index 0000000000..568ac66e48 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-prefs.md @@ -0,0 +1,2 @@ +appwrite account updatePrefs \ + --prefs '{ "key": "value" }' diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-push-target.md b/docs/examples/1.6.x/console-cli/examples/account/update-push-target.md new file mode 100644 index 0000000000..f3aa1a906a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-push-target.md @@ -0,0 +1,3 @@ +appwrite account updatePushTarget \ + --targetId <TARGET_ID> \ + --identifier <IDENTIFIER> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-recovery.md b/docs/examples/1.6.x/console-cli/examples/account/update-recovery.md new file mode 100644 index 0000000000..903a99cc99 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-recovery.md @@ -0,0 +1,4 @@ +appwrite account updateRecovery \ + --userId <USER_ID> \ + --secret <SECRET> \ + --password '' diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-session.md b/docs/examples/1.6.x/console-cli/examples/account/update-session.md new file mode 100644 index 0000000000..5fb6a2e8d5 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-session.md @@ -0,0 +1,2 @@ +appwrite account updateSession \ + --sessionId <SESSION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-status.md b/docs/examples/1.6.x/console-cli/examples/account/update-status.md new file mode 100644 index 0000000000..8886dbbc6a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-status.md @@ -0,0 +1 @@ +appwrite account updateStatus diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-verification.md b/docs/examples/1.6.x/console-cli/examples/account/update-verification.md new file mode 100644 index 0000000000..afdfaa8372 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/account/update-verification.md @@ -0,0 +1,3 @@ +appwrite account updateVerification \ + --userId <USER_ID> \ + --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/assistant/chat.md b/docs/examples/1.6.x/console-cli/examples/assistant/chat.md new file mode 100644 index 0000000000..cf62d30515 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/assistant/chat.md @@ -0,0 +1,2 @@ +appwrite assistant chat \ + --prompt <PROMPT> diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-browser.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-browser.md new file mode 100644 index 0000000000..6b4f0b8007 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/avatars/get-browser.md @@ -0,0 +1,5 @@ +appwrite avatars getBrowser \ + --code aa \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..365568ba19 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/avatars/get-credit-card.md @@ -0,0 +1,5 @@ +appwrite avatars getCreditCard \ + --code amex \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-favicon.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..c658f1a483 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/avatars/get-favicon.md @@ -0,0 +1,2 @@ +appwrite avatars getFavicon \ + --url https://example.com diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-flag.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-flag.md new file mode 100644 index 0000000000..9f11fef840 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/avatars/get-flag.md @@ -0,0 +1,5 @@ +appwrite avatars getFlag \ + --code af \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-image.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-image.md new file mode 100644 index 0000000000..7df150610c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/avatars/get-image.md @@ -0,0 +1,4 @@ +appwrite avatars getImage \ + --url https://example.com \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-initials.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-initials.md new file mode 100644 index 0000000000..b0b3da71c9 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/avatars/get-initials.md @@ -0,0 +1,5 @@ +appwrite avatars getInitials \ + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-q-r.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..01e5085732 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/avatars/get-q-r.md @@ -0,0 +1,5 @@ +appwrite avatars getQR \ + --text <TEXT> \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/console/variables.md b/docs/examples/1.6.x/console-cli/examples/console/variables.md new file mode 100644 index 0000000000..1c67cf5ad8 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/console/variables.md @@ -0,0 +1 @@ +appwrite console variables diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..6babbfb5af --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-boolean-attribute.md @@ -0,0 +1,7 @@ +appwrite databases createBooleanAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-collection.md b/docs/examples/1.6.x/console-cli/examples/databases/create-collection.md new file mode 100644 index 0000000000..d97c424d16 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-collection.md @@ -0,0 +1,7 @@ +appwrite databases createCollection \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --name <NAME> \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..f6aaf54fa2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-datetime-attribute.md @@ -0,0 +1,7 @@ +appwrite databases createDatetimeAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-document.md b/docs/examples/1.6.x/console-cli/examples/databases/create-document.md new file mode 100644 index 0000000000..513cfc4f33 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-document.md @@ -0,0 +1,6 @@ +appwrite databases createDocument \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --documentId <DOCUMENT_ID> \ + --data '{ "key": "value" }' \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..5c23f940de --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-email-attribute.md @@ -0,0 +1,7 @@ +appwrite databases createEmailAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..5d3c614410 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-enum-attribute.md @@ -0,0 +1,8 @@ +appwrite databases createEnumAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --elements one two three \ + --required false \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..5a6ef4e4ef --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-float-attribute.md @@ -0,0 +1,9 @@ +appwrite databases createFloatAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-index.md b/docs/examples/1.6.x/console-cli/examples/databases/create-index.md new file mode 100644 index 0000000000..d8f96c0e55 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-index.md @@ -0,0 +1,7 @@ +appwrite databases createIndex \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --type key \ + --attributes one two three \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..791f3770c9 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-integer-attribute.md @@ -0,0 +1,9 @@ +appwrite databases createIntegerAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..4f39d84bab --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-ip-attribute.md @@ -0,0 +1,7 @@ +appwrite databases createIpAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..c7d8ae568a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-relationship-attribute.md @@ -0,0 +1,9 @@ +appwrite databases createRelationshipAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --relatedCollectionId <RELATED_COLLECTION_ID> \ + --type oneToOne \ + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..37b1db644a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-string-attribute.md @@ -0,0 +1,9 @@ +appwrite databases createStringAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --size 1 \ + --required false \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..4406ed7879 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create-url-attribute.md @@ -0,0 +1,7 @@ +appwrite databases createUrlAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create.md b/docs/examples/1.6.x/console-cli/examples/databases/create.md new file mode 100644 index 0000000000..9e7523974f --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/create.md @@ -0,0 +1,4 @@ +appwrite databases create \ + --databaseId <DATABASE_ID> \ + --name <NAME> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/delete-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..88e7df985f --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/delete-attribute.md @@ -0,0 +1,4 @@ +appwrite databases deleteAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/delete-collection.md b/docs/examples/1.6.x/console-cli/examples/databases/delete-collection.md new file mode 100644 index 0000000000..0db185a7d7 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/delete-collection.md @@ -0,0 +1,3 @@ +appwrite databases deleteCollection \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/delete-document.md b/docs/examples/1.6.x/console-cli/examples/databases/delete-document.md new file mode 100644 index 0000000000..3a96d35798 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/delete-document.md @@ -0,0 +1,4 @@ +appwrite databases deleteDocument \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --documentId <DOCUMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/delete-index.md b/docs/examples/1.6.x/console-cli/examples/databases/delete-index.md new file mode 100644 index 0000000000..56485e7a78 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/delete-index.md @@ -0,0 +1,4 @@ +appwrite databases deleteIndex \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/delete.md b/docs/examples/1.6.x/console-cli/examples/databases/delete.md new file mode 100644 index 0000000000..a24a3a04d3 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/delete.md @@ -0,0 +1,2 @@ +appwrite databases delete \ + --databaseId <DATABASE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/get-attribute.md new file mode 100644 index 0000000000..821698011f --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/get-attribute.md @@ -0,0 +1,4 @@ +appwrite databases getAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-collection-usage.md b/docs/examples/1.6.x/console-cli/examples/databases/get-collection-usage.md new file mode 100644 index 0000000000..b57e6c92a9 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/get-collection-usage.md @@ -0,0 +1,4 @@ +appwrite databases getCollectionUsage \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-collection.md b/docs/examples/1.6.x/console-cli/examples/databases/get-collection.md new file mode 100644 index 0000000000..e763b5bbfb --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/get-collection.md @@ -0,0 +1,3 @@ +appwrite databases getCollection \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-database-usage.md b/docs/examples/1.6.x/console-cli/examples/databases/get-database-usage.md new file mode 100644 index 0000000000..1001e9cd11 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/get-database-usage.md @@ -0,0 +1,3 @@ +appwrite databases getDatabaseUsage \ + --databaseId <DATABASE_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-document.md b/docs/examples/1.6.x/console-cli/examples/databases/get-document.md new file mode 100644 index 0000000000..35d9615503 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/get-document.md @@ -0,0 +1,5 @@ +appwrite databases getDocument \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --documentId <DOCUMENT_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-index.md b/docs/examples/1.6.x/console-cli/examples/databases/get-index.md new file mode 100644 index 0000000000..0071834a8c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/get-index.md @@ -0,0 +1,4 @@ +appwrite databases getIndex \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-usage.md b/docs/examples/1.6.x/console-cli/examples/databases/get-usage.md new file mode 100644 index 0000000000..53c85fc849 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/get-usage.md @@ -0,0 +1,2 @@ +appwrite databases getUsage \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get.md b/docs/examples/1.6.x/console-cli/examples/databases/get.md new file mode 100644 index 0000000000..35480b64cc --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/get.md @@ -0,0 +1,2 @@ +appwrite databases get \ + --databaseId <DATABASE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-attributes.md b/docs/examples/1.6.x/console-cli/examples/databases/list-attributes.md new file mode 100644 index 0000000000..a2382feb3a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/list-attributes.md @@ -0,0 +1,4 @@ +appwrite databases listAttributes \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-collection-logs.md b/docs/examples/1.6.x/console-cli/examples/databases/list-collection-logs.md new file mode 100644 index 0000000000..eadac47a6b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/list-collection-logs.md @@ -0,0 +1,4 @@ +appwrite databases listCollectionLogs \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-collections.md b/docs/examples/1.6.x/console-cli/examples/databases/list-collections.md new file mode 100644 index 0000000000..b05c330be2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/list-collections.md @@ -0,0 +1,4 @@ +appwrite databases listCollections \ + --databaseId <DATABASE_ID> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-document-logs.md b/docs/examples/1.6.x/console-cli/examples/databases/list-document-logs.md new file mode 100644 index 0000000000..63b5394647 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/list-document-logs.md @@ -0,0 +1,5 @@ +appwrite databases listDocumentLogs \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --documentId <DOCUMENT_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-documents.md b/docs/examples/1.6.x/console-cli/examples/databases/list-documents.md new file mode 100644 index 0000000000..98e389579d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/list-documents.md @@ -0,0 +1,4 @@ +appwrite databases listDocuments \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-indexes.md b/docs/examples/1.6.x/console-cli/examples/databases/list-indexes.md new file mode 100644 index 0000000000..50acb4d7ad --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/list-indexes.md @@ -0,0 +1,4 @@ +appwrite databases listIndexes \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-logs.md b/docs/examples/1.6.x/console-cli/examples/databases/list-logs.md new file mode 100644 index 0000000000..38547c7c3c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/list-logs.md @@ -0,0 +1,3 @@ +appwrite databases listLogs \ + --databaseId <DATABASE_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list.md b/docs/examples/1.6.x/console-cli/examples/databases/list.md new file mode 100644 index 0000000000..e723bc32ec --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/list.md @@ -0,0 +1,3 @@ +appwrite databases list \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..d48c3470fe --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-boolean-attribute.md @@ -0,0 +1,6 @@ +appwrite databases updateBooleanAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + --default false diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-collection.md b/docs/examples/1.6.x/console-cli/examples/databases/update-collection.md new file mode 100644 index 0000000000..eab3617c80 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-collection.md @@ -0,0 +1,7 @@ +appwrite databases updateCollection \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --name <NAME> \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..9fc56373ed --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-datetime-attribute.md @@ -0,0 +1,6 @@ +appwrite databases updateDatetimeAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + --default '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-document.md b/docs/examples/1.6.x/console-cli/examples/databases/update-document.md new file mode 100644 index 0000000000..a4ac55bf6b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-document.md @@ -0,0 +1,6 @@ +appwrite databases updateDocument \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --documentId <DOCUMENT_ID> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..9f7bffeb9c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-email-attribute.md @@ -0,0 +1,6 @@ +appwrite databases updateEmailAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + --default email@example.com diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..bf562a0a82 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-enum-attribute.md @@ -0,0 +1,7 @@ +appwrite databases updateEnumAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --elements one two three \ + --required false \ + --default <DEFAULT> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..097dfd310a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-float-attribute.md @@ -0,0 +1,8 @@ +appwrite databases updateFloatAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + --min null \ + --max null \ + --default null diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..6a6b0747a8 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-integer-attribute.md @@ -0,0 +1,8 @@ +appwrite databases updateIntegerAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + --min null \ + --max null \ + --default null diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..2439b5a8de --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-ip-attribute.md @@ -0,0 +1,6 @@ +appwrite databases updateIpAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + --default '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..be03a70736 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-relationship-attribute.md @@ -0,0 +1,5 @@ +appwrite databases updateRelationshipAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..ebf45253fa --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-string-attribute.md @@ -0,0 +1,6 @@ +appwrite databases updateStringAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + --default <DEFAULT> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..aa11a588db --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update-url-attribute.md @@ -0,0 +1,6 @@ +appwrite databases updateUrlAttribute \ + --databaseId <DATABASE_ID> \ + --collectionId <COLLECTION_ID> \ + --key '' \ + --required false \ + --default https://example.com diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update.md b/docs/examples/1.6.x/console-cli/examples/databases/update.md new file mode 100644 index 0000000000..a1e0a844e5 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/databases/update.md @@ -0,0 +1,4 @@ +appwrite databases update \ + --databaseId <DATABASE_ID> \ + --name <NAME> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/functions/create-build.md b/docs/examples/1.6.x/console-cli/examples/functions/create-build.md new file mode 100644 index 0000000000..5a99f7a908 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/create-build.md @@ -0,0 +1,4 @@ +appwrite functions createBuild \ + --functionId <FUNCTION_ID> \ + --deploymentId <DEPLOYMENT_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/functions/create-deployment.md b/docs/examples/1.6.x/console-cli/examples/functions/create-deployment.md new file mode 100644 index 0000000000..6ac80bd73a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/create-deployment.md @@ -0,0 +1,6 @@ +appwrite functions createDeployment \ + --functionId <FUNCTION_ID> \ + --code 'path/to/file.png' \ + --activate false \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/functions/create-execution.md b/docs/examples/1.6.x/console-cli/examples/functions/create-execution.md new file mode 100644 index 0000000000..febe88c541 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/create-execution.md @@ -0,0 +1,8 @@ +appwrite functions createExecution \ + --functionId <FUNCTION_ID> \ + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/functions/create-variable.md b/docs/examples/1.6.x/console-cli/examples/functions/create-variable.md new file mode 100644 index 0000000000..9a27d4cb0f --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/create-variable.md @@ -0,0 +1,4 @@ +appwrite functions createVariable \ + --functionId <FUNCTION_ID> \ + --key <KEY> \ + --value <VALUE> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/create.md b/docs/examples/1.6.x/console-cli/examples/functions/create.md new file mode 100644 index 0000000000..c75658ec7b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/create.md @@ -0,0 +1,22 @@ +appwrite functions create \ + --functionId <FUNCTION_ID> \ + --name <NAME> \ + --runtime node-14.5 \ + + + + + + + + + + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/functions/delete-deployment.md b/docs/examples/1.6.x/console-cli/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..2c9a6aa04a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/delete-deployment.md @@ -0,0 +1,3 @@ +appwrite functions deleteDeployment \ + --functionId <FUNCTION_ID> \ + --deploymentId <DEPLOYMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/delete-execution.md b/docs/examples/1.6.x/console-cli/examples/functions/delete-execution.md new file mode 100644 index 0000000000..2926b5aaf1 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/delete-execution.md @@ -0,0 +1,3 @@ +appwrite functions deleteExecution \ + --functionId <FUNCTION_ID> \ + --executionId <EXECUTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/delete-variable.md b/docs/examples/1.6.x/console-cli/examples/functions/delete-variable.md new file mode 100644 index 0000000000..835d125dc6 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/delete-variable.md @@ -0,0 +1,3 @@ +appwrite functions deleteVariable \ + --functionId <FUNCTION_ID> \ + --variableId <VARIABLE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/delete.md b/docs/examples/1.6.x/console-cli/examples/functions/delete.md new file mode 100644 index 0000000000..0eea41c849 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/delete.md @@ -0,0 +1,2 @@ +appwrite functions delete \ + --functionId <FUNCTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/download-deployment.md b/docs/examples/1.6.x/console-cli/examples/functions/download-deployment.md new file mode 100644 index 0000000000..aa440b5145 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/download-deployment.md @@ -0,0 +1,3 @@ +appwrite functions downloadDeployment \ + --functionId <FUNCTION_ID> \ + --deploymentId <DEPLOYMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get-deployment.md b/docs/examples/1.6.x/console-cli/examples/functions/get-deployment.md new file mode 100644 index 0000000000..3da1605fea --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/get-deployment.md @@ -0,0 +1,3 @@ +appwrite functions getDeployment \ + --functionId <FUNCTION_ID> \ + --deploymentId <DEPLOYMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get-execution.md b/docs/examples/1.6.x/console-cli/examples/functions/get-execution.md new file mode 100644 index 0000000000..d593f07c43 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/get-execution.md @@ -0,0 +1,3 @@ +appwrite functions getExecution \ + --functionId <FUNCTION_ID> \ + --executionId <EXECUTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get-function-usage.md b/docs/examples/1.6.x/console-cli/examples/functions/get-function-usage.md new file mode 100644 index 0000000000..0096baeec0 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/get-function-usage.md @@ -0,0 +1,3 @@ +appwrite functions getFunctionUsage \ + --functionId <FUNCTION_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get-usage.md b/docs/examples/1.6.x/console-cli/examples/functions/get-usage.md new file mode 100644 index 0000000000..a3fe7c38de --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/get-usage.md @@ -0,0 +1,2 @@ +appwrite functions getUsage \ + diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get-variable.md b/docs/examples/1.6.x/console-cli/examples/functions/get-variable.md new file mode 100644 index 0000000000..241a91d936 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/get-variable.md @@ -0,0 +1,3 @@ +appwrite functions getVariable \ + --functionId <FUNCTION_ID> \ + --variableId <VARIABLE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get.md b/docs/examples/1.6.x/console-cli/examples/functions/get.md new file mode 100644 index 0000000000..f678ef7663 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/get.md @@ -0,0 +1,2 @@ +appwrite functions get \ + --functionId <FUNCTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/list-deployments.md b/docs/examples/1.6.x/console-cli/examples/functions/list-deployments.md new file mode 100644 index 0000000000..2befb86abc --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/list-deployments.md @@ -0,0 +1,4 @@ +appwrite functions listDeployments \ + --functionId <FUNCTION_ID> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/functions/list-executions.md b/docs/examples/1.6.x/console-cli/examples/functions/list-executions.md new file mode 100644 index 0000000000..ba85ed49e6 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/list-executions.md @@ -0,0 +1,4 @@ +appwrite functions listExecutions \ + --functionId <FUNCTION_ID> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/functions/list-runtimes.md b/docs/examples/1.6.x/console-cli/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..15dc019c44 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/list-runtimes.md @@ -0,0 +1 @@ +appwrite functions listRuntimes diff --git a/docs/examples/1.6.x/console-cli/examples/functions/list-variables.md b/docs/examples/1.6.x/console-cli/examples/functions/list-variables.md new file mode 100644 index 0000000000..21bf2eb506 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/list-variables.md @@ -0,0 +1,2 @@ +appwrite functions listVariables \ + --functionId <FUNCTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/list.md b/docs/examples/1.6.x/console-cli/examples/functions/list.md new file mode 100644 index 0000000000..3b7551266e --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/list.md @@ -0,0 +1,3 @@ +appwrite functions list \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/console-cli/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..ddaf1e5955 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/update-deployment-build.md @@ -0,0 +1,3 @@ +appwrite functions updateDeploymentBuild \ + --functionId <FUNCTION_ID> \ + --deploymentId <DEPLOYMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/update-deployment.md b/docs/examples/1.6.x/console-cli/examples/functions/update-deployment.md new file mode 100644 index 0000000000..302068d453 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/update-deployment.md @@ -0,0 +1,3 @@ +appwrite functions updateDeployment \ + --functionId <FUNCTION_ID> \ + --deploymentId <DEPLOYMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/update-variable.md b/docs/examples/1.6.x/console-cli/examples/functions/update-variable.md new file mode 100644 index 0000000000..484aac13a1 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/update-variable.md @@ -0,0 +1,5 @@ +appwrite functions updateVariable \ + --functionId <FUNCTION_ID> \ + --variableId <VARIABLE_ID> \ + --key <KEY> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/functions/update.md b/docs/examples/1.6.x/console-cli/examples/functions/update.md new file mode 100644 index 0000000000..8bad859606 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/functions/update.md @@ -0,0 +1,18 @@ +appwrite functions update \ + --functionId <FUNCTION_ID> \ + --name <NAME> \ + + + + + + + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/graphql/mutation.md b/docs/examples/1.6.x/console-cli/examples/graphql/mutation.md new file mode 100644 index 0000000000..f6127a175c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/graphql/mutation.md @@ -0,0 +1,2 @@ +appwrite graphql mutation \ + --query '{ "key": "value" }' diff --git a/docs/examples/1.6.x/console-cli/examples/graphql/query.md b/docs/examples/1.6.x/console-cli/examples/graphql/query.md new file mode 100644 index 0000000000..1d84bcaa6a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/graphql/query.md @@ -0,0 +1,2 @@ +appwrite graphql query \ + --query '{ "key": "value" }' diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-antivirus.md b/docs/examples/1.6.x/console-cli/examples/health/get-antivirus.md new file mode 100644 index 0000000000..96dd7e78b2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-antivirus.md @@ -0,0 +1 @@ +appwrite health getAntivirus diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-cache.md b/docs/examples/1.6.x/console-cli/examples/health/get-cache.md new file mode 100644 index 0000000000..ad1111ccf0 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-cache.md @@ -0,0 +1 @@ +appwrite health getCache diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-certificate.md b/docs/examples/1.6.x/console-cli/examples/health/get-certificate.md new file mode 100644 index 0000000000..4659415822 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-certificate.md @@ -0,0 +1,2 @@ +appwrite health getCertificate \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-d-b.md b/docs/examples/1.6.x/console-cli/examples/health/get-d-b.md new file mode 100644 index 0000000000..b0ea2d3eac --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-d-b.md @@ -0,0 +1 @@ +appwrite health getDB diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/console-cli/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..724299e384 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-failed-jobs.md @@ -0,0 +1,3 @@ +appwrite health getFailedJobs \ + --name v1-database \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-pub-sub.md b/docs/examples/1.6.x/console-cli/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..aa1773b35b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-pub-sub.md @@ -0,0 +1 @@ +appwrite health getPubSub diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-builds.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..7204c2c896 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-builds.md @@ -0,0 +1,2 @@ +appwrite health getQueueBuilds \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..203e8650cc --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-certificates.md @@ -0,0 +1,2 @@ +appwrite health getQueueCertificates \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-databases.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..f30b941cbc --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-databases.md @@ -0,0 +1,3 @@ +appwrite health getQueueDatabases \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..1d44146dc4 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-deletes.md @@ -0,0 +1,2 @@ +appwrite health getQueueDeletes \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-functions.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..4aca467306 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-functions.md @@ -0,0 +1,2 @@ +appwrite health getQueueFunctions \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-logs.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..3f1386b73a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-logs.md @@ -0,0 +1,2 @@ +appwrite health getQueueLogs \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-mails.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..a41f4c308b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-mails.md @@ -0,0 +1,2 @@ +appwrite health getQueueMails \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..11b7ff832b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-messaging.md @@ -0,0 +1,2 @@ +appwrite health getQueueMessaging \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..2f17bb56f4 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-migrations.md @@ -0,0 +1,2 @@ +appwrite health getQueueMigrations \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..34f8abd8c0 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage-dump.md @@ -0,0 +1,2 @@ +appwrite health getQueueUsageDump \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..d021a3faa1 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage.md @@ -0,0 +1,2 @@ +appwrite health getQueueUsage \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..471175bbe4 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue-webhooks.md @@ -0,0 +1,2 @@ +appwrite health getQueueWebhooks \ + diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue.md new file mode 100644 index 0000000000..24ad16cbaa --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-queue.md @@ -0,0 +1 @@ +appwrite health getQueue diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-storage-local.md b/docs/examples/1.6.x/console-cli/examples/health/get-storage-local.md new file mode 100644 index 0000000000..b5df39fae0 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-storage-local.md @@ -0,0 +1 @@ +appwrite health getStorageLocal diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-storage.md b/docs/examples/1.6.x/console-cli/examples/health/get-storage.md new file mode 100644 index 0000000000..eccd21acc3 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-storage.md @@ -0,0 +1 @@ +appwrite health getStorage diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-time.md b/docs/examples/1.6.x/console-cli/examples/health/get-time.md new file mode 100644 index 0000000000..067e5daf9e --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get-time.md @@ -0,0 +1 @@ +appwrite health getTime diff --git a/docs/examples/1.6.x/console-cli/examples/health/get.md b/docs/examples/1.6.x/console-cli/examples/health/get.md new file mode 100644 index 0000000000..94c08e5aa3 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/health/get.md @@ -0,0 +1 @@ +appwrite health get diff --git a/docs/examples/1.6.x/console-cli/examples/locale/get.md b/docs/examples/1.6.x/console-cli/examples/locale/get.md new file mode 100644 index 0000000000..2002a06c20 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/locale/get.md @@ -0,0 +1 @@ +appwrite locale get diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-codes.md b/docs/examples/1.6.x/console-cli/examples/locale/list-codes.md new file mode 100644 index 0000000000..5586d1566c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/locale/list-codes.md @@ -0,0 +1 @@ +appwrite locale listCodes diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-continents.md b/docs/examples/1.6.x/console-cli/examples/locale/list-continents.md new file mode 100644 index 0000000000..775af5d9df --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/locale/list-continents.md @@ -0,0 +1 @@ +appwrite locale listContinents diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/console-cli/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..43b7eff7ad --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/locale/list-countries-e-u.md @@ -0,0 +1 @@ +appwrite locale listCountriesEU diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/console-cli/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..072516bf71 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/locale/list-countries-phones.md @@ -0,0 +1 @@ +appwrite locale listCountriesPhones diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-countries.md b/docs/examples/1.6.x/console-cli/examples/locale/list-countries.md new file mode 100644 index 0000000000..ee7101df68 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/locale/list-countries.md @@ -0,0 +1 @@ +appwrite locale listCountries diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-currencies.md b/docs/examples/1.6.x/console-cli/examples/locale/list-currencies.md new file mode 100644 index 0000000000..01b1b3c4b2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/locale/list-currencies.md @@ -0,0 +1 @@ +appwrite locale listCurrencies diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-languages.md b/docs/examples/1.6.x/console-cli/examples/locale/list-languages.md new file mode 100644 index 0000000000..d47622c570 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/locale/list-languages.md @@ -0,0 +1 @@ +appwrite locale listLanguages diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..8b369f403d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-apns-provider.md @@ -0,0 +1,9 @@ +appwrite messaging createApnsProvider \ + --providerId <PROVIDER_ID> \ + --name <NAME> \ + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-email.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-email.md new file mode 100644 index 0000000000..2a8e03b7da --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-email.md @@ -0,0 +1,13 @@ +appwrite messaging createEmail \ + --messageId <MESSAGE_ID> \ + --subject <SUBJECT> \ + --content <CONTENT> \ + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..a19dcbe28c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-fcm-provider.md @@ -0,0 +1,5 @@ +appwrite messaging createFcmProvider \ + --providerId <PROVIDER_ID> \ + --name <NAME> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..6b07359194 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,11 @@ +appwrite messaging createMailgunProvider \ + --providerId <PROVIDER_ID> \ + --name <NAME> \ + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..f687e36472 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-msg91provider.md @@ -0,0 +1,7 @@ +appwrite messaging createMsg91Provider \ + --providerId <PROVIDER_ID> \ + --name <NAME> \ + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-push.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-push.md new file mode 100644 index 0000000000..e187342503 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-push.md @@ -0,0 +1,17 @@ +appwrite messaging createPush \ + --messageId <MESSAGE_ID> \ + --title <TITLE> \ + --body <BODY> \ + + + + + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..de8d059abb --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,9 @@ +appwrite messaging createSendgridProvider \ + --providerId <PROVIDER_ID> \ + --name <NAME> \ + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-sms.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-sms.md new file mode 100644 index 0000000000..dfc9b27ff3 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-sms.md @@ -0,0 +1,8 @@ +appwrite messaging createSms \ + --messageId <MESSAGE_ID> \ + --content <CONTENT> \ + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..13f04fe648 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-smtp-provider.md @@ -0,0 +1,15 @@ +appwrite messaging createSmtpProvider \ + --providerId <PROVIDER_ID> \ + --name <NAME> \ + --host <HOST> \ + + + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..5e65c36df7 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-subscriber.md @@ -0,0 +1,4 @@ +appwrite messaging createSubscriber \ + --topicId <TOPIC_ID> \ + --subscriberId <SUBSCRIBER_ID> \ + --targetId <TARGET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..783f7594fd --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-telesign-provider.md @@ -0,0 +1,7 @@ +appwrite messaging createTelesignProvider \ + --providerId <PROVIDER_ID> \ + --name <NAME> \ + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..77185c71de --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,7 @@ +appwrite messaging createTextmagicProvider \ + --providerId <PROVIDER_ID> \ + --name <NAME> \ + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-topic.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-topic.md new file mode 100644 index 0000000000..1d57e1cee0 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-topic.md @@ -0,0 +1,4 @@ +appwrite messaging createTopic \ + --topicId <TOPIC_ID> \ + --name <NAME> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..91fdaae96b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-twilio-provider.md @@ -0,0 +1,7 @@ +appwrite messaging createTwilioProvider \ + --providerId <PROVIDER_ID> \ + --name <NAME> \ + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..1939d1c04b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/create-vonage-provider.md @@ -0,0 +1,7 @@ +appwrite messaging createVonageProvider \ + --providerId <PROVIDER_ID> \ + --name <NAME> \ + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/delete-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..a93885573c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/delete-provider.md @@ -0,0 +1,2 @@ +appwrite messaging deleteProvider \ + --providerId <PROVIDER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/console-cli/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..c535154df6 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/delete-subscriber.md @@ -0,0 +1,3 @@ +appwrite messaging deleteSubscriber \ + --topicId <TOPIC_ID> \ + --subscriberId <SUBSCRIBER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/delete-topic.md b/docs/examples/1.6.x/console-cli/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..1fa387c6ab --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/delete-topic.md @@ -0,0 +1,2 @@ +appwrite messaging deleteTopic \ + --topicId <TOPIC_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/delete.md b/docs/examples/1.6.x/console-cli/examples/messaging/delete.md new file mode 100644 index 0000000000..82ff141b03 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/delete.md @@ -0,0 +1,2 @@ +appwrite messaging delete \ + --messageId <MESSAGE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/get-message.md b/docs/examples/1.6.x/console-cli/examples/messaging/get-message.md new file mode 100644 index 0000000000..0144f79699 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/get-message.md @@ -0,0 +1,2 @@ +appwrite messaging getMessage \ + --messageId <MESSAGE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/get-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/get-provider.md new file mode 100644 index 0000000000..9da9f2d864 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/get-provider.md @@ -0,0 +1,2 @@ +appwrite messaging getProvider \ + --providerId <PROVIDER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/console-cli/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..02f8bc0e57 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/get-subscriber.md @@ -0,0 +1,3 @@ +appwrite messaging getSubscriber \ + --topicId <TOPIC_ID> \ + --subscriberId <SUBSCRIBER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/get-topic.md b/docs/examples/1.6.x/console-cli/examples/messaging/get-topic.md new file mode 100644 index 0000000000..feb2dc66b6 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/get-topic.md @@ -0,0 +1,2 @@ +appwrite messaging getTopic \ + --topicId <TOPIC_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..91366f35f7 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/list-message-logs.md @@ -0,0 +1,3 @@ +appwrite messaging listMessageLogs \ + --messageId <MESSAGE_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-messages.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-messages.md new file mode 100644 index 0000000000..6ab04b0fd2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/list-messages.md @@ -0,0 +1,3 @@ +appwrite messaging listMessages \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..0dee2e3f4b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/list-provider-logs.md @@ -0,0 +1,3 @@ +appwrite messaging listProviderLogs \ + --providerId <PROVIDER_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-providers.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-providers.md new file mode 100644 index 0000000000..0a2ce47a3f --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/list-providers.md @@ -0,0 +1,3 @@ +appwrite messaging listProviders \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..4a04ac4373 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,3 @@ +appwrite messaging listSubscriberLogs \ + --subscriberId <SUBSCRIBER_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..2eed8bd3f0 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/list-subscribers.md @@ -0,0 +1,4 @@ +appwrite messaging listSubscribers \ + --topicId <TOPIC_ID> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-targets.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-targets.md new file mode 100644 index 0000000000..7efa50ee3b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/list-targets.md @@ -0,0 +1,3 @@ +appwrite messaging listTargets \ + --messageId <MESSAGE_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..f23c10aba6 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/list-topic-logs.md @@ -0,0 +1,3 @@ +appwrite messaging listTopicLogs \ + --topicId <TOPIC_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-topics.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-topics.md new file mode 100644 index 0000000000..1810a7bd7b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/list-topics.md @@ -0,0 +1,3 @@ +appwrite messaging listTopics \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..9e895a066a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-apns-provider.md @@ -0,0 +1,9 @@ +appwrite messaging updateApnsProvider \ + --providerId <PROVIDER_ID> \ + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-email.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-email.md new file mode 100644 index 0000000000..934fd29213 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-email.md @@ -0,0 +1,13 @@ +appwrite messaging updateEmail \ + --messageId <MESSAGE_ID> \ + + + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..000022361f --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-fcm-provider.md @@ -0,0 +1,5 @@ +appwrite messaging updateFcmProvider \ + --providerId <PROVIDER_ID> \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..f35c5e9157 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,11 @@ +appwrite messaging updateMailgunProvider \ + --providerId <PROVIDER_ID> \ + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..8e2d604a19 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-msg91provider.md @@ -0,0 +1,7 @@ +appwrite messaging updateMsg91Provider \ + --providerId <PROVIDER_ID> \ + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-push.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-push.md new file mode 100644 index 0000000000..70f215c935 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-push.md @@ -0,0 +1,17 @@ +appwrite messaging updatePush \ + --messageId <MESSAGE_ID> \ + + + + + + + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..7f2e97dbf7 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,9 @@ +appwrite messaging updateSendgridProvider \ + --providerId <PROVIDER_ID> \ + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-sms.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-sms.md new file mode 100644 index 0000000000..a30ff43d0c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-sms.md @@ -0,0 +1,8 @@ +appwrite messaging updateSms \ + --messageId <MESSAGE_ID> \ + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..4e0f7b6b8d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-smtp-provider.md @@ -0,0 +1,15 @@ +appwrite messaging updateSmtpProvider \ + --providerId <PROVIDER_ID> \ + + + + + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..0a92f2cacd --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-telesign-provider.md @@ -0,0 +1,7 @@ +appwrite messaging updateTelesignProvider \ + --providerId <PROVIDER_ID> \ + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..79160b2461 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,7 @@ +appwrite messaging updateTextmagicProvider \ + --providerId <PROVIDER_ID> \ + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-topic.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-topic.md new file mode 100644 index 0000000000..d10b0edde3 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-topic.md @@ -0,0 +1,4 @@ +appwrite messaging updateTopic \ + --topicId <TOPIC_ID> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..c967d724af --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-twilio-provider.md @@ -0,0 +1,7 @@ +appwrite messaging updateTwilioProvider \ + --providerId <PROVIDER_ID> \ + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..11f7963be2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/messaging/update-vonage-provider.md @@ -0,0 +1,7 @@ +appwrite messaging updateVonageProvider \ + --providerId <PROVIDER_ID> \ + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/create-appwrite-migration.md b/docs/examples/1.6.x/console-cli/examples/migrations/create-appwrite-migration.md new file mode 100644 index 0000000000..73e9ee62d8 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/create-appwrite-migration.md @@ -0,0 +1,5 @@ +appwrite migrations createAppwriteMigration \ + --resources one two three \ + --endpoint https://example.com \ + --projectId <PROJECT_ID> \ + --apiKey <API_KEY> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-migration.md b/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-migration.md new file mode 100644 index 0000000000..3dfb3aeac6 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-migration.md @@ -0,0 +1,3 @@ +appwrite migrations createFirebaseMigration \ + --resources one two three \ + --serviceAccount <SERVICE_ACCOUNT> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-o-auth-migration.md b/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-o-auth-migration.md new file mode 100644 index 0000000000..207becba03 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-o-auth-migration.md @@ -0,0 +1,3 @@ +appwrite migrations createFirebaseOAuthMigration \ + --resources one two three \ + --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/create-n-host-migration.md b/docs/examples/1.6.x/console-cli/examples/migrations/create-n-host-migration.md new file mode 100644 index 0000000000..d959897109 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/create-n-host-migration.md @@ -0,0 +1,9 @@ +appwrite migrations createNHostMigration \ + --resources one two three \ + --subdomain <SUBDOMAIN> \ + --region <REGION> \ + --adminSecret <ADMIN_SECRET> \ + --database <DATABASE> \ + --username <USERNAME> \ + --password <PASSWORD> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/create-supabase-migration.md b/docs/examples/1.6.x/console-cli/examples/migrations/create-supabase-migration.md new file mode 100644 index 0000000000..0620f3ba2e --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/create-supabase-migration.md @@ -0,0 +1,8 @@ +appwrite migrations createSupabaseMigration \ + --resources one two three \ + --endpoint https://example.com \ + --apiKey <API_KEY> \ + --databaseHost <DATABASE_HOST> \ + --username <USERNAME> \ + --password <PASSWORD> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/delete-firebase-auth.md b/docs/examples/1.6.x/console-cli/examples/migrations/delete-firebase-auth.md new file mode 100644 index 0000000000..d58abd9878 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/delete-firebase-auth.md @@ -0,0 +1 @@ +appwrite migrations deleteFirebaseAuth diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/delete.md b/docs/examples/1.6.x/console-cli/examples/migrations/delete.md new file mode 100644 index 0000000000..9dac1aa3db --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/delete.md @@ -0,0 +1,2 @@ +appwrite migrations delete \ + --migrationId <MIGRATION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get-appwrite-report.md b/docs/examples/1.6.x/console-cli/examples/migrations/get-appwrite-report.md new file mode 100644 index 0000000000..745e9fb98c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/get-appwrite-report.md @@ -0,0 +1,5 @@ +appwrite migrations getAppwriteReport \ + --resources one two three \ + --endpoint https://example.com \ + --projectID <PROJECT_ID> \ + --key <KEY> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report-o-auth.md b/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report-o-auth.md new file mode 100644 index 0000000000..0bdbf3e435 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report-o-auth.md @@ -0,0 +1,3 @@ +appwrite migrations getFirebaseReportOAuth \ + --resources one two three \ + --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report.md b/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report.md new file mode 100644 index 0000000000..73c7e1ca14 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report.md @@ -0,0 +1,3 @@ +appwrite migrations getFirebaseReport \ + --resources one two three \ + --serviceAccount <SERVICE_ACCOUNT> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get-n-host-report.md b/docs/examples/1.6.x/console-cli/examples/migrations/get-n-host-report.md new file mode 100644 index 0000000000..6b7e2eaff2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/get-n-host-report.md @@ -0,0 +1,9 @@ +appwrite migrations getNHostReport \ + --resources one two three \ + --subdomain <SUBDOMAIN> \ + --region <REGION> \ + --adminSecret <ADMIN_SECRET> \ + --database <DATABASE> \ + --username <USERNAME> \ + --password <PASSWORD> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get-supabase-report.md b/docs/examples/1.6.x/console-cli/examples/migrations/get-supabase-report.md new file mode 100644 index 0000000000..9754f38e24 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/get-supabase-report.md @@ -0,0 +1,8 @@ +appwrite migrations getSupabaseReport \ + --resources one two three \ + --endpoint https://example.com \ + --apiKey <API_KEY> \ + --databaseHost <DATABASE_HOST> \ + --username <USERNAME> \ + --password <PASSWORD> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get.md b/docs/examples/1.6.x/console-cli/examples/migrations/get.md new file mode 100644 index 0000000000..8810646c7e --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/get.md @@ -0,0 +1,2 @@ +appwrite migrations get \ + --migrationId <MIGRATION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/list-firebase-projects.md b/docs/examples/1.6.x/console-cli/examples/migrations/list-firebase-projects.md new file mode 100644 index 0000000000..a0e59713eb --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/list-firebase-projects.md @@ -0,0 +1 @@ +appwrite migrations listFirebaseProjects diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/list.md b/docs/examples/1.6.x/console-cli/examples/migrations/list.md new file mode 100644 index 0000000000..c120a61e80 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/list.md @@ -0,0 +1,3 @@ +appwrite migrations list \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/retry.md b/docs/examples/1.6.x/console-cli/examples/migrations/retry.md new file mode 100644 index 0000000000..518f86cee7 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/migrations/retry.md @@ -0,0 +1,2 @@ +appwrite migrations retry \ + --migrationId <MIGRATION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/project/create-variable.md b/docs/examples/1.6.x/console-cli/examples/project/create-variable.md new file mode 100644 index 0000000000..a587ac3eab --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/project/create-variable.md @@ -0,0 +1,3 @@ +appwrite project createVariable \ + --key <KEY> \ + --value <VALUE> diff --git a/docs/examples/1.6.x/console-cli/examples/project/delete-variable.md b/docs/examples/1.6.x/console-cli/examples/project/delete-variable.md new file mode 100644 index 0000000000..7fdda874fd --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/project/delete-variable.md @@ -0,0 +1,2 @@ +appwrite project deleteVariable \ + --variableId <VARIABLE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/project/get-usage.md b/docs/examples/1.6.x/console-cli/examples/project/get-usage.md new file mode 100644 index 0000000000..9b4c296a8c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/project/get-usage.md @@ -0,0 +1,4 @@ +appwrite project getUsage \ + --startDate '' \ + --endDate '' \ + diff --git a/docs/examples/1.6.x/console-cli/examples/project/get-variable.md b/docs/examples/1.6.x/console-cli/examples/project/get-variable.md new file mode 100644 index 0000000000..b2d482586b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/project/get-variable.md @@ -0,0 +1,2 @@ +appwrite project getVariable \ + --variableId <VARIABLE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/project/list-variables.md b/docs/examples/1.6.x/console-cli/examples/project/list-variables.md new file mode 100644 index 0000000000..bd26c7db6b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/project/list-variables.md @@ -0,0 +1 @@ +appwrite project listVariables diff --git a/docs/examples/1.6.x/console-cli/examples/project/update-variable.md b/docs/examples/1.6.x/console-cli/examples/project/update-variable.md new file mode 100644 index 0000000000..946696418c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/project/update-variable.md @@ -0,0 +1,4 @@ +appwrite project updateVariable \ + --variableId <VARIABLE_ID> \ + --key <KEY> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create-j-w-t.md b/docs/examples/1.6.x/console-cli/examples/projects/create-j-w-t.md new file mode 100644 index 0000000000..d703d36b65 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/create-j-w-t.md @@ -0,0 +1,4 @@ +appwrite projects createJWT \ + --projectId <PROJECT_ID> \ + --scopes one two three \ + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create-key.md b/docs/examples/1.6.x/console-cli/examples/projects/create-key.md new file mode 100644 index 0000000000..fb986dcebc --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/create-key.md @@ -0,0 +1,5 @@ +appwrite projects createKey \ + --projectId <PROJECT_ID> \ + --name <NAME> \ + --scopes one two three \ + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create-platform.md b/docs/examples/1.6.x/console-cli/examples/projects/create-platform.md new file mode 100644 index 0000000000..8727d21d64 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/create-platform.md @@ -0,0 +1,7 @@ +appwrite projects createPlatform \ + --projectId <PROJECT_ID> \ + --type web \ + --name <NAME> \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create-smtp-test.md b/docs/examples/1.6.x/console-cli/examples/projects/create-smtp-test.md new file mode 100644 index 0000000000..66ce5880aa --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/create-smtp-test.md @@ -0,0 +1,11 @@ +appwrite projects createSmtpTest \ + --projectId <PROJECT_ID> \ + --emails one two three \ + --senderName <SENDER_NAME> \ + --senderEmail email@example.com \ + --host '' \ + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create-webhook.md b/docs/examples/1.6.x/console-cli/examples/projects/create-webhook.md new file mode 100644 index 0000000000..03ecf4110d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/create-webhook.md @@ -0,0 +1,9 @@ +appwrite projects createWebhook \ + --projectId <PROJECT_ID> \ + --name <NAME> \ + --events one two three \ + --url '' \ + --security false \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create.md b/docs/examples/1.6.x/console-cli/examples/projects/create.md new file mode 100644 index 0000000000..0504785503 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/create.md @@ -0,0 +1,14 @@ +appwrite projects create \ + --projectId '' \ + --name <NAME> \ + --teamId <TEAM_ID> \ + + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete-email-template.md b/docs/examples/1.6.x/console-cli/examples/projects/delete-email-template.md new file mode 100644 index 0000000000..01ce0fac68 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/delete-email-template.md @@ -0,0 +1,4 @@ +appwrite projects deleteEmailTemplate \ + --projectId <PROJECT_ID> \ + --type verification \ + --locale af diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete-key.md b/docs/examples/1.6.x/console-cli/examples/projects/delete-key.md new file mode 100644 index 0000000000..6baf05706e --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/delete-key.md @@ -0,0 +1,3 @@ +appwrite projects deleteKey \ + --projectId <PROJECT_ID> \ + --keyId <KEY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete-platform.md b/docs/examples/1.6.x/console-cli/examples/projects/delete-platform.md new file mode 100644 index 0000000000..a85bd865ba --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/delete-platform.md @@ -0,0 +1,3 @@ +appwrite projects deletePlatform \ + --projectId <PROJECT_ID> \ + --platformId <PLATFORM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete-sms-template.md b/docs/examples/1.6.x/console-cli/examples/projects/delete-sms-template.md new file mode 100644 index 0000000000..3afcf649c7 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/delete-sms-template.md @@ -0,0 +1,4 @@ +appwrite projects deleteSmsTemplate \ + --projectId <PROJECT_ID> \ + --type verification \ + --locale af diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete-webhook.md b/docs/examples/1.6.x/console-cli/examples/projects/delete-webhook.md new file mode 100644 index 0000000000..a67301ef07 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/delete-webhook.md @@ -0,0 +1,3 @@ +appwrite projects deleteWebhook \ + --projectId <PROJECT_ID> \ + --webhookId <WEBHOOK_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete.md b/docs/examples/1.6.x/console-cli/examples/projects/delete.md new file mode 100644 index 0000000000..a4ffc70c91 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/delete.md @@ -0,0 +1,2 @@ +appwrite projects delete \ + --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get-email-template.md b/docs/examples/1.6.x/console-cli/examples/projects/get-email-template.md new file mode 100644 index 0000000000..6e4c21e52b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/get-email-template.md @@ -0,0 +1,4 @@ +appwrite projects getEmailTemplate \ + --projectId <PROJECT_ID> \ + --type verification \ + --locale af diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get-key.md b/docs/examples/1.6.x/console-cli/examples/projects/get-key.md new file mode 100644 index 0000000000..f69b51bbe2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/get-key.md @@ -0,0 +1,3 @@ +appwrite projects getKey \ + --projectId <PROJECT_ID> \ + --keyId <KEY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get-platform.md b/docs/examples/1.6.x/console-cli/examples/projects/get-platform.md new file mode 100644 index 0000000000..67648be035 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/get-platform.md @@ -0,0 +1,3 @@ +appwrite projects getPlatform \ + --projectId <PROJECT_ID> \ + --platformId <PLATFORM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get-sms-template.md b/docs/examples/1.6.x/console-cli/examples/projects/get-sms-template.md new file mode 100644 index 0000000000..c655953c8e --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/get-sms-template.md @@ -0,0 +1,4 @@ +appwrite projects getSmsTemplate \ + --projectId <PROJECT_ID> \ + --type verification \ + --locale af diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get-webhook.md b/docs/examples/1.6.x/console-cli/examples/projects/get-webhook.md new file mode 100644 index 0000000000..890bf37069 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/get-webhook.md @@ -0,0 +1,3 @@ +appwrite projects getWebhook \ + --projectId <PROJECT_ID> \ + --webhookId <WEBHOOK_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get.md b/docs/examples/1.6.x/console-cli/examples/projects/get.md new file mode 100644 index 0000000000..919321b81d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/get.md @@ -0,0 +1,2 @@ +appwrite projects get \ + --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/list-keys.md b/docs/examples/1.6.x/console-cli/examples/projects/list-keys.md new file mode 100644 index 0000000000..cc37680b5b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/list-keys.md @@ -0,0 +1,2 @@ +appwrite projects listKeys \ + --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/list-platforms.md b/docs/examples/1.6.x/console-cli/examples/projects/list-platforms.md new file mode 100644 index 0000000000..5fc2ea4106 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/list-platforms.md @@ -0,0 +1,2 @@ +appwrite projects listPlatforms \ + --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/list-webhooks.md b/docs/examples/1.6.x/console-cli/examples/projects/list-webhooks.md new file mode 100644 index 0000000000..dcf9953f80 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/list-webhooks.md @@ -0,0 +1,2 @@ +appwrite projects listWebhooks \ + --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/list.md b/docs/examples/1.6.x/console-cli/examples/projects/list.md new file mode 100644 index 0000000000..0d3dd7a539 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/list.md @@ -0,0 +1,3 @@ +appwrite projects list \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-api-status-all.md b/docs/examples/1.6.x/console-cli/examples/projects/update-api-status-all.md new file mode 100644 index 0000000000..e5f63c59a3 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-api-status-all.md @@ -0,0 +1,3 @@ +appwrite projects updateApiStatusAll \ + --projectId <PROJECT_ID> \ + --status false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-api-status.md b/docs/examples/1.6.x/console-cli/examples/projects/update-api-status.md new file mode 100644 index 0000000000..01120957af --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-api-status.md @@ -0,0 +1,4 @@ +appwrite projects updateApiStatus \ + --projectId <PROJECT_ID> \ + --api rest \ + --status false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-duration.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-duration.md new file mode 100644 index 0000000000..ad6f8ac97c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-duration.md @@ -0,0 +1,3 @@ +appwrite projects updateAuthDuration \ + --projectId <PROJECT_ID> \ + --duration 0 diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-limit.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-limit.md new file mode 100644 index 0000000000..9d01fa5a1a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-limit.md @@ -0,0 +1,3 @@ +appwrite projects updateAuthLimit \ + --projectId <PROJECT_ID> \ + --limit 0 diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-dictionary.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-dictionary.md new file mode 100644 index 0000000000..f477bba56d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-dictionary.md @@ -0,0 +1,3 @@ +appwrite projects updateAuthPasswordDictionary \ + --projectId <PROJECT_ID> \ + --enabled false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-history.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-history.md new file mode 100644 index 0000000000..8b9b90a32a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-history.md @@ -0,0 +1,3 @@ +appwrite projects updateAuthPasswordHistory \ + --projectId <PROJECT_ID> \ + --limit 0 diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-sessions-limit.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-sessions-limit.md new file mode 100644 index 0000000000..2a1294d17b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-sessions-limit.md @@ -0,0 +1,3 @@ +appwrite projects updateAuthSessionsLimit \ + --projectId <PROJECT_ID> \ + --limit 1 diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-status.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-status.md new file mode 100644 index 0000000000..848987b2f8 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-status.md @@ -0,0 +1,4 @@ +appwrite projects updateAuthStatus \ + --projectId <PROJECT_ID> \ + --method email-password \ + --status false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-email-template.md b/docs/examples/1.6.x/console-cli/examples/projects/update-email-template.md new file mode 100644 index 0000000000..a3acd066ec --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-email-template.md @@ -0,0 +1,9 @@ +appwrite projects updateEmailTemplate \ + --projectId <PROJECT_ID> \ + --type verification \ + --locale af \ + --subject <SUBJECT> \ + --message <MESSAGE> \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-key.md b/docs/examples/1.6.x/console-cli/examples/projects/update-key.md new file mode 100644 index 0000000000..6d3dc198da --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-key.md @@ -0,0 +1,6 @@ +appwrite projects updateKey \ + --projectId <PROJECT_ID> \ + --keyId <KEY_ID> \ + --name <NAME> \ + --scopes one two three \ + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-mock-numbers.md b/docs/examples/1.6.x/console-cli/examples/projects/update-mock-numbers.md new file mode 100644 index 0000000000..733cc16887 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-mock-numbers.md @@ -0,0 +1,3 @@ +appwrite projects updateMockNumbers \ + --projectId <PROJECT_ID> \ + --numbers one two three diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-o-auth2.md b/docs/examples/1.6.x/console-cli/examples/projects/update-o-auth2.md new file mode 100644 index 0000000000..92f6718962 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-o-auth2.md @@ -0,0 +1,6 @@ +appwrite projects updateOAuth2 \ + --projectId <PROJECT_ID> \ + --provider amazon \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-personal-data-check.md b/docs/examples/1.6.x/console-cli/examples/projects/update-personal-data-check.md new file mode 100644 index 0000000000..21dca78369 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-personal-data-check.md @@ -0,0 +1,3 @@ +appwrite projects updatePersonalDataCheck \ + --projectId <PROJECT_ID> \ + --enabled false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-platform.md b/docs/examples/1.6.x/console-cli/examples/projects/update-platform.md new file mode 100644 index 0000000000..05b1602ae9 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-platform.md @@ -0,0 +1,7 @@ +appwrite projects updatePlatform \ + --projectId <PROJECT_ID> \ + --platformId <PLATFORM_ID> \ + --name <NAME> \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-service-status-all.md b/docs/examples/1.6.x/console-cli/examples/projects/update-service-status-all.md new file mode 100644 index 0000000000..1ffb77e085 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-service-status-all.md @@ -0,0 +1,3 @@ +appwrite projects updateServiceStatusAll \ + --projectId <PROJECT_ID> \ + --status false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-service-status.md b/docs/examples/1.6.x/console-cli/examples/projects/update-service-status.md new file mode 100644 index 0000000000..03963a1214 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-service-status.md @@ -0,0 +1,4 @@ +appwrite projects updateServiceStatus \ + --projectId <PROJECT_ID> \ + --service account \ + --status false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-session-alerts.md b/docs/examples/1.6.x/console-cli/examples/projects/update-session-alerts.md new file mode 100644 index 0000000000..bd23b7417a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-session-alerts.md @@ -0,0 +1,3 @@ +appwrite projects updateSessionAlerts \ + --projectId <PROJECT_ID> \ + --alerts false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-sms-template.md b/docs/examples/1.6.x/console-cli/examples/projects/update-sms-template.md new file mode 100644 index 0000000000..fc8310eb25 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-sms-template.md @@ -0,0 +1,5 @@ +appwrite projects updateSmsTemplate \ + --projectId <PROJECT_ID> \ + --type verification \ + --locale af \ + --message <MESSAGE> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-smtp.md b/docs/examples/1.6.x/console-cli/examples/projects/update-smtp.md new file mode 100644 index 0000000000..0afbe9cec9 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-smtp.md @@ -0,0 +1,11 @@ +appwrite projects updateSmtp \ + --projectId <PROJECT_ID> \ + --enabled false \ + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-team.md b/docs/examples/1.6.x/console-cli/examples/projects/update-team.md new file mode 100644 index 0000000000..49214ad9f3 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-team.md @@ -0,0 +1,3 @@ +appwrite projects updateTeam \ + --projectId <PROJECT_ID> \ + --teamId <TEAM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-webhook-signature.md b/docs/examples/1.6.x/console-cli/examples/projects/update-webhook-signature.md new file mode 100644 index 0000000000..6034ef01f6 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-webhook-signature.md @@ -0,0 +1,3 @@ +appwrite projects updateWebhookSignature \ + --projectId <PROJECT_ID> \ + --webhookId <WEBHOOK_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-webhook.md b/docs/examples/1.6.x/console-cli/examples/projects/update-webhook.md new file mode 100644 index 0000000000..51c536d74c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update-webhook.md @@ -0,0 +1,10 @@ +appwrite projects updateWebhook \ + --projectId <PROJECT_ID> \ + --webhookId <WEBHOOK_ID> \ + --name <NAME> \ + --events one two three \ + --url '' \ + --security false \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update.md b/docs/examples/1.6.x/console-cli/examples/projects/update.md new file mode 100644 index 0000000000..d4df289636 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/projects/update.md @@ -0,0 +1,12 @@ +appwrite projects update \ + --projectId <PROJECT_ID> \ + --name <NAME> \ + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/proxy/create-rule.md b/docs/examples/1.6.x/console-cli/examples/proxy/create-rule.md new file mode 100644 index 0000000000..3d821040a7 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/proxy/create-rule.md @@ -0,0 +1,4 @@ +appwrite proxy createRule \ + --domain '' \ + --resourceType api \ + diff --git a/docs/examples/1.6.x/console-cli/examples/proxy/delete-rule.md b/docs/examples/1.6.x/console-cli/examples/proxy/delete-rule.md new file mode 100644 index 0000000000..b11b6ca23e --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/proxy/delete-rule.md @@ -0,0 +1,2 @@ +appwrite proxy deleteRule \ + --ruleId <RULE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/proxy/get-rule.md b/docs/examples/1.6.x/console-cli/examples/proxy/get-rule.md new file mode 100644 index 0000000000..85d11a50b1 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/proxy/get-rule.md @@ -0,0 +1,2 @@ +appwrite proxy getRule \ + --ruleId <RULE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/proxy/list-rules.md b/docs/examples/1.6.x/console-cli/examples/proxy/list-rules.md new file mode 100644 index 0000000000..bc654bac5c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/proxy/list-rules.md @@ -0,0 +1,3 @@ +appwrite proxy listRules \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/proxy/update-rule-verification.md b/docs/examples/1.6.x/console-cli/examples/proxy/update-rule-verification.md new file mode 100644 index 0000000000..8200d15702 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/proxy/update-rule-verification.md @@ -0,0 +1,2 @@ +appwrite proxy updateRuleVerification \ + --ruleId <RULE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/create-bucket.md b/docs/examples/1.6.x/console-cli/examples/storage/create-bucket.md new file mode 100644 index 0000000000..878c10d253 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/create-bucket.md @@ -0,0 +1,11 @@ +appwrite storage createBucket \ + --bucketId <BUCKET_ID> \ + --name <NAME> \ + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/storage/create-file.md b/docs/examples/1.6.x/console-cli/examples/storage/create-file.md new file mode 100644 index 0000000000..67bd4da2c0 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/create-file.md @@ -0,0 +1,5 @@ +appwrite storage createFile \ + --bucketId <BUCKET_ID> \ + --fileId <FILE_ID> \ + --file 'path/to/file.png' \ + diff --git a/docs/examples/1.6.x/console-cli/examples/storage/delete-bucket.md b/docs/examples/1.6.x/console-cli/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..e51797e12c --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/delete-bucket.md @@ -0,0 +1,2 @@ +appwrite storage deleteBucket \ + --bucketId <BUCKET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/delete-file.md b/docs/examples/1.6.x/console-cli/examples/storage/delete-file.md new file mode 100644 index 0000000000..79c03e8288 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/delete-file.md @@ -0,0 +1,3 @@ +appwrite storage deleteFile \ + --bucketId <BUCKET_ID> \ + --fileId <FILE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-bucket-usage.md b/docs/examples/1.6.x/console-cli/examples/storage/get-bucket-usage.md new file mode 100644 index 0000000000..df3659c60a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/get-bucket-usage.md @@ -0,0 +1,3 @@ +appwrite storage getBucketUsage \ + --bucketId <BUCKET_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-bucket.md b/docs/examples/1.6.x/console-cli/examples/storage/get-bucket.md new file mode 100644 index 0000000000..cf8725b35d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/get-bucket.md @@ -0,0 +1,2 @@ +appwrite storage getBucket \ + --bucketId <BUCKET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-file-download.md b/docs/examples/1.6.x/console-cli/examples/storage/get-file-download.md new file mode 100644 index 0000000000..c97c074b35 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/get-file-download.md @@ -0,0 +1,3 @@ +appwrite storage getFileDownload \ + --bucketId <BUCKET_ID> \ + --fileId <FILE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-file-preview.md b/docs/examples/1.6.x/console-cli/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..82565fb5e7 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/get-file-preview.md @@ -0,0 +1,14 @@ +appwrite storage getFilePreview \ + --bucketId <BUCKET_ID> \ + --fileId <FILE_ID> \ + + + + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-file-view.md b/docs/examples/1.6.x/console-cli/examples/storage/get-file-view.md new file mode 100644 index 0000000000..ac3bb9d742 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/get-file-view.md @@ -0,0 +1,3 @@ +appwrite storage getFileView \ + --bucketId <BUCKET_ID> \ + --fileId <FILE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-file.md b/docs/examples/1.6.x/console-cli/examples/storage/get-file.md new file mode 100644 index 0000000000..641c20d2b0 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/get-file.md @@ -0,0 +1,3 @@ +appwrite storage getFile \ + --bucketId <BUCKET_ID> \ + --fileId <FILE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-usage.md b/docs/examples/1.6.x/console-cli/examples/storage/get-usage.md new file mode 100644 index 0000000000..29466e02f0 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/get-usage.md @@ -0,0 +1,2 @@ +appwrite storage getUsage \ + diff --git a/docs/examples/1.6.x/console-cli/examples/storage/list-buckets.md b/docs/examples/1.6.x/console-cli/examples/storage/list-buckets.md new file mode 100644 index 0000000000..a5cad1988f --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/list-buckets.md @@ -0,0 +1,3 @@ +appwrite storage listBuckets \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/storage/list-files.md b/docs/examples/1.6.x/console-cli/examples/storage/list-files.md new file mode 100644 index 0000000000..0e1c2f09c0 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/list-files.md @@ -0,0 +1,4 @@ +appwrite storage listFiles \ + --bucketId <BUCKET_ID> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/storage/update-bucket.md b/docs/examples/1.6.x/console-cli/examples/storage/update-bucket.md new file mode 100644 index 0000000000..b006a7bf74 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/update-bucket.md @@ -0,0 +1,11 @@ +appwrite storage updateBucket \ + --bucketId <BUCKET_ID> \ + --name <NAME> \ + + + + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/storage/update-file.md b/docs/examples/1.6.x/console-cli/examples/storage/update-file.md new file mode 100644 index 0000000000..593ea658a0 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/storage/update-file.md @@ -0,0 +1,5 @@ +appwrite storage updateFile \ + --bucketId <BUCKET_ID> \ + --fileId <FILE_ID> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/teams/create-membership.md b/docs/examples/1.6.x/console-cli/examples/teams/create-membership.md new file mode 100644 index 0000000000..0d0fc8df09 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/create-membership.md @@ -0,0 +1,8 @@ +appwrite teams createMembership \ + --teamId <TEAM_ID> \ + --roles one two three \ + + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/teams/create.md b/docs/examples/1.6.x/console-cli/examples/teams/create.md new file mode 100644 index 0000000000..e0f9a126f2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/create.md @@ -0,0 +1,4 @@ +appwrite teams create \ + --teamId <TEAM_ID> \ + --name <NAME> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/teams/delete-membership.md b/docs/examples/1.6.x/console-cli/examples/teams/delete-membership.md new file mode 100644 index 0000000000..58d0adbac7 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/delete-membership.md @@ -0,0 +1,3 @@ +appwrite teams deleteMembership \ + --teamId <TEAM_ID> \ + --membershipId <MEMBERSHIP_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/delete.md b/docs/examples/1.6.x/console-cli/examples/teams/delete.md new file mode 100644 index 0000000000..5b018158cd --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/delete.md @@ -0,0 +1,2 @@ +appwrite teams delete \ + --teamId <TEAM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/get-membership.md b/docs/examples/1.6.x/console-cli/examples/teams/get-membership.md new file mode 100644 index 0000000000..5e6af4c1a1 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/get-membership.md @@ -0,0 +1,3 @@ +appwrite teams getMembership \ + --teamId <TEAM_ID> \ + --membershipId <MEMBERSHIP_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/get-prefs.md b/docs/examples/1.6.x/console-cli/examples/teams/get-prefs.md new file mode 100644 index 0000000000..2ab1f1dc01 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/get-prefs.md @@ -0,0 +1,2 @@ +appwrite teams getPrefs \ + --teamId <TEAM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/get.md b/docs/examples/1.6.x/console-cli/examples/teams/get.md new file mode 100644 index 0000000000..c8e75b7543 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/get.md @@ -0,0 +1,2 @@ +appwrite teams get \ + --teamId <TEAM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/list-logs.md b/docs/examples/1.6.x/console-cli/examples/teams/list-logs.md new file mode 100644 index 0000000000..66149350d8 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/list-logs.md @@ -0,0 +1,3 @@ +appwrite teams listLogs \ + --teamId <TEAM_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/teams/list-memberships.md b/docs/examples/1.6.x/console-cli/examples/teams/list-memberships.md new file mode 100644 index 0000000000..050ea961d2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/list-memberships.md @@ -0,0 +1,4 @@ +appwrite teams listMemberships \ + --teamId <TEAM_ID> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/teams/list.md b/docs/examples/1.6.x/console-cli/examples/teams/list.md new file mode 100644 index 0000000000..dfffc4d4dd --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/list.md @@ -0,0 +1,3 @@ +appwrite teams list \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/teams/update-membership-status.md b/docs/examples/1.6.x/console-cli/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..aa4acf9457 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/update-membership-status.md @@ -0,0 +1,5 @@ +appwrite teams updateMembershipStatus \ + --teamId <TEAM_ID> \ + --membershipId <MEMBERSHIP_ID> \ + --userId <USER_ID> \ + --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/update-membership.md b/docs/examples/1.6.x/console-cli/examples/teams/update-membership.md new file mode 100644 index 0000000000..6cfda92920 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/update-membership.md @@ -0,0 +1,4 @@ +appwrite teams updateMembership \ + --teamId <TEAM_ID> \ + --membershipId <MEMBERSHIP_ID> \ + --roles one two three diff --git a/docs/examples/1.6.x/console-cli/examples/teams/update-name.md b/docs/examples/1.6.x/console-cli/examples/teams/update-name.md new file mode 100644 index 0000000000..8c73e00d7b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/update-name.md @@ -0,0 +1,3 @@ +appwrite teams updateName \ + --teamId <TEAM_ID> \ + --name <NAME> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/update-prefs.md b/docs/examples/1.6.x/console-cli/examples/teams/update-prefs.md new file mode 100644 index 0000000000..b6fc5a8f6e --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/teams/update-prefs.md @@ -0,0 +1,3 @@ +appwrite teams updatePrefs \ + --teamId <TEAM_ID> \ + --prefs '{ "key": "value" }' diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-argon2user.md b/docs/examples/1.6.x/console-cli/examples/users/create-argon2user.md new file mode 100644 index 0000000000..b0c7494e20 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-argon2user.md @@ -0,0 +1,5 @@ +appwrite users createArgon2User \ + --userId <USER_ID> \ + --email email@example.com \ + --password password \ + diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/console-cli/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..b5686721b5 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-bcrypt-user.md @@ -0,0 +1,5 @@ +appwrite users createBcryptUser \ + --userId <USER_ID> \ + --email email@example.com \ + --password password \ + diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-j-w-t.md b/docs/examples/1.6.x/console-cli/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..220086bb1a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-j-w-t.md @@ -0,0 +1,4 @@ +appwrite users createJWT \ + --userId <USER_ID> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-m-d5user.md b/docs/examples/1.6.x/console-cli/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..ba37a78be2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-m-d5user.md @@ -0,0 +1,5 @@ +appwrite users createMD5User \ + --userId <USER_ID> \ + --email email@example.com \ + --password password \ + diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..4dbd98ff8a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,2 @@ +appwrite users createMfaRecoveryCodes \ + --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/console-cli/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..9dc378dc99 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-p-h-pass-user.md @@ -0,0 +1,5 @@ +appwrite users createPHPassUser \ + --userId <USER_ID> \ + --email email@example.com \ + --password password \ + diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/console-cli/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..57483625e9 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-s-h-a-user.md @@ -0,0 +1,6 @@ +appwrite users createSHAUser \ + --userId <USER_ID> \ + --email email@example.com \ + --password password \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..25fc60b6e1 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,8 @@ +appwrite users createScryptModifiedUser \ + --userId <USER_ID> \ + --email email@example.com \ + --password password \ + --passwordSalt <PASSWORD_SALT> \ + --passwordSaltSeparator <PASSWORD_SALT_SEPARATOR> \ + --passwordSignerKey <PASSWORD_SIGNER_KEY> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..3fc56b1ee3 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-user.md @@ -0,0 +1,10 @@ +appwrite users createScryptUser \ + --userId <USER_ID> \ + --email email@example.com \ + --password password \ + --passwordSalt <PASSWORD_SALT> \ + --passwordCpu null \ + --passwordMemory null \ + --passwordParallel null \ + --passwordLength null \ + diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-session.md b/docs/examples/1.6.x/console-cli/examples/users/create-session.md new file mode 100644 index 0000000000..c8938fa706 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-session.md @@ -0,0 +1,2 @@ +appwrite users createSession \ + --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-target.md b/docs/examples/1.6.x/console-cli/examples/users/create-target.md new file mode 100644 index 0000000000..8d9306b00e --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-target.md @@ -0,0 +1,7 @@ +appwrite users createTarget \ + --userId <USER_ID> \ + --targetId <TARGET_ID> \ + --providerType email \ + --identifier <IDENTIFIER> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-token.md b/docs/examples/1.6.x/console-cli/examples/users/create-token.md new file mode 100644 index 0000000000..9962e72c73 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create-token.md @@ -0,0 +1,4 @@ +appwrite users createToken \ + --userId <USER_ID> \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/users/create.md b/docs/examples/1.6.x/console-cli/examples/users/create.md new file mode 100644 index 0000000000..e828f56ecb --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/create.md @@ -0,0 +1,6 @@ +appwrite users create \ + --userId <USER_ID> \ + + + + diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete-identity.md b/docs/examples/1.6.x/console-cli/examples/users/delete-identity.md new file mode 100644 index 0000000000..f3d2d6d980 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/delete-identity.md @@ -0,0 +1,2 @@ +appwrite users deleteIdentity \ + --identityId <IDENTITY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/console-cli/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..edc67d0b9a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,3 @@ +appwrite users deleteMfaAuthenticator \ + --userId <USER_ID> \ + --type totp diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete-session.md b/docs/examples/1.6.x/console-cli/examples/users/delete-session.md new file mode 100644 index 0000000000..9f1fbdbfb3 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/delete-session.md @@ -0,0 +1,3 @@ +appwrite users deleteSession \ + --userId <USER_ID> \ + --sessionId <SESSION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete-sessions.md b/docs/examples/1.6.x/console-cli/examples/users/delete-sessions.md new file mode 100644 index 0000000000..4c683d270a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/delete-sessions.md @@ -0,0 +1,2 @@ +appwrite users deleteSessions \ + --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete-target.md b/docs/examples/1.6.x/console-cli/examples/users/delete-target.md new file mode 100644 index 0000000000..e9780911fd --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/delete-target.md @@ -0,0 +1,3 @@ +appwrite users deleteTarget \ + --userId <USER_ID> \ + --targetId <TARGET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete.md b/docs/examples/1.6.x/console-cli/examples/users/delete.md new file mode 100644 index 0000000000..293a5b040d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/delete.md @@ -0,0 +1,2 @@ +appwrite users delete \ + --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..cefcce607a --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,2 @@ +appwrite users getMfaRecoveryCodes \ + --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/get-prefs.md b/docs/examples/1.6.x/console-cli/examples/users/get-prefs.md new file mode 100644 index 0000000000..324aa4f508 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/get-prefs.md @@ -0,0 +1,2 @@ +appwrite users getPrefs \ + --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/get-target.md b/docs/examples/1.6.x/console-cli/examples/users/get-target.md new file mode 100644 index 0000000000..b80dbd9728 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/get-target.md @@ -0,0 +1,3 @@ +appwrite users getTarget \ + --userId <USER_ID> \ + --targetId <TARGET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/get-usage.md b/docs/examples/1.6.x/console-cli/examples/users/get-usage.md new file mode 100644 index 0000000000..ad7895d3aa --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/get-usage.md @@ -0,0 +1,2 @@ +appwrite users getUsage \ + diff --git a/docs/examples/1.6.x/console-cli/examples/users/get.md b/docs/examples/1.6.x/console-cli/examples/users/get.md new file mode 100644 index 0000000000..47002c5063 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/get.md @@ -0,0 +1,2 @@ +appwrite users get \ + --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-identities.md b/docs/examples/1.6.x/console-cli/examples/users/list-identities.md new file mode 100644 index 0000000000..c6cd6d5e28 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/list-identities.md @@ -0,0 +1,3 @@ +appwrite users listIdentities \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-logs.md b/docs/examples/1.6.x/console-cli/examples/users/list-logs.md new file mode 100644 index 0000000000..0b0bc1f50f --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/list-logs.md @@ -0,0 +1,3 @@ +appwrite users listLogs \ + --userId <USER_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-memberships.md b/docs/examples/1.6.x/console-cli/examples/users/list-memberships.md new file mode 100644 index 0000000000..7a9d10ee78 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/list-memberships.md @@ -0,0 +1,2 @@ +appwrite users listMemberships \ + --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/console-cli/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..e5d111b8ee --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/list-mfa-factors.md @@ -0,0 +1,2 @@ +appwrite users listMfaFactors \ + --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-sessions.md b/docs/examples/1.6.x/console-cli/examples/users/list-sessions.md new file mode 100644 index 0000000000..cb85d15ff6 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/list-sessions.md @@ -0,0 +1,2 @@ +appwrite users listSessions \ + --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-targets.md b/docs/examples/1.6.x/console-cli/examples/users/list-targets.md new file mode 100644 index 0000000000..9b5614bd32 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/list-targets.md @@ -0,0 +1,3 @@ +appwrite users listTargets \ + --userId <USER_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/users/list.md b/docs/examples/1.6.x/console-cli/examples/users/list.md new file mode 100644 index 0000000000..e5fdb9e5c5 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/list.md @@ -0,0 +1,3 @@ +appwrite users list \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-email-verification.md b/docs/examples/1.6.x/console-cli/examples/users/update-email-verification.md new file mode 100644 index 0000000000..990436f38b --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-email-verification.md @@ -0,0 +1,3 @@ +appwrite users updateEmailVerification \ + --userId <USER_ID> \ + --emailVerification false diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-email.md b/docs/examples/1.6.x/console-cli/examples/users/update-email.md new file mode 100644 index 0000000000..cce20e9ebf --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-email.md @@ -0,0 +1,3 @@ +appwrite users updateEmail \ + --userId <USER_ID> \ + --email email@example.com diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-labels.md b/docs/examples/1.6.x/console-cli/examples/users/update-labels.md new file mode 100644 index 0000000000..ca60c59683 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-labels.md @@ -0,0 +1,3 @@ +appwrite users updateLabels \ + --userId <USER_ID> \ + --labels one two three diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..63fb7f25eb --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,2 @@ +appwrite users updateMfaRecoveryCodes \ + --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-mfa.md b/docs/examples/1.6.x/console-cli/examples/users/update-mfa.md new file mode 100644 index 0000000000..3ccdbd8fdf --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-mfa.md @@ -0,0 +1,3 @@ +appwrite users updateMfa \ + --userId <USER_ID> \ + --mfa false diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-name.md b/docs/examples/1.6.x/console-cli/examples/users/update-name.md new file mode 100644 index 0000000000..9bf20eb117 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-name.md @@ -0,0 +1,3 @@ +appwrite users updateName \ + --userId <USER_ID> \ + --name <NAME> diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-password.md b/docs/examples/1.6.x/console-cli/examples/users/update-password.md new file mode 100644 index 0000000000..c05197b3c2 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-password.md @@ -0,0 +1,3 @@ +appwrite users updatePassword \ + --userId <USER_ID> \ + --password '' diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-phone-verification.md b/docs/examples/1.6.x/console-cli/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..b88a282d48 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-phone-verification.md @@ -0,0 +1,3 @@ +appwrite users updatePhoneVerification \ + --userId <USER_ID> \ + --phoneVerification false diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-phone.md b/docs/examples/1.6.x/console-cli/examples/users/update-phone.md new file mode 100644 index 0000000000..118c8e3557 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-phone.md @@ -0,0 +1,3 @@ +appwrite users updatePhone \ + --userId <USER_ID> \ + --number +12065550100 diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-prefs.md b/docs/examples/1.6.x/console-cli/examples/users/update-prefs.md new file mode 100644 index 0000000000..f3fa995e4d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-prefs.md @@ -0,0 +1,3 @@ +appwrite users updatePrefs \ + --userId <USER_ID> \ + --prefs '{ "key": "value" }' diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-status.md b/docs/examples/1.6.x/console-cli/examples/users/update-status.md new file mode 100644 index 0000000000..b587b70e9e --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-status.md @@ -0,0 +1,3 @@ +appwrite users updateStatus \ + --userId <USER_ID> \ + --status false diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-target.md b/docs/examples/1.6.x/console-cli/examples/users/update-target.md new file mode 100644 index 0000000000..d6541a0600 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/users/update-target.md @@ -0,0 +1,6 @@ +appwrite users updateTarget \ + --userId <USER_ID> \ + --targetId <TARGET_ID> \ + + + diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/create-repository-detection.md b/docs/examples/1.6.x/console-cli/examples/vcs/create-repository-detection.md new file mode 100644 index 0000000000..ffceaade73 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/vcs/create-repository-detection.md @@ -0,0 +1,4 @@ +appwrite vcs createRepositoryDetection \ + --installationId <INSTALLATION_ID> \ + --providerRepositoryId <PROVIDER_REPOSITORY_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/create-repository.md b/docs/examples/1.6.x/console-cli/examples/vcs/create-repository.md new file mode 100644 index 0000000000..a4934d5ef5 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/vcs/create-repository.md @@ -0,0 +1,4 @@ +appwrite vcs createRepository \ + --installationId <INSTALLATION_ID> \ + --name <NAME> \ + --private false diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/delete-installation.md b/docs/examples/1.6.x/console-cli/examples/vcs/delete-installation.md new file mode 100644 index 0000000000..f7d3a92001 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/vcs/delete-installation.md @@ -0,0 +1,2 @@ +appwrite vcs deleteInstallation \ + --installationId <INSTALLATION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/get-installation.md b/docs/examples/1.6.x/console-cli/examples/vcs/get-installation.md new file mode 100644 index 0000000000..df51853ea4 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/vcs/get-installation.md @@ -0,0 +1,2 @@ +appwrite vcs getInstallation \ + --installationId <INSTALLATION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/get-repository-contents.md b/docs/examples/1.6.x/console-cli/examples/vcs/get-repository-contents.md new file mode 100644 index 0000000000..7d378d7efa --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/vcs/get-repository-contents.md @@ -0,0 +1,4 @@ +appwrite vcs getRepositoryContents \ + --installationId <INSTALLATION_ID> \ + --providerRepositoryId <PROVIDER_REPOSITORY_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/get-repository.md b/docs/examples/1.6.x/console-cli/examples/vcs/get-repository.md new file mode 100644 index 0000000000..9f88e18eef --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/vcs/get-repository.md @@ -0,0 +1,3 @@ +appwrite vcs getRepository \ + --installationId <INSTALLATION_ID> \ + --providerRepositoryId <PROVIDER_REPOSITORY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/list-installations.md b/docs/examples/1.6.x/console-cli/examples/vcs/list-installations.md new file mode 100644 index 0000000000..a0af28dfbb --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/vcs/list-installations.md @@ -0,0 +1,3 @@ +appwrite vcs listInstallations \ + + diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/list-repositories.md b/docs/examples/1.6.x/console-cli/examples/vcs/list-repositories.md new file mode 100644 index 0000000000..389db553a3 --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/vcs/list-repositories.md @@ -0,0 +1,3 @@ +appwrite vcs listRepositories \ + --installationId <INSTALLATION_ID> \ + diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/list-repository-branches.md b/docs/examples/1.6.x/console-cli/examples/vcs/list-repository-branches.md new file mode 100644 index 0000000000..ea2fbd29fb --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/vcs/list-repository-branches.md @@ -0,0 +1,3 @@ +appwrite vcs listRepositoryBranches \ + --installationId <INSTALLATION_ID> \ + --providerRepositoryId <PROVIDER_REPOSITORY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/update-external-deployments.md b/docs/examples/1.6.x/console-cli/examples/vcs/update-external-deployments.md new file mode 100644 index 0000000000..417b59431d --- /dev/null +++ b/docs/examples/1.6.x/console-cli/examples/vcs/update-external-deployments.md @@ -0,0 +1,4 @@ +appwrite vcs updateExternalDeployments \ + --installationId <INSTALLATION_ID> \ + --repositoryId <REPOSITORY_ID> \ + --providerPullRequestId <PROVIDER_PULL_REQUEST_ID> diff --git a/docs/examples/1.6.x/console-web/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/console-web/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..ec4fe102a8 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-anonymous-session.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createAnonymousSession(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-email-password-session.md b/docs/examples/1.6.x/console-web/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..a3643840da --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-email-password-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createEmailPasswordSession( + 'email@example.com', // email + 'password' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-email-token.md b/docs/examples/1.6.x/console-web/examples/account/create-email-token.md new file mode 100644 index 0000000000..4dc8080001 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-email-token.md @@ -0,0 +1,15 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createEmailToken( + '<USER_ID>', // userId + 'email@example.com', // email + false // phrase (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-j-w-t.md b/docs/examples/1.6.x/console-web/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..2e1751b34a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-j-w-t.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createJWT(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/console-web/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..e40acd1803 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,16 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMagicURLToken( + '<USER_ID>', // userId + 'email@example.com', // email + 'https://example.com', // url (optional) + false // phrase (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/console-web/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..02f9c6be11 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-mfa-authenticator.md @@ -0,0 +1,13 @@ +import { Client, Account, AuthenticatorType } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMfaAuthenticator( + AuthenticatorType.Totp // type +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/console-web/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..b97c6493c9 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-mfa-challenge.md @@ -0,0 +1,13 @@ +import { Client, Account, AuthenticationFactor } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMfaChallenge( + AuthenticationFactor.Email // factor +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..e220852350 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createMfaRecoveryCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/console-web/examples/account/create-o-auth2session.md new file mode 100644 index 0000000000..593bb5c798 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-o-auth2session.md @@ -0,0 +1,15 @@ +import { Client, Account, OAuthProvider } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +account.createOAuth2Session( + OAuthProvider.Amazon, // provider + 'https://example.com', // success (optional) + 'https://example.com', // failure (optional) + [] // scopes (optional) +); + diff --git a/docs/examples/1.6.x/console-web/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/console-web/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..033c53eb4d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-o-auth2token.md @@ -0,0 +1,15 @@ +import { Client, Account, OAuthProvider } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +account.createOAuth2Token( + OAuthProvider.Amazon, // provider + 'https://example.com', // success (optional) + 'https://example.com', // failure (optional) + [] // scopes (optional) +); + diff --git a/docs/examples/1.6.x/console-web/examples/account/create-phone-token.md b/docs/examples/1.6.x/console-web/examples/account/create-phone-token.md new file mode 100644 index 0000000000..2c28644b94 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-phone-token.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createPhoneToken( + '<USER_ID>', // userId + '+12065550100' // phone +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-phone-verification.md b/docs/examples/1.6.x/console-web/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..d76b2b787a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-phone-verification.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createPhoneVerification(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-push-target.md b/docs/examples/1.6.x/console-web/examples/account/create-push-target.md new file mode 100644 index 0000000000..0cae64799f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-push-target.md @@ -0,0 +1,15 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createPushTarget( + '<TARGET_ID>', // targetId + '<IDENTIFIER>', // identifier + '<PROVIDER_ID>' // providerId (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-recovery.md b/docs/examples/1.6.x/console-web/examples/account/create-recovery.md new file mode 100644 index 0000000000..c411e8039f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-recovery.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createRecovery( + 'email@example.com', // email + 'https://example.com' // url +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-session.md b/docs/examples/1.6.x/console-web/examples/account/create-session.md new file mode 100644 index 0000000000..29b1e19935 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-verification.md b/docs/examples/1.6.x/console-web/examples/account/create-verification.md new file mode 100644 index 0000000000..3071bd1474 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create-verification.md @@ -0,0 +1,13 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.createVerification( + 'https://example.com' // url +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create.md b/docs/examples/1.6.x/console-web/examples/account/create.md new file mode 100644 index 0000000000..f359211fc7 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/create.md @@ -0,0 +1,16 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.create( + '<USER_ID>', // userId + 'email@example.com', // email + '', // password + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete-identity.md b/docs/examples/1.6.x/console-web/examples/account/delete-identity.md new file mode 100644 index 0000000000..223144cbbf --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/delete-identity.md @@ -0,0 +1,13 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteIdentity( + '<IDENTITY_ID>' // identityId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/console-web/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..48949664fc --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,13 @@ +import { Client, Account, AuthenticatorType } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteMfaAuthenticator( + AuthenticatorType.Totp // type +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete-push-target.md b/docs/examples/1.6.x/console-web/examples/account/delete-push-target.md new file mode 100644 index 0000000000..aa44cafb77 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/delete-push-target.md @@ -0,0 +1,13 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deletePushTarget( + '<TARGET_ID>' // targetId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete-session.md b/docs/examples/1.6.x/console-web/examples/account/delete-session.md new file mode 100644 index 0000000000..16cd2e7bf0 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/delete-session.md @@ -0,0 +1,13 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteSession( + '<SESSION_ID>' // sessionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete-sessions.md b/docs/examples/1.6.x/console-web/examples/account/delete-sessions.md new file mode 100644 index 0000000000..9f64d87de9 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/delete-sessions.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.deleteSessions(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete.md b/docs/examples/1.6.x/console-web/examples/account/delete.md new file mode 100644 index 0000000000..f76e8e514e --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/delete.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.delete(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..455aaf4739 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.getMfaRecoveryCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/get-prefs.md b/docs/examples/1.6.x/console-web/examples/account/get-prefs.md new file mode 100644 index 0000000000..54f3d3b3ad --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/get-prefs.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.getPrefs(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/get-session.md b/docs/examples/1.6.x/console-web/examples/account/get-session.md new file mode 100644 index 0000000000..661b798da7 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/get-session.md @@ -0,0 +1,13 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.getSession( + '<SESSION_ID>' // sessionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/get.md b/docs/examples/1.6.x/console-web/examples/account/get.md new file mode 100644 index 0000000000..c5d69c2f0c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/get.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.get(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/list-identities.md b/docs/examples/1.6.x/console-web/examples/account/list-identities.md new file mode 100644 index 0000000000..c94685e0a2 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/list-identities.md @@ -0,0 +1,13 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listIdentities( + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/list-logs.md b/docs/examples/1.6.x/console-web/examples/account/list-logs.md new file mode 100644 index 0000000000..1a4bfe7d53 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/list-logs.md @@ -0,0 +1,13 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listLogs( + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/console-web/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..871d2ab4a3 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/list-mfa-factors.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listMfaFactors(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/list-sessions.md b/docs/examples/1.6.x/console-web/examples/account/list-sessions.md new file mode 100644 index 0000000000..7ec5539bc1 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/list-sessions.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.listSessions(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-email.md b/docs/examples/1.6.x/console-web/examples/account/update-email.md new file mode 100644 index 0000000000..c47022cb9a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-email.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateEmail( + 'email@example.com', // email + 'password' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-m-f-a.md b/docs/examples/1.6.x/console-web/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..001e6f7da9 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-m-f-a.md @@ -0,0 +1,13 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMFA( + false // mfa +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/console-web/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..7f4b824aaf --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMagicURLSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/console-web/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..4b584fa0e5 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-mfa-authenticator.md @@ -0,0 +1,14 @@ +import { Client, Account, AuthenticatorType } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMfaAuthenticator( + AuthenticatorType.Totp, // type + '<OTP>' // otp +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/console-web/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..217f167590 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-mfa-challenge.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMfaChallenge( + '<CHALLENGE_ID>', // challengeId + '<OTP>' // otp +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..597ddc35dd --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateMfaRecoveryCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-name.md b/docs/examples/1.6.x/console-web/examples/account/update-name.md new file mode 100644 index 0000000000..59917e64db --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-name.md @@ -0,0 +1,13 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateName( + '<NAME>' // name +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-password.md b/docs/examples/1.6.x/console-web/examples/account/update-password.md new file mode 100644 index 0000000000..a2332e734b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-password.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePassword( + '', // password + 'password' // oldPassword (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-phone-session.md b/docs/examples/1.6.x/console-web/examples/account/update-phone-session.md new file mode 100644 index 0000000000..85bf50e664 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-phone-session.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePhoneSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-phone-verification.md b/docs/examples/1.6.x/console-web/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..b72260fb6d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-phone-verification.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePhoneVerification( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-phone.md b/docs/examples/1.6.x/console-web/examples/account/update-phone.md new file mode 100644 index 0000000000..3e2421b651 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-phone.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePhone( + '+12065550100', // phone + 'password' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-prefs.md b/docs/examples/1.6.x/console-web/examples/account/update-prefs.md new file mode 100644 index 0000000000..054aa7e526 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-prefs.md @@ -0,0 +1,13 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePrefs( + {} // prefs +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-push-target.md b/docs/examples/1.6.x/console-web/examples/account/update-push-target.md new file mode 100644 index 0000000000..5178052504 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-push-target.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updatePushTarget( + '<TARGET_ID>', // targetId + '<IDENTIFIER>' // identifier +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-recovery.md b/docs/examples/1.6.x/console-web/examples/account/update-recovery.md new file mode 100644 index 0000000000..d2ed14ef0e --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-recovery.md @@ -0,0 +1,15 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateRecovery( + '<USER_ID>', // userId + '<SECRET>', // secret + '' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-session.md b/docs/examples/1.6.x/console-web/examples/account/update-session.md new file mode 100644 index 0000000000..20ceeb7c6f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-session.md @@ -0,0 +1,13 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateSession( + '<SESSION_ID>' // sessionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-status.md b/docs/examples/1.6.x/console-web/examples/account/update-status.md new file mode 100644 index 0000000000..3e1a532917 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-status.md @@ -0,0 +1,11 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateStatus(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-verification.md b/docs/examples/1.6.x/console-web/examples/account/update-verification.md new file mode 100644 index 0000000000..d3b0426ab1 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/account/update-verification.md @@ -0,0 +1,14 @@ +import { Client, Account } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const result = await account.updateVerification( + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/assistant/chat.md b/docs/examples/1.6.x/console-web/examples/assistant/chat.md new file mode 100644 index 0000000000..8c47108f84 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/assistant/chat.md @@ -0,0 +1,13 @@ +import { Client, Assistant } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const assistant = new Assistant(client); + +const result = await assistant.chat( + '<PROMPT>' // prompt +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-browser.md b/docs/examples/1.6.x/console-web/examples/avatars/get-browser.md new file mode 100644 index 0000000000..89bc3ae788 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/avatars/get-browser.md @@ -0,0 +1,16 @@ +import { Client, Avatars, Browser } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getBrowser( + Browser.AvantBrowser, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/console-web/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..874bac827f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/avatars/get-credit-card.md @@ -0,0 +1,16 @@ +import { Client, Avatars, CreditCard } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getCreditCard( + CreditCard.AmericanExpress, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-favicon.md b/docs/examples/1.6.x/console-web/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..0cb328d7a7 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/avatars/get-favicon.md @@ -0,0 +1,13 @@ +import { Client, Avatars } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getFavicon( + 'https://example.com' // url +); + +console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-flag.md b/docs/examples/1.6.x/console-web/examples/avatars/get-flag.md new file mode 100644 index 0000000000..e17885ea92 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/avatars/get-flag.md @@ -0,0 +1,16 @@ +import { Client, Avatars, Flag } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getFlag( + Flag.Afghanistan, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-image.md b/docs/examples/1.6.x/console-web/examples/avatars/get-image.md new file mode 100644 index 0000000000..d61b93ee09 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/avatars/get-image.md @@ -0,0 +1,15 @@ +import { Client, Avatars } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getImage( + 'https://example.com', // url + 0, // width (optional) + 0 // height (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-initials.md b/docs/examples/1.6.x/console-web/examples/avatars/get-initials.md new file mode 100644 index 0000000000..eda96c4d66 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/avatars/get-initials.md @@ -0,0 +1,16 @@ +import { Client, Avatars } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getInitials( + '<NAME>', // name (optional) + 0, // width (optional) + 0, // height (optional) + '' // background (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-q-r.md b/docs/examples/1.6.x/console-web/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..200d85210a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/avatars/get-q-r.md @@ -0,0 +1,16 @@ +import { Client, Avatars } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const avatars = new Avatars(client); + +const result = avatars.getQR( + '<TEXT>', // text + 1, // size (optional) + 0, // margin (optional) + false // download (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/console/variables.md b/docs/examples/1.6.x/console-web/examples/console/variables.md new file mode 100644 index 0000000000..8d4e298084 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/console/variables.md @@ -0,0 +1,11 @@ +import { Client, Console } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const console = new Console(client); + +const result = await console.variables(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..b070039fac --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-boolean-attribute.md @@ -0,0 +1,18 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createBooleanAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + false, // default (optional) + false // array (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-collection.md b/docs/examples/1.6.x/console-web/examples/databases/create-collection.md new file mode 100644 index 0000000000..8f5ab24d4d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-collection.md @@ -0,0 +1,18 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // documentSecurity (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..9dc4d41276 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-datetime-attribute.md @@ -0,0 +1,18 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createDatetimeAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '', // default (optional) + false // array (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-document.md b/docs/examples/1.6.x/console-web/examples/databases/create-document.md new file mode 100644 index 0000000000..11f3bfd58b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-document.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + {}, // data + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..bd93e73269 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-email-attribute.md @@ -0,0 +1,18 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createEmailAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'email@example.com', // default (optional) + false // array (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..82aeb68b0b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-enum-attribute.md @@ -0,0 +1,19 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createEnumAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + [], // elements + false, // required + '<DEFAULT>', // default (optional) + false // array (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..575583778d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-float-attribute.md @@ -0,0 +1,20 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createFloatAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min (optional) + null, // max (optional) + null, // default (optional) + false // array (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-index.md b/docs/examples/1.6.x/console-web/examples/databases/create-index.md new file mode 100644 index 0000000000..f5c94d538f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-index.md @@ -0,0 +1,18 @@ +import { Client, Databases, IndexType } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createIndex( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + IndexType.Key, // type + [], // attributes + [] // orders (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..637e194b3b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-integer-attribute.md @@ -0,0 +1,20 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createIntegerAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min (optional) + null, // max (optional) + null, // default (optional) + false // array (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..1617d8eb12 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-ip-attribute.md @@ -0,0 +1,18 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createIpAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '', // default (optional) + false // array (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..925fb65db7 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-relationship-attribute.md @@ -0,0 +1,20 @@ +import { Client, Databases, RelationshipType, RelationMutate } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createRelationshipAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<RELATED_COLLECTION_ID>', // relatedCollectionId + RelationshipType.OneToOne, // type + false, // twoWay (optional) + '', // key (optional) + '', // twoWayKey (optional) + RelationMutate.Cascade // onDelete (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..614ac8f865 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-string-attribute.md @@ -0,0 +1,20 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createStringAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + 1, // size + false, // required + '<DEFAULT>', // default (optional) + false, // array (optional) + false // encrypt (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..db36663b70 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create-url-attribute.md @@ -0,0 +1,18 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.createUrlAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'https://example.com', // default (optional) + false // array (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create.md b/docs/examples/1.6.x/console-web/examples/databases/create.md new file mode 100644 index 0000000000..08734185eb --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/create.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.create( + '<DATABASE_ID>', // databaseId + '<NAME>', // name + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/delete-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..76b157e1fb --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/delete-attribute.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.deleteAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/delete-collection.md b/docs/examples/1.6.x/console-web/examples/databases/delete-collection.md new file mode 100644 index 0000000000..b92d6a1a96 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/delete-collection.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.deleteCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>' // collectionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/delete-document.md b/docs/examples/1.6.x/console-web/examples/databases/delete-document.md new file mode 100644 index 0000000000..7a7789cfb4 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/delete-document.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.deleteDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>' // documentId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/delete-index.md b/docs/examples/1.6.x/console-web/examples/databases/delete-index.md new file mode 100644 index 0000000000..de9d1b38ca --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/delete-index.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.deleteIndex( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/delete.md b/docs/examples/1.6.x/console-web/examples/databases/delete.md new file mode 100644 index 0000000000..237cbd9a0e --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/delete.md @@ -0,0 +1,13 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.delete( + '<DATABASE_ID>' // databaseId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/get-attribute.md new file mode 100644 index 0000000000..73c91d680a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/get-attribute.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.getAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-collection-usage.md b/docs/examples/1.6.x/console-web/examples/databases/get-collection-usage.md new file mode 100644 index 0000000000..ce409da890 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/get-collection-usage.md @@ -0,0 +1,15 @@ +import { Client, Databases, DatabaseUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.getCollectionUsage( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + DatabaseUsageRange.TwentyFourHours // range (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-collection.md b/docs/examples/1.6.x/console-web/examples/databases/get-collection.md new file mode 100644 index 0000000000..e89863b6af --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/get-collection.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.getCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>' // collectionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-database-usage.md b/docs/examples/1.6.x/console-web/examples/databases/get-database-usage.md new file mode 100644 index 0000000000..14a4bd4af2 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/get-database-usage.md @@ -0,0 +1,14 @@ +import { Client, Databases, DatabaseUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.getDatabaseUsage( + '<DATABASE_ID>', // databaseId + DatabaseUsageRange.TwentyFourHours // range (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-document.md b/docs/examples/1.6.x/console-web/examples/databases/get-document.md new file mode 100644 index 0000000000..83f832ad58 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/get-document.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.getDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-index.md b/docs/examples/1.6.x/console-web/examples/databases/get-index.md new file mode 100644 index 0000000000..5fe73a5d88 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/get-index.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.getIndex( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-usage.md b/docs/examples/1.6.x/console-web/examples/databases/get-usage.md new file mode 100644 index 0000000000..40382b3c66 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/get-usage.md @@ -0,0 +1,13 @@ +import { Client, Databases, DatabaseUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.getUsage( + DatabaseUsageRange.TwentyFourHours // range (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get.md b/docs/examples/1.6.x/console-web/examples/databases/get.md new file mode 100644 index 0000000000..cd04ed9afb --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/get.md @@ -0,0 +1,13 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.get( + '<DATABASE_ID>' // databaseId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-attributes.md b/docs/examples/1.6.x/console-web/examples/databases/list-attributes.md new file mode 100644 index 0000000000..eecb6a2268 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/list-attributes.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.listAttributes( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-collection-logs.md b/docs/examples/1.6.x/console-web/examples/databases/list-collection-logs.md new file mode 100644 index 0000000000..850c4437b6 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/list-collection-logs.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.listCollectionLogs( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-collections.md b/docs/examples/1.6.x/console-web/examples/databases/list-collections.md new file mode 100644 index 0000000000..891c7c76c7 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/list-collections.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.listCollections( + '<DATABASE_ID>', // databaseId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-document-logs.md b/docs/examples/1.6.x/console-web/examples/databases/list-document-logs.md new file mode 100644 index 0000000000..0fa86b4305 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/list-document-logs.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.listDocumentLogs( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-documents.md b/docs/examples/1.6.x/console-web/examples/databases/list-documents.md new file mode 100644 index 0000000000..1918bad395 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/list-documents.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.listDocuments( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-indexes.md b/docs/examples/1.6.x/console-web/examples/databases/list-indexes.md new file mode 100644 index 0000000000..6e308a8ae5 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/list-indexes.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.listIndexes( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-logs.md b/docs/examples/1.6.x/console-web/examples/databases/list-logs.md new file mode 100644 index 0000000000..a28ba46955 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/list-logs.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.listLogs( + '<DATABASE_ID>', // databaseId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list.md b/docs/examples/1.6.x/console-web/examples/databases/list.md new file mode 100644 index 0000000000..75a5c467c7 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/list.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..2abf121732 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-boolean-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateBooleanAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + false // default +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-collection.md b/docs/examples/1.6.x/console-web/examples/databases/update-collection.md new file mode 100644 index 0000000000..3bce3a5720 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-collection.md @@ -0,0 +1,18 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // documentSecurity (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..3152f6b39b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-datetime-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateDatetimeAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '' // default +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-document.md b/docs/examples/1.6.x/console-web/examples/databases/update-document.md new file mode 100644 index 0000000000..bfc7df6c69 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-document.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + {}, // data (optional) + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..eaa6338860 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-email-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateEmailAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'email@example.com' // default +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..b579869058 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-enum-attribute.md @@ -0,0 +1,18 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateEnumAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + [], // elements + false, // required + '<DEFAULT>' // default +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..16cca26fbb --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-float-attribute.md @@ -0,0 +1,19 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateFloatAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min + null, // max + null // default +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..97bf6a9eba --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-integer-attribute.md @@ -0,0 +1,19 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateIntegerAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min + null, // max + null // default +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..0f3c5111bb --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-ip-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateIpAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '' // default +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..205aeba36c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-relationship-attribute.md @@ -0,0 +1,16 @@ +import { Client, Databases, RelationMutate } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateRelationshipAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + RelationMutate.Cascade // onDelete (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..763b6d5e3b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-string-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateStringAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '<DEFAULT>' // default +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..ca89f962e8 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update-url-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.updateUrlAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'https://example.com' // default +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update.md b/docs/examples/1.6.x/console-web/examples/databases/update.md new file mode 100644 index 0000000000..fa87d14542 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/databases/update.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const databases = new Databases(client); + +const result = await databases.update( + '<DATABASE_ID>', // databaseId + '<NAME>', // name + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/create-build.md b/docs/examples/1.6.x/console-web/examples/functions/create-build.md new file mode 100644 index 0000000000..ab0c455a3f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/create-build.md @@ -0,0 +1,15 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.createBuild( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>', // deploymentId + '<BUILD_ID>' // buildId (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/create-deployment.md b/docs/examples/1.6.x/console-web/examples/functions/create-deployment.md new file mode 100644 index 0000000000..2617615827 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/create-deployment.md @@ -0,0 +1,17 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.createDeployment( + '<FUNCTION_ID>', // functionId + document.getElementById('uploader').files[0], // code + false, // activate + '<ENTRYPOINT>', // entrypoint (optional) + '<COMMANDS>' // commands (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/create-execution.md b/docs/examples/1.6.x/console-web/examples/functions/create-execution.md new file mode 100644 index 0000000000..8d62c5083e --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/create-execution.md @@ -0,0 +1,19 @@ +import { Client, Functions, ExecutionMethod } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.createExecution( + '<FUNCTION_ID>', // functionId + '<BODY>', // body (optional) + false, // async (optional) + '<PATH>', // path (optional) + ExecutionMethod.GET, // method (optional) + {}, // headers (optional) + '' // scheduledAt (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/create-variable.md b/docs/examples/1.6.x/console-web/examples/functions/create-variable.md new file mode 100644 index 0000000000..16a047462c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/create-variable.md @@ -0,0 +1,15 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.createVariable( + '<FUNCTION_ID>', // functionId + '<KEY>', // key + '<VALUE>' // value +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/create.md b/docs/examples/1.6.x/console-web/examples/functions/create.md new file mode 100644 index 0000000000..36815d5646 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/create.md @@ -0,0 +1,33 @@ +import { Client, Functions, } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.create( + '<FUNCTION_ID>', // functionId + '<NAME>', // name + .Node145, // runtime + ["any"], // execute (optional) + [], // events (optional) + '', // schedule (optional) + 1, // timeout (optional) + false, // enabled (optional) + false, // logging (optional) + '<ENTRYPOINT>', // entrypoint (optional) + '<COMMANDS>', // commands (optional) + [], // scopes (optional) + '<INSTALLATION_ID>', // installationId (optional) + '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) + '<PROVIDER_BRANCH>', // providerBranch (optional) + false, // providerSilentMode (optional) + '<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional) + '<TEMPLATE_REPOSITORY>', // templateRepository (optional) + '<TEMPLATE_OWNER>', // templateOwner (optional) + '<TEMPLATE_ROOT_DIRECTORY>', // templateRootDirectory (optional) + '<TEMPLATE_BRANCH>' // templateBranch (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/delete-deployment.md b/docs/examples/1.6.x/console-web/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..8dd7a186e2 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/delete-deployment.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.deleteDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/delete-execution.md b/docs/examples/1.6.x/console-web/examples/functions/delete-execution.md new file mode 100644 index 0000000000..6ffd50ce0c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/delete-execution.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.deleteExecution( + '<FUNCTION_ID>', // functionId + '<EXECUTION_ID>' // executionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/delete-variable.md b/docs/examples/1.6.x/console-web/examples/functions/delete-variable.md new file mode 100644 index 0000000000..71f1d322ab --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/delete-variable.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.deleteVariable( + '<FUNCTION_ID>', // functionId + '<VARIABLE_ID>' // variableId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/delete.md b/docs/examples/1.6.x/console-web/examples/functions/delete.md new file mode 100644 index 0000000000..9a27e2df98 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/delete.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.delete( + '<FUNCTION_ID>' // functionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/download-deployment.md b/docs/examples/1.6.x/console-web/examples/functions/download-deployment.md new file mode 100644 index 0000000000..cfcd00bade --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/download-deployment.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = functions.downloadDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); + +console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get-deployment.md b/docs/examples/1.6.x/console-web/examples/functions/get-deployment.md new file mode 100644 index 0000000000..468eb70304 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/get-deployment.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.getDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get-execution.md b/docs/examples/1.6.x/console-web/examples/functions/get-execution.md new file mode 100644 index 0000000000..a476780a55 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/get-execution.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.getExecution( + '<FUNCTION_ID>', // functionId + '<EXECUTION_ID>' // executionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get-function-usage.md b/docs/examples/1.6.x/console-web/examples/functions/get-function-usage.md new file mode 100644 index 0000000000..4a151c15b7 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/get-function-usage.md @@ -0,0 +1,14 @@ +import { Client, Functions, FunctionUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.getFunctionUsage( + '<FUNCTION_ID>', // functionId + FunctionUsageRange.TwentyFourHours // range (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get-usage.md b/docs/examples/1.6.x/console-web/examples/functions/get-usage.md new file mode 100644 index 0000000000..a98d074256 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/get-usage.md @@ -0,0 +1,13 @@ +import { Client, Functions, FunctionUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.getUsage( + FunctionUsageRange.TwentyFourHours // range (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get-variable.md b/docs/examples/1.6.x/console-web/examples/functions/get-variable.md new file mode 100644 index 0000000000..e6a5a88a59 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/get-variable.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.getVariable( + '<FUNCTION_ID>', // functionId + '<VARIABLE_ID>' // variableId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get.md b/docs/examples/1.6.x/console-web/examples/functions/get.md new file mode 100644 index 0000000000..12cd21f41b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/get.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.get( + '<FUNCTION_ID>' // functionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/list-deployments.md b/docs/examples/1.6.x/console-web/examples/functions/list-deployments.md new file mode 100644 index 0000000000..6fb7d98ff1 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/list-deployments.md @@ -0,0 +1,15 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.listDeployments( + '<FUNCTION_ID>', // functionId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/list-executions.md b/docs/examples/1.6.x/console-web/examples/functions/list-executions.md new file mode 100644 index 0000000000..e2858fdd47 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/list-executions.md @@ -0,0 +1,15 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.listExecutions( + '<FUNCTION_ID>', // functionId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/list-runtimes.md b/docs/examples/1.6.x/console-web/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..7fa0e83b6a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/list-runtimes.md @@ -0,0 +1,11 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.listRuntimes(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/list-variables.md b/docs/examples/1.6.x/console-web/examples/functions/list-variables.md new file mode 100644 index 0000000000..7163e26841 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/list-variables.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.listVariables( + '<FUNCTION_ID>' // functionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/list.md b/docs/examples/1.6.x/console-web/examples/functions/list.md new file mode 100644 index 0000000000..aeeb7c6dc5 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/list.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/console-web/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..e69a9e7f59 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/update-deployment-build.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.updateDeploymentBuild( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/update-deployment.md b/docs/examples/1.6.x/console-web/examples/functions/update-deployment.md new file mode 100644 index 0000000000..c17f7a7067 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/update-deployment.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.updateDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/update-variable.md b/docs/examples/1.6.x/console-web/examples/functions/update-variable.md new file mode 100644 index 0000000000..cc5943237b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/update-variable.md @@ -0,0 +1,16 @@ +import { Client, Functions } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.updateVariable( + '<FUNCTION_ID>', // functionId + '<VARIABLE_ID>', // variableId + '<KEY>', // key + '<VALUE>' // value (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/update.md b/docs/examples/1.6.x/console-web/examples/functions/update.md new file mode 100644 index 0000000000..39f37d03b8 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/functions/update.md @@ -0,0 +1,29 @@ +import { Client, Functions, } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const functions = new Functions(client); + +const result = await functions.update( + '<FUNCTION_ID>', // functionId + '<NAME>', // name + .Node145, // runtime (optional) + ["any"], // execute (optional) + [], // events (optional) + '', // schedule (optional) + 1, // timeout (optional) + false, // enabled (optional) + false, // logging (optional) + '<ENTRYPOINT>', // entrypoint (optional) + '<COMMANDS>', // commands (optional) + [], // scopes (optional) + '<INSTALLATION_ID>', // installationId (optional) + '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) + '<PROVIDER_BRANCH>', // providerBranch (optional) + false, // providerSilentMode (optional) + '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/graphql/mutation.md b/docs/examples/1.6.x/console-web/examples/graphql/mutation.md new file mode 100644 index 0000000000..5a6cb2ced4 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/graphql/mutation.md @@ -0,0 +1,13 @@ +import { Client, Graphql } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const graphql = new Graphql(client); + +const result = await graphql.mutation( + {} // query +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/graphql/query.md b/docs/examples/1.6.x/console-web/examples/graphql/query.md new file mode 100644 index 0000000000..c92c636395 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/graphql/query.md @@ -0,0 +1,13 @@ +import { Client, Graphql } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const graphql = new Graphql(client); + +const result = await graphql.query( + {} // query +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-antivirus.md b/docs/examples/1.6.x/console-web/examples/health/get-antivirus.md new file mode 100644 index 0000000000..6daffff793 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-antivirus.md @@ -0,0 +1,11 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getAntivirus(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-cache.md b/docs/examples/1.6.x/console-web/examples/health/get-cache.md new file mode 100644 index 0000000000..acbf728519 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-cache.md @@ -0,0 +1,11 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getCache(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-certificate.md b/docs/examples/1.6.x/console-web/examples/health/get-certificate.md new file mode 100644 index 0000000000..264e18ed66 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-certificate.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getCertificate( + '' // domain (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-d-b.md b/docs/examples/1.6.x/console-web/examples/health/get-d-b.md new file mode 100644 index 0000000000..12d22d0dfb --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-d-b.md @@ -0,0 +1,11 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getDB(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/console-web/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..4dac04a856 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-failed-jobs.md @@ -0,0 +1,14 @@ +import { Client, Health, } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getFailedJobs( + .V1Database, // name + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-pub-sub.md b/docs/examples/1.6.x/console-web/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..b2e654d927 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-pub-sub.md @@ -0,0 +1,11 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getPubSub(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-builds.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..5c41eb7a90 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-builds.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueBuilds( + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..744d0c7140 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-certificates.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueCertificates( + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-databases.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..d7d5457d56 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-databases.md @@ -0,0 +1,14 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueDatabases( + '<NAME>', // name (optional) + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..bcb1c95a53 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-deletes.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueDeletes( + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-functions.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..92ca143588 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-functions.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueFunctions( + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-logs.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..e2bfb3663d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-logs.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueLogs( + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-mails.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..78be0c7cd2 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-mails.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueMails( + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..6a5de6a0dc --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-messaging.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueMessaging( + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..dc18fdfa89 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-migrations.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueMigrations( + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..10eed8e263 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-usage-dump.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueUsageDump( + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-usage.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..155a1b2336 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-usage.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueUsage( + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..b238febe45 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue-webhooks.md @@ -0,0 +1,13 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueueWebhooks( + null // threshold (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue.md b/docs/examples/1.6.x/console-web/examples/health/get-queue.md new file mode 100644 index 0000000000..f035b83551 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-queue.md @@ -0,0 +1,11 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getQueue(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-storage-local.md b/docs/examples/1.6.x/console-web/examples/health/get-storage-local.md new file mode 100644 index 0000000000..b61b9fb9cf --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-storage-local.md @@ -0,0 +1,11 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getStorageLocal(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-storage.md b/docs/examples/1.6.x/console-web/examples/health/get-storage.md new file mode 100644 index 0000000000..354cb4b505 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-storage.md @@ -0,0 +1,11 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getStorage(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-time.md b/docs/examples/1.6.x/console-web/examples/health/get-time.md new file mode 100644 index 0000000000..f4438e8c81 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get-time.md @@ -0,0 +1,11 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.getTime(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get.md b/docs/examples/1.6.x/console-web/examples/health/get.md new file mode 100644 index 0000000000..5ff80769a6 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/health/get.md @@ -0,0 +1,11 @@ +import { Client, Health } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const health = new Health(client); + +const result = await health.get(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/get.md b/docs/examples/1.6.x/console-web/examples/locale/get.md new file mode 100644 index 0000000000..a93eecec94 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/locale/get.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.get(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-codes.md b/docs/examples/1.6.x/console-web/examples/locale/list-codes.md new file mode 100644 index 0000000000..d2639f6cfb --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/locale/list-codes.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCodes(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-continents.md b/docs/examples/1.6.x/console-web/examples/locale/list-continents.md new file mode 100644 index 0000000000..ec9327f2f6 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/locale/list-continents.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listContinents(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/console-web/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..52e14d37af --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/locale/list-countries-e-u.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCountriesEU(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/console-web/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..7cd739d4a6 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/locale/list-countries-phones.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCountriesPhones(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-countries.md b/docs/examples/1.6.x/console-web/examples/locale/list-countries.md new file mode 100644 index 0000000000..73e609391b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/locale/list-countries.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCountries(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-currencies.md b/docs/examples/1.6.x/console-web/examples/locale/list-currencies.md new file mode 100644 index 0000000000..554513ce46 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/locale/list-currencies.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listCurrencies(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-languages.md b/docs/examples/1.6.x/console-web/examples/locale/list-languages.md new file mode 100644 index 0000000000..f3f03cf14c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/locale/list-languages.md @@ -0,0 +1,11 @@ +import { Client, Locale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const locale = new Locale(client); + +const result = await locale.listLanguages(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..60691b2075 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-apns-provider.md @@ -0,0 +1,20 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createApnsProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<AUTH_KEY>', // authKey (optional) + '<AUTH_KEY_ID>', // authKeyId (optional) + '<TEAM_ID>', // teamId (optional) + '<BUNDLE_ID>', // bundleId (optional) + false, // sandbox (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-email.md b/docs/examples/1.6.x/console-web/examples/messaging/create-email.md new file mode 100644 index 0000000000..057339b57b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-email.md @@ -0,0 +1,24 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createEmail( + '<MESSAGE_ID>', // messageId + '<SUBJECT>', // subject + '<CONTENT>', // content + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + [], // cc (optional) + [], // bcc (optional) + [], // attachments (optional) + false, // draft (optional) + false, // html (optional) + '' // scheduledAt (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..967e99c3dd --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-fcm-provider.md @@ -0,0 +1,16 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createFcmProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + {}, // serviceAccountJSON (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..f1cf6e28ab --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,22 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createMailgunProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<API_KEY>', // apiKey (optional) + '<DOMAIN>', // domain (optional) + false, // isEuRegion (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + 'email@example.com', // replyToEmail (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..2b9b4b43f4 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-msg91provider.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createMsg91Provider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<TEMPLATE_ID>', // templateId (optional) + '<SENDER_ID>', // senderId (optional) + '<AUTH_KEY>', // authKey (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-push.md b/docs/examples/1.6.x/console-web/examples/messaging/create-push.md new file mode 100644 index 0000000000..aa4a83cda5 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-push.md @@ -0,0 +1,28 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createPush( + '<MESSAGE_ID>', // messageId + '<TITLE>', // title + '<BODY>', // body + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + {}, // data (optional) + '<ACTION>', // action (optional) + '[ID1:ID2]', // image (optional) + '<ICON>', // icon (optional) + '<SOUND>', // sound (optional) + '<COLOR>', // color (optional) + '<TAG>', // tag (optional) + '<BADGE>', // badge (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..465ff14ec6 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,20 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createSendgridProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<API_KEY>', // apiKey (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + 'email@example.com', // replyToEmail (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-sms.md b/docs/examples/1.6.x/console-web/examples/messaging/create-sms.md new file mode 100644 index 0000000000..fe474c87b8 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-sms.md @@ -0,0 +1,19 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createSms( + '<MESSAGE_ID>', // messageId + '<CONTENT>', // content + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..0c3c74a168 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-smtp-provider.md @@ -0,0 +1,26 @@ +import { Client, Messaging, SmtpEncryption } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createSmtpProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<HOST>', // host + 1, // port (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) + SmtpEncryption.None, // encryption (optional) + false, // autoTLS (optional) + '<MAILER>', // mailer (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + 'email@example.com', // replyToEmail (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/console-web/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..9d14c970f2 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-subscriber.md @@ -0,0 +1,15 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>', // subscriberId + '<TARGET_ID>' // targetId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..b48b846b7c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-telesign-provider.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createTelesignProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<CUSTOMER_ID>', // customerId (optional) + '<API_KEY>', // apiKey (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..53b458dc23 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createTextmagicProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<USERNAME>', // username (optional) + '<API_KEY>', // apiKey (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-topic.md b/docs/examples/1.6.x/console-web/examples/messaging/create-topic.md new file mode 100644 index 0000000000..c103e0d72a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-topic.md @@ -0,0 +1,15 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createTopic( + '<TOPIC_ID>', // topicId + '<NAME>', // name + ["any"] // subscribe (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..73f2b69f93 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-twilio-provider.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createTwilioProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<ACCOUNT_SID>', // accountSid (optional) + '<AUTH_TOKEN>', // authToken (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..166a5a9b97 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/create-vonage-provider.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.createVonageProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<API_KEY>', // apiKey (optional) + '<API_SECRET>', // apiSecret (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/delete-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..aff19d2ae8 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/delete-provider.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.deleteProvider( + '<PROVIDER_ID>' // providerId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/console-web/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..be167bbebf --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/delete-subscriber.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.deleteSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>' // subscriberId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/delete-topic.md b/docs/examples/1.6.x/console-web/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..6d55cbf797 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/delete-topic.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.deleteTopic( + '<TOPIC_ID>' // topicId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/delete.md b/docs/examples/1.6.x/console-web/examples/messaging/delete.md new file mode 100644 index 0000000000..cae970109d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/delete.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.delete( + '<MESSAGE_ID>' // messageId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/get-message.md b/docs/examples/1.6.x/console-web/examples/messaging/get-message.md new file mode 100644 index 0000000000..4857198434 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/get-message.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.getMessage( + '<MESSAGE_ID>' // messageId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/get-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/get-provider.md new file mode 100644 index 0000000000..0526d2bc84 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/get-provider.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.getProvider( + '<PROVIDER_ID>' // providerId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/console-web/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..e43eba9754 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/get-subscriber.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.getSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>' // subscriberId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/get-topic.md b/docs/examples/1.6.x/console-web/examples/messaging/get-topic.md new file mode 100644 index 0000000000..f8afb4ced5 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/get-topic.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.getTopic( + '<TOPIC_ID>' // topicId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/console-web/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..b8e5c506cd --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/list-message-logs.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.listMessageLogs( + '<MESSAGE_ID>', // messageId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-messages.md b/docs/examples/1.6.x/console-web/examples/messaging/list-messages.md new file mode 100644 index 0000000000..6311c77419 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/list-messages.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.listMessages( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/console-web/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..91458fa27a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/list-provider-logs.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.listProviderLogs( + '<PROVIDER_ID>', // providerId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-providers.md b/docs/examples/1.6.x/console-web/examples/messaging/list-providers.md new file mode 100644 index 0000000000..026218d27a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/list-providers.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.listProviders( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/console-web/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..f22a2d7d92 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.listSubscriberLogs( + '<SUBSCRIBER_ID>', // subscriberId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/console-web/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..1ca77b3ead --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/list-subscribers.md @@ -0,0 +1,15 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.listSubscribers( + '<TOPIC_ID>', // topicId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-targets.md b/docs/examples/1.6.x/console-web/examples/messaging/list-targets.md new file mode 100644 index 0000000000..a213207d24 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/list-targets.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.listTargets( + '<MESSAGE_ID>', // messageId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/console-web/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..44f8922e21 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/list-topic-logs.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.listTopicLogs( + '<TOPIC_ID>', // topicId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-topics.md b/docs/examples/1.6.x/console-web/examples/messaging/list-topics.md new file mode 100644 index 0000000000..d2941d6072 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/list-topics.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.listTopics( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..837b51f1f6 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-apns-provider.md @@ -0,0 +1,20 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateApnsProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<AUTH_KEY>', // authKey (optional) + '<AUTH_KEY_ID>', // authKeyId (optional) + '<TEAM_ID>', // teamId (optional) + '<BUNDLE_ID>', // bundleId (optional) + false // sandbox (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-email.md b/docs/examples/1.6.x/console-web/examples/messaging/update-email.md new file mode 100644 index 0000000000..2c2dec4777 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-email.md @@ -0,0 +1,24 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateEmail( + '<MESSAGE_ID>', // messageId + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + '<SUBJECT>', // subject (optional) + '<CONTENT>', // content (optional) + false, // draft (optional) + false, // html (optional) + [], // cc (optional) + [], // bcc (optional) + '', // scheduledAt (optional) + [] // attachments (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..6b56f5964d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-fcm-provider.md @@ -0,0 +1,16 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateFcmProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + {} // serviceAccountJSON (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..2bf2ca60e4 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,22 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateMailgunProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + '<API_KEY>', // apiKey (optional) + '<DOMAIN>', // domain (optional) + false, // isEuRegion (optional) + false, // enabled (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>' // replyToEmail (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..f5ded13d4d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-msg91provider.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateMsg91Provider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<TEMPLATE_ID>', // templateId (optional) + '<SENDER_ID>', // senderId (optional) + '<AUTH_KEY>' // authKey (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-push.md b/docs/examples/1.6.x/console-web/examples/messaging/update-push.md new file mode 100644 index 0000000000..ac26d8b411 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-push.md @@ -0,0 +1,28 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updatePush( + '<MESSAGE_ID>', // messageId + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + '<TITLE>', // title (optional) + '<BODY>', // body (optional) + {}, // data (optional) + '<ACTION>', // action (optional) + '[ID1:ID2]', // image (optional) + '<ICON>', // icon (optional) + '<SOUND>', // sound (optional) + '<COLOR>', // color (optional) + '<TAG>', // tag (optional) + null, // badge (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..3d3897196b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,20 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateSendgridProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<API_KEY>', // apiKey (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>' // replyToEmail (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-sms.md b/docs/examples/1.6.x/console-web/examples/messaging/update-sms.md new file mode 100644 index 0000000000..b14182c735 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-sms.md @@ -0,0 +1,19 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateSms( + '<MESSAGE_ID>', // messageId + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + '<CONTENT>', // content (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..e848e8d15d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-smtp-provider.md @@ -0,0 +1,26 @@ +import { Client, Messaging, SmtpEncryption } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateSmtpProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + '<HOST>', // host (optional) + 1, // port (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) + SmtpEncryption.None, // encryption (optional) + false, // autoTLS (optional) + '<MAILER>', // mailer (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>', // replyToEmail (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..e4e63ccdb7 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-telesign-provider.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateTelesignProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<CUSTOMER_ID>', // customerId (optional) + '<API_KEY>', // apiKey (optional) + '<FROM>' // from (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..b15bc192ee --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateTextmagicProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<USERNAME>', // username (optional) + '<API_KEY>', // apiKey (optional) + '<FROM>' // from (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-topic.md b/docs/examples/1.6.x/console-web/examples/messaging/update-topic.md new file mode 100644 index 0000000000..646484e967 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-topic.md @@ -0,0 +1,15 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateTopic( + '<TOPIC_ID>', // topicId + '<NAME>', // name (optional) + ["any"] // subscribe (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..9cf45ea371 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-twilio-provider.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateTwilioProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<ACCOUNT_SID>', // accountSid (optional) + '<AUTH_TOKEN>', // authToken (optional) + '<FROM>' // from (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..d56549536a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/messaging/update-vonage-provider.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateVonageProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<API_KEY>', // apiKey (optional) + '<API_SECRET>', // apiSecret (optional) + '<FROM>' // from (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/create-appwrite-migration.md b/docs/examples/1.6.x/console-web/examples/migrations/create-appwrite-migration.md new file mode 100644 index 0000000000..f35317ccb2 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/create-appwrite-migration.md @@ -0,0 +1,16 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.createAppwriteMigration( + [], // resources + 'https://example.com', // endpoint + '<PROJECT_ID>', // projectId + '<API_KEY>' // apiKey +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-migration.md b/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-migration.md new file mode 100644 index 0000000000..af85183a17 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-migration.md @@ -0,0 +1,14 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.createFirebaseMigration( + [], // resources + '<SERVICE_ACCOUNT>' // serviceAccount +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-o-auth-migration.md b/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-o-auth-migration.md new file mode 100644 index 0000000000..46f66df70a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-o-auth-migration.md @@ -0,0 +1,14 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.createFirebaseOAuthMigration( + [], // resources + '<PROJECT_ID>' // projectId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/create-n-host-migration.md b/docs/examples/1.6.x/console-web/examples/migrations/create-n-host-migration.md new file mode 100644 index 0000000000..23dd906460 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/create-n-host-migration.md @@ -0,0 +1,20 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.createNHostMigration( + [], // resources + '<SUBDOMAIN>', // subdomain + '<REGION>', // region + '<ADMIN_SECRET>', // adminSecret + '<DATABASE>', // database + '<USERNAME>', // username + '<PASSWORD>', // password + null // port (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/create-supabase-migration.md b/docs/examples/1.6.x/console-web/examples/migrations/create-supabase-migration.md new file mode 100644 index 0000000000..180a88488d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/create-supabase-migration.md @@ -0,0 +1,19 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.createSupabaseMigration( + [], // resources + 'https://example.com', // endpoint + '<API_KEY>', // apiKey + '<DATABASE_HOST>', // databaseHost + '<USERNAME>', // username + '<PASSWORD>', // password + null // port (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/delete-firebase-auth.md b/docs/examples/1.6.x/console-web/examples/migrations/delete-firebase-auth.md new file mode 100644 index 0000000000..a3766f1c4c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/delete-firebase-auth.md @@ -0,0 +1,11 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.deleteFirebaseAuth(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/delete.md b/docs/examples/1.6.x/console-web/examples/migrations/delete.md new file mode 100644 index 0000000000..1ba4d383c0 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/delete.md @@ -0,0 +1,13 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.delete( + '<MIGRATION_ID>' // migrationId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get-appwrite-report.md b/docs/examples/1.6.x/console-web/examples/migrations/get-appwrite-report.md new file mode 100644 index 0000000000..4e3a0bb2af --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/get-appwrite-report.md @@ -0,0 +1,16 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.getAppwriteReport( + [], // resources + 'https://example.com', // endpoint + '<PROJECT_ID>', // projectID + '<KEY>' // key +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report-o-auth.md b/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report-o-auth.md new file mode 100644 index 0000000000..302f5bf039 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report-o-auth.md @@ -0,0 +1,14 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.getFirebaseReportOAuth( + [], // resources + '<PROJECT_ID>' // projectId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report.md b/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report.md new file mode 100644 index 0000000000..3f19494d96 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report.md @@ -0,0 +1,14 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.getFirebaseReport( + [], // resources + '<SERVICE_ACCOUNT>' // serviceAccount +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get-n-host-report.md b/docs/examples/1.6.x/console-web/examples/migrations/get-n-host-report.md new file mode 100644 index 0000000000..73e312a986 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/get-n-host-report.md @@ -0,0 +1,20 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.getNHostReport( + [], // resources + '<SUBDOMAIN>', // subdomain + '<REGION>', // region + '<ADMIN_SECRET>', // adminSecret + '<DATABASE>', // database + '<USERNAME>', // username + '<PASSWORD>', // password + null // port (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get-supabase-report.md b/docs/examples/1.6.x/console-web/examples/migrations/get-supabase-report.md new file mode 100644 index 0000000000..1538bdb9d4 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/get-supabase-report.md @@ -0,0 +1,19 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.getSupabaseReport( + [], // resources + 'https://example.com', // endpoint + '<API_KEY>', // apiKey + '<DATABASE_HOST>', // databaseHost + '<USERNAME>', // username + '<PASSWORD>', // password + null // port (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get.md b/docs/examples/1.6.x/console-web/examples/migrations/get.md new file mode 100644 index 0000000000..ececfcb7d2 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/get.md @@ -0,0 +1,13 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.get( + '<MIGRATION_ID>' // migrationId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/list-firebase-projects.md b/docs/examples/1.6.x/console-web/examples/migrations/list-firebase-projects.md new file mode 100644 index 0000000000..ec15bebd43 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/list-firebase-projects.md @@ -0,0 +1,11 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.listFirebaseProjects(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/list.md b/docs/examples/1.6.x/console-web/examples/migrations/list.md new file mode 100644 index 0000000000..e3f0fd6a93 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/list.md @@ -0,0 +1,14 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/retry.md b/docs/examples/1.6.x/console-web/examples/migrations/retry.md new file mode 100644 index 0000000000..ebd161b448 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/migrations/retry.md @@ -0,0 +1,13 @@ +import { Client, Migrations } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const migrations = new Migrations(client); + +const result = await migrations.retry( + '<MIGRATION_ID>' // migrationId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/create-variable.md b/docs/examples/1.6.x/console-web/examples/project/create-variable.md new file mode 100644 index 0000000000..053a102794 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/project/create-variable.md @@ -0,0 +1,14 @@ +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const project = new Project(client); + +const result = await project.createVariable( + '<KEY>', // key + '<VALUE>' // value +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/delete-variable.md b/docs/examples/1.6.x/console-web/examples/project/delete-variable.md new file mode 100644 index 0000000000..e4806e6396 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/project/delete-variable.md @@ -0,0 +1,13 @@ +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const project = new Project(client); + +const result = await project.deleteVariable( + '<VARIABLE_ID>' // variableId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/get-usage.md b/docs/examples/1.6.x/console-web/examples/project/get-usage.md new file mode 100644 index 0000000000..5200210abf --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/project/get-usage.md @@ -0,0 +1,15 @@ +import { Client, Project, ProjectUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const project = new Project(client); + +const result = await project.getUsage( + '', // startDate + '', // endDate + ProjectUsageRange.OneHour // period (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/get-variable.md b/docs/examples/1.6.x/console-web/examples/project/get-variable.md new file mode 100644 index 0000000000..4f561c877f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/project/get-variable.md @@ -0,0 +1,13 @@ +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const project = new Project(client); + +const result = await project.getVariable( + '<VARIABLE_ID>' // variableId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/list-variables.md b/docs/examples/1.6.x/console-web/examples/project/list-variables.md new file mode 100644 index 0000000000..0915dc2102 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/project/list-variables.md @@ -0,0 +1,11 @@ +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const project = new Project(client); + +const result = await project.listVariables(); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/update-variable.md b/docs/examples/1.6.x/console-web/examples/project/update-variable.md new file mode 100644 index 0000000000..7e9b5bad61 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/project/update-variable.md @@ -0,0 +1,15 @@ +import { Client, Project } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const project = new Project(client); + +const result = await project.updateVariable( + '<VARIABLE_ID>', // variableId + '<KEY>', // key + '<VALUE>' // value (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create-j-w-t.md b/docs/examples/1.6.x/console-web/examples/projects/create-j-w-t.md new file mode 100644 index 0000000000..a1c7612173 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/create-j-w-t.md @@ -0,0 +1,15 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.createJWT( + '<PROJECT_ID>', // projectId + [], // scopes + 0 // duration (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create-key.md b/docs/examples/1.6.x/console-web/examples/projects/create-key.md new file mode 100644 index 0000000000..d2b2ad4b2e --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/create-key.md @@ -0,0 +1,16 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.createKey( + '<PROJECT_ID>', // projectId + '<NAME>', // name + [], // scopes + '' // expire (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create-platform.md b/docs/examples/1.6.x/console-web/examples/projects/create-platform.md new file mode 100644 index 0000000000..6e7633a710 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/create-platform.md @@ -0,0 +1,18 @@ +import { Client, Projects, PlatformType } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.createPlatform( + '<PROJECT_ID>', // projectId + PlatformType.Web, // type + '<NAME>', // name + '<KEY>', // key (optional) + '<STORE>', // store (optional) + '' // hostname (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create-smtp-test.md b/docs/examples/1.6.x/console-web/examples/projects/create-smtp-test.md new file mode 100644 index 0000000000..e3ff0e3aed --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/create-smtp-test.md @@ -0,0 +1,22 @@ +import { Client, Projects, SMTPSecure } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.createSmtpTest( + '<PROJECT_ID>', // projectId + [], // emails + '<SENDER_NAME>', // senderName + 'email@example.com', // senderEmail + '', // host + 'email@example.com', // replyTo (optional) + null, // port (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) + SMTPSecure.Tls // secure (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create-webhook.md b/docs/examples/1.6.x/console-web/examples/projects/create-webhook.md new file mode 100644 index 0000000000..505c7e0ebd --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/create-webhook.md @@ -0,0 +1,20 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.createWebhook( + '<PROJECT_ID>', // projectId + '<NAME>', // name + [], // events + '', // url + false, // security + false, // enabled (optional) + '<HTTP_USER>', // httpUser (optional) + '<HTTP_PASS>' // httpPass (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create.md b/docs/examples/1.6.x/console-web/examples/projects/create.md new file mode 100644 index 0000000000..c6444b516c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/create.md @@ -0,0 +1,25 @@ +import { Client, Projects, } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.create( + '', // projectId + '<NAME>', // name + '<TEAM_ID>', // teamId + .Default, // region (optional) + '<DESCRIPTION>', // description (optional) + '<LOGO>', // logo (optional) + 'https://example.com', // url (optional) + '<LEGAL_NAME>', // legalName (optional) + '<LEGAL_COUNTRY>', // legalCountry (optional) + '<LEGAL_STATE>', // legalState (optional) + '<LEGAL_CITY>', // legalCity (optional) + '<LEGAL_ADDRESS>', // legalAddress (optional) + '<LEGAL_TAX_ID>' // legalTaxId (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete-email-template.md b/docs/examples/1.6.x/console-web/examples/projects/delete-email-template.md new file mode 100644 index 0000000000..b973a0f274 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/delete-email-template.md @@ -0,0 +1,15 @@ +import { Client, Projects, EmailTemplateType, EmailTemplateLocale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.deleteEmailTemplate( + '<PROJECT_ID>', // projectId + EmailTemplateType.Verification, // type + EmailTemplateLocale.Af // locale +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete-key.md b/docs/examples/1.6.x/console-web/examples/projects/delete-key.md new file mode 100644 index 0000000000..53696cceb2 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/delete-key.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.deleteKey( + '<PROJECT_ID>', // projectId + '<KEY_ID>' // keyId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete-platform.md b/docs/examples/1.6.x/console-web/examples/projects/delete-platform.md new file mode 100644 index 0000000000..0cd3d08a63 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/delete-platform.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.deletePlatform( + '<PROJECT_ID>', // projectId + '<PLATFORM_ID>' // platformId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete-sms-template.md b/docs/examples/1.6.x/console-web/examples/projects/delete-sms-template.md new file mode 100644 index 0000000000..875d9c7caa --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/delete-sms-template.md @@ -0,0 +1,15 @@ +import { Client, Projects, SmsTemplateType, SmsTemplateLocale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.deleteSmsTemplate( + '<PROJECT_ID>', // projectId + SmsTemplateType.Verification, // type + SmsTemplateLocale.Af // locale +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete-webhook.md b/docs/examples/1.6.x/console-web/examples/projects/delete-webhook.md new file mode 100644 index 0000000000..94f5a9ad6f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/delete-webhook.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.deleteWebhook( + '<PROJECT_ID>', // projectId + '<WEBHOOK_ID>' // webhookId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete.md b/docs/examples/1.6.x/console-web/examples/projects/delete.md new file mode 100644 index 0000000000..79a7df00f2 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/delete.md @@ -0,0 +1,13 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.delete( + '<PROJECT_ID>' // projectId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get-email-template.md b/docs/examples/1.6.x/console-web/examples/projects/get-email-template.md new file mode 100644 index 0000000000..1982c29559 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/get-email-template.md @@ -0,0 +1,15 @@ +import { Client, Projects, EmailTemplateType, EmailTemplateLocale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.getEmailTemplate( + '<PROJECT_ID>', // projectId + EmailTemplateType.Verification, // type + EmailTemplateLocale.Af // locale +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get-key.md b/docs/examples/1.6.x/console-web/examples/projects/get-key.md new file mode 100644 index 0000000000..c4ce139901 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/get-key.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.getKey( + '<PROJECT_ID>', // projectId + '<KEY_ID>' // keyId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get-platform.md b/docs/examples/1.6.x/console-web/examples/projects/get-platform.md new file mode 100644 index 0000000000..3afe06d817 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/get-platform.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.getPlatform( + '<PROJECT_ID>', // projectId + '<PLATFORM_ID>' // platformId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get-sms-template.md b/docs/examples/1.6.x/console-web/examples/projects/get-sms-template.md new file mode 100644 index 0000000000..2588ab0d77 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/get-sms-template.md @@ -0,0 +1,15 @@ +import { Client, Projects, SmsTemplateType, SmsTemplateLocale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.getSmsTemplate( + '<PROJECT_ID>', // projectId + SmsTemplateType.Verification, // type + SmsTemplateLocale.Af // locale +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get-webhook.md b/docs/examples/1.6.x/console-web/examples/projects/get-webhook.md new file mode 100644 index 0000000000..9b6637d08f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/get-webhook.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.getWebhook( + '<PROJECT_ID>', // projectId + '<WEBHOOK_ID>' // webhookId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get.md b/docs/examples/1.6.x/console-web/examples/projects/get.md new file mode 100644 index 0000000000..fa2d94b22b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/get.md @@ -0,0 +1,13 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.get( + '<PROJECT_ID>' // projectId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/list-keys.md b/docs/examples/1.6.x/console-web/examples/projects/list-keys.md new file mode 100644 index 0000000000..679914462a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/list-keys.md @@ -0,0 +1,13 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.listKeys( + '<PROJECT_ID>' // projectId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/list-platforms.md b/docs/examples/1.6.x/console-web/examples/projects/list-platforms.md new file mode 100644 index 0000000000..b0f4904626 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/list-platforms.md @@ -0,0 +1,13 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.listPlatforms( + '<PROJECT_ID>' // projectId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/list-webhooks.md b/docs/examples/1.6.x/console-web/examples/projects/list-webhooks.md new file mode 100644 index 0000000000..e567fc695c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/list-webhooks.md @@ -0,0 +1,13 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.listWebhooks( + '<PROJECT_ID>' // projectId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/list.md b/docs/examples/1.6.x/console-web/examples/projects/list.md new file mode 100644 index 0000000000..f81ae481a1 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/list.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-api-status-all.md b/docs/examples/1.6.x/console-web/examples/projects/update-api-status-all.md new file mode 100644 index 0000000000..e28544d354 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-api-status-all.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateApiStatusAll( + '<PROJECT_ID>', // projectId + false // status +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-api-status.md b/docs/examples/1.6.x/console-web/examples/projects/update-api-status.md new file mode 100644 index 0000000000..c5b7e27ba4 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-api-status.md @@ -0,0 +1,15 @@ +import { Client, Projects, } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateApiStatus( + '<PROJECT_ID>', // projectId + .Rest, // api + false // status +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-duration.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-duration.md new file mode 100644 index 0000000000..6c000c11d8 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-auth-duration.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateAuthDuration( + '<PROJECT_ID>', // projectId + 0 // duration +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-limit.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-limit.md new file mode 100644 index 0000000000..1a68366ed0 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-auth-limit.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateAuthLimit( + '<PROJECT_ID>', // projectId + 0 // limit +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-dictionary.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-dictionary.md new file mode 100644 index 0000000000..8d9d961c1e --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-dictionary.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateAuthPasswordDictionary( + '<PROJECT_ID>', // projectId + false // enabled +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-history.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-history.md new file mode 100644 index 0000000000..9f7f295af9 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-history.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateAuthPasswordHistory( + '<PROJECT_ID>', // projectId + 0 // limit +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-sessions-limit.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-sessions-limit.md new file mode 100644 index 0000000000..a20d375051 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-auth-sessions-limit.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateAuthSessionsLimit( + '<PROJECT_ID>', // projectId + 1 // limit +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-status.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-status.md new file mode 100644 index 0000000000..4eb886dac9 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-auth-status.md @@ -0,0 +1,15 @@ +import { Client, Projects, AuthMethod } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateAuthStatus( + '<PROJECT_ID>', // projectId + AuthMethod.EmailPassword, // method + false // status +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-email-template.md b/docs/examples/1.6.x/console-web/examples/projects/update-email-template.md new file mode 100644 index 0000000000..965111ad0e --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-email-template.md @@ -0,0 +1,20 @@ +import { Client, Projects, EmailTemplateType, EmailTemplateLocale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateEmailTemplate( + '<PROJECT_ID>', // projectId + EmailTemplateType.Verification, // type + EmailTemplateLocale.Af, // locale + '<SUBJECT>', // subject + '<MESSAGE>', // message + '<SENDER_NAME>', // senderName (optional) + 'email@example.com', // senderEmail (optional) + 'email@example.com' // replyTo (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-key.md b/docs/examples/1.6.x/console-web/examples/projects/update-key.md new file mode 100644 index 0000000000..97c4138bf7 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-key.md @@ -0,0 +1,17 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateKey( + '<PROJECT_ID>', // projectId + '<KEY_ID>', // keyId + '<NAME>', // name + [], // scopes + '' // expire (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-mock-numbers.md b/docs/examples/1.6.x/console-web/examples/projects/update-mock-numbers.md new file mode 100644 index 0000000000..da698a4eb6 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-mock-numbers.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateMockNumbers( + '<PROJECT_ID>', // projectId + [] // numbers +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-o-auth2.md b/docs/examples/1.6.x/console-web/examples/projects/update-o-auth2.md new file mode 100644 index 0000000000..0870f1e81c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-o-auth2.md @@ -0,0 +1,17 @@ +import { Client, Projects, OAuthProvider } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateOAuth2( + '<PROJECT_ID>', // projectId + OAuthProvider.Amazon, // provider + '<APP_ID>', // appId (optional) + '<SECRET>', // secret (optional) + false // enabled (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-personal-data-check.md b/docs/examples/1.6.x/console-web/examples/projects/update-personal-data-check.md new file mode 100644 index 0000000000..b2cefc1e7f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-personal-data-check.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updatePersonalDataCheck( + '<PROJECT_ID>', // projectId + false // enabled +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-platform.md b/docs/examples/1.6.x/console-web/examples/projects/update-platform.md new file mode 100644 index 0000000000..fc62f57360 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-platform.md @@ -0,0 +1,18 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updatePlatform( + '<PROJECT_ID>', // projectId + '<PLATFORM_ID>', // platformId + '<NAME>', // name + '<KEY>', // key (optional) + '<STORE>', // store (optional) + '' // hostname (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-service-status-all.md b/docs/examples/1.6.x/console-web/examples/projects/update-service-status-all.md new file mode 100644 index 0000000000..9f09337ea5 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-service-status-all.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateServiceStatusAll( + '<PROJECT_ID>', // projectId + false // status +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-service-status.md b/docs/examples/1.6.x/console-web/examples/projects/update-service-status.md new file mode 100644 index 0000000000..bf9d69c63f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-service-status.md @@ -0,0 +1,15 @@ +import { Client, Projects, ApiService } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateServiceStatus( + '<PROJECT_ID>', // projectId + ApiService.Account, // service + false // status +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-session-alerts.md b/docs/examples/1.6.x/console-web/examples/projects/update-session-alerts.md new file mode 100644 index 0000000000..bae22464ec --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-session-alerts.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateSessionAlerts( + '<PROJECT_ID>', // projectId + false // alerts +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-sms-template.md b/docs/examples/1.6.x/console-web/examples/projects/update-sms-template.md new file mode 100644 index 0000000000..3d73d450d8 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-sms-template.md @@ -0,0 +1,16 @@ +import { Client, Projects, SmsTemplateType, SmsTemplateLocale } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateSmsTemplate( + '<PROJECT_ID>', // projectId + SmsTemplateType.Verification, // type + SmsTemplateLocale.Af, // locale + '<MESSAGE>' // message +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-smtp.md b/docs/examples/1.6.x/console-web/examples/projects/update-smtp.md new file mode 100644 index 0000000000..b24d6b5349 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-smtp.md @@ -0,0 +1,22 @@ +import { Client, Projects, SMTPSecure } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateSmtp( + '<PROJECT_ID>', // projectId + false, // enabled + '<SENDER_NAME>', // senderName (optional) + 'email@example.com', // senderEmail (optional) + 'email@example.com', // replyTo (optional) + '', // host (optional) + null, // port (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) + SMTPSecure.Tls // secure (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-team.md b/docs/examples/1.6.x/console-web/examples/projects/update-team.md new file mode 100644 index 0000000000..98ef985779 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-team.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateTeam( + '<PROJECT_ID>', // projectId + '<TEAM_ID>' // teamId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-webhook-signature.md b/docs/examples/1.6.x/console-web/examples/projects/update-webhook-signature.md new file mode 100644 index 0000000000..ff2c0a6e7e --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-webhook-signature.md @@ -0,0 +1,14 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateWebhookSignature( + '<PROJECT_ID>', // projectId + '<WEBHOOK_ID>' // webhookId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-webhook.md b/docs/examples/1.6.x/console-web/examples/projects/update-webhook.md new file mode 100644 index 0000000000..69fd250da9 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update-webhook.md @@ -0,0 +1,21 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.updateWebhook( + '<PROJECT_ID>', // projectId + '<WEBHOOK_ID>', // webhookId + '<NAME>', // name + [], // events + '', // url + false, // security + false, // enabled (optional) + '<HTTP_USER>', // httpUser (optional) + '<HTTP_PASS>' // httpPass (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update.md b/docs/examples/1.6.x/console-web/examples/projects/update.md new file mode 100644 index 0000000000..49d8bf9e23 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/projects/update.md @@ -0,0 +1,23 @@ +import { Client, Projects } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const projects = new Projects(client); + +const result = await projects.update( + '<PROJECT_ID>', // projectId + '<NAME>', // name + '<DESCRIPTION>', // description (optional) + '<LOGO>', // logo (optional) + 'https://example.com', // url (optional) + '<LEGAL_NAME>', // legalName (optional) + '<LEGAL_COUNTRY>', // legalCountry (optional) + '<LEGAL_STATE>', // legalState (optional) + '<LEGAL_CITY>', // legalCity (optional) + '<LEGAL_ADDRESS>', // legalAddress (optional) + '<LEGAL_TAX_ID>' // legalTaxId (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/proxy/create-rule.md b/docs/examples/1.6.x/console-web/examples/proxy/create-rule.md new file mode 100644 index 0000000000..2bf7a8d446 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/proxy/create-rule.md @@ -0,0 +1,15 @@ +import { Client, Proxy, } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const proxy = new Proxy(client); + +const result = await proxy.createRule( + '', // domain + .Api, // resourceType + '<RESOURCE_ID>' // resourceId (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/proxy/delete-rule.md b/docs/examples/1.6.x/console-web/examples/proxy/delete-rule.md new file mode 100644 index 0000000000..a9ffeef834 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/proxy/delete-rule.md @@ -0,0 +1,13 @@ +import { Client, Proxy } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const proxy = new Proxy(client); + +const result = await proxy.deleteRule( + '<RULE_ID>' // ruleId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/proxy/get-rule.md b/docs/examples/1.6.x/console-web/examples/proxy/get-rule.md new file mode 100644 index 0000000000..95ff2124ac --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/proxy/get-rule.md @@ -0,0 +1,13 @@ +import { Client, Proxy } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const proxy = new Proxy(client); + +const result = await proxy.getRule( + '<RULE_ID>' // ruleId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/proxy/list-rules.md b/docs/examples/1.6.x/console-web/examples/proxy/list-rules.md new file mode 100644 index 0000000000..f9b7f35376 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/proxy/list-rules.md @@ -0,0 +1,14 @@ +import { Client, Proxy } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const proxy = new Proxy(client); + +const result = await proxy.listRules( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/proxy/update-rule-verification.md b/docs/examples/1.6.x/console-web/examples/proxy/update-rule-verification.md new file mode 100644 index 0000000000..1696c32b34 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/proxy/update-rule-verification.md @@ -0,0 +1,13 @@ +import { Client, Proxy } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const proxy = new Proxy(client); + +const result = await proxy.updateRuleVerification( + '<RULE_ID>' // ruleId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/create-bucket.md b/docs/examples/1.6.x/console-web/examples/storage/create-bucket.md new file mode 100644 index 0000000000..4481ada4aa --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/create-bucket.md @@ -0,0 +1,22 @@ +import { Client, Storage, } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.createBucket( + '<BUCKET_ID>', // bucketId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // fileSecurity (optional) + false, // enabled (optional) + 1, // maximumFileSize (optional) + [], // allowedFileExtensions (optional) + .None, // compression (optional) + false, // encryption (optional) + false // antivirus (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/create-file.md b/docs/examples/1.6.x/console-web/examples/storage/create-file.md new file mode 100644 index 0000000000..ec326fa71e --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/create-file.md @@ -0,0 +1,16 @@ +import { Client, Storage } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.createFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + document.getElementById('uploader').files[0], // file + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/delete-bucket.md b/docs/examples/1.6.x/console-web/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..819def336e --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/delete-bucket.md @@ -0,0 +1,13 @@ +import { Client, Storage } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.deleteBucket( + '<BUCKET_ID>' // bucketId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/delete-file.md b/docs/examples/1.6.x/console-web/examples/storage/delete-file.md new file mode 100644 index 0000000000..670770706f --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/delete-file.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.deleteFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-bucket-usage.md b/docs/examples/1.6.x/console-web/examples/storage/get-bucket-usage.md new file mode 100644 index 0000000000..98d4a621ec --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/get-bucket-usage.md @@ -0,0 +1,14 @@ +import { Client, Storage, StorageUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.getBucketUsage( + '<BUCKET_ID>', // bucketId + StorageUsageRange.TwentyFourHours // range (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-bucket.md b/docs/examples/1.6.x/console-web/examples/storage/get-bucket.md new file mode 100644 index 0000000000..52b7082baf --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/get-bucket.md @@ -0,0 +1,13 @@ +import { Client, Storage } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.getBucket( + '<BUCKET_ID>' // bucketId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-file-download.md b/docs/examples/1.6.x/console-web/examples/storage/get-file-download.md new file mode 100644 index 0000000000..53e6a846e8 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/get-file-download.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = storage.getFileDownload( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-file-preview.md b/docs/examples/1.6.x/console-web/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..43c3582dcb --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/get-file-preview.md @@ -0,0 +1,25 @@ +import { Client, Storage, ImageGravity, ImageFormat } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = storage.getFilePreview( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + 0, // width (optional) + 0, // height (optional) + ImageGravity.Center, // gravity (optional) + 0, // quality (optional) + 0, // borderWidth (optional) + '', // borderColor (optional) + 0, // borderRadius (optional) + 0, // opacity (optional) + -360, // rotation (optional) + '', // background (optional) + ImageFormat.Jpg // output (optional) +); + +console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-file-view.md b/docs/examples/1.6.x/console-web/examples/storage/get-file-view.md new file mode 100644 index 0000000000..787bd67d16 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/get-file-view.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = storage.getFileView( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-file.md b/docs/examples/1.6.x/console-web/examples/storage/get-file.md new file mode 100644 index 0000000000..e1118c0f26 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/get-file.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.getFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-usage.md b/docs/examples/1.6.x/console-web/examples/storage/get-usage.md new file mode 100644 index 0000000000..a67dbf1af8 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/get-usage.md @@ -0,0 +1,13 @@ +import { Client, Storage, StorageUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.getUsage( + StorageUsageRange.TwentyFourHours // range (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/list-buckets.md b/docs/examples/1.6.x/console-web/examples/storage/list-buckets.md new file mode 100644 index 0000000000..5caf111b64 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/list-buckets.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.listBuckets( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/list-files.md b/docs/examples/1.6.x/console-web/examples/storage/list-files.md new file mode 100644 index 0000000000..c139e8ba14 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/list-files.md @@ -0,0 +1,15 @@ +import { Client, Storage } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.listFiles( + '<BUCKET_ID>', // bucketId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/update-bucket.md b/docs/examples/1.6.x/console-web/examples/storage/update-bucket.md new file mode 100644 index 0000000000..bd7d923358 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/update-bucket.md @@ -0,0 +1,22 @@ +import { Client, Storage, } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.updateBucket( + '<BUCKET_ID>', // bucketId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // fileSecurity (optional) + false, // enabled (optional) + 1, // maximumFileSize (optional) + [], // allowedFileExtensions (optional) + .None, // compression (optional) + false, // encryption (optional) + false // antivirus (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/update-file.md b/docs/examples/1.6.x/console-web/examples/storage/update-file.md new file mode 100644 index 0000000000..c597905956 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/storage/update-file.md @@ -0,0 +1,16 @@ +import { Client, Storage } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const storage = new Storage(client); + +const result = await storage.updateFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + '<NAME>', // name (optional) + ["read("any")"] // permissions (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/create-membership.md b/docs/examples/1.6.x/console-web/examples/teams/create-membership.md new file mode 100644 index 0000000000..6eb57f4404 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/create-membership.md @@ -0,0 +1,19 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.createMembership( + '<TEAM_ID>', // teamId + [], // roles + 'email@example.com', // email (optional) + '<USER_ID>', // userId (optional) + '+12065550100', // phone (optional) + 'https://example.com', // url (optional) + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/create.md b/docs/examples/1.6.x/console-web/examples/teams/create.md new file mode 100644 index 0000000000..47aad4c384 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/create.md @@ -0,0 +1,15 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.create( + '<TEAM_ID>', // teamId + '<NAME>', // name + [] // roles (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/delete-membership.md b/docs/examples/1.6.x/console-web/examples/teams/delete-membership.md new file mode 100644 index 0000000000..ba07bb2ccb --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/delete-membership.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.deleteMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/delete.md b/docs/examples/1.6.x/console-web/examples/teams/delete.md new file mode 100644 index 0000000000..71a4721359 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/delete.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.delete( + '<TEAM_ID>' // teamId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/get-membership.md b/docs/examples/1.6.x/console-web/examples/teams/get-membership.md new file mode 100644 index 0000000000..1b97621834 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/get-membership.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.getMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/get-prefs.md b/docs/examples/1.6.x/console-web/examples/teams/get-prefs.md new file mode 100644 index 0000000000..fc21ec0e13 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/get-prefs.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.getPrefs( + '<TEAM_ID>' // teamId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/get.md b/docs/examples/1.6.x/console-web/examples/teams/get.md new file mode 100644 index 0000000000..5de7eba9bf --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/get.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.get( + '<TEAM_ID>' // teamId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/list-logs.md b/docs/examples/1.6.x/console-web/examples/teams/list-logs.md new file mode 100644 index 0000000000..5d18db7f90 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/list-logs.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.listLogs( + '<TEAM_ID>', // teamId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/list-memberships.md b/docs/examples/1.6.x/console-web/examples/teams/list-memberships.md new file mode 100644 index 0000000000..c1fcaa0833 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/list-memberships.md @@ -0,0 +1,15 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.listMemberships( + '<TEAM_ID>', // teamId + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/list.md b/docs/examples/1.6.x/console-web/examples/teams/list.md new file mode 100644 index 0000000000..fbd10f5071 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/list.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/update-membership-status.md b/docs/examples/1.6.x/console-web/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..14d386c664 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/update-membership-status.md @@ -0,0 +1,16 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updateMembershipStatus( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId + '<USER_ID>', // userId + '<SECRET>' // secret +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/update-membership.md b/docs/examples/1.6.x/console-web/examples/teams/update-membership.md new file mode 100644 index 0000000000..c83344fc0e --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/update-membership.md @@ -0,0 +1,15 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updateMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId + [] // roles +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/update-name.md b/docs/examples/1.6.x/console-web/examples/teams/update-name.md new file mode 100644 index 0000000000..b64c0d790d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/update-name.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updateName( + '<TEAM_ID>', // teamId + '<NAME>' // name +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/update-prefs.md b/docs/examples/1.6.x/console-web/examples/teams/update-prefs.md new file mode 100644 index 0000000000..d55b2aacff --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/teams/update-prefs.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const teams = new Teams(client); + +const result = await teams.updatePrefs( + '<TEAM_ID>', // teamId + {} // prefs +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-argon2user.md b/docs/examples/1.6.x/console-web/examples/users/create-argon2user.md new file mode 100644 index 0000000000..02c6c1e193 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-argon2user.md @@ -0,0 +1,16 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createArgon2User( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/console-web/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..ec9e978085 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-bcrypt-user.md @@ -0,0 +1,16 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createBcryptUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-j-w-t.md b/docs/examples/1.6.x/console-web/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..effe86748c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-j-w-t.md @@ -0,0 +1,15 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createJWT( + '<USER_ID>', // userId + '<SESSION_ID>', // sessionId (optional) + 0 // duration (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-m-d5user.md b/docs/examples/1.6.x/console-web/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..4b7ced5793 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-m-d5user.md @@ -0,0 +1,16 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createMD5User( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..7297fac96a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createMfaRecoveryCodes( + '<USER_ID>' // userId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/console-web/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..52cdec1414 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-p-h-pass-user.md @@ -0,0 +1,16 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createPHPassUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/console-web/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..029a524bc9 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-s-h-a-user.md @@ -0,0 +1,17 @@ +import { Client, Users, PasswordHash } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createSHAUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + PasswordHash.Sha1, // passwordVersion (optional) + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/console-web/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..0a94516199 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,19 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createScryptModifiedUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<PASSWORD_SALT>', // passwordSalt + '<PASSWORD_SALT_SEPARATOR>', // passwordSaltSeparator + '<PASSWORD_SIGNER_KEY>', // passwordSignerKey + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/console-web/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..eb9cc238c6 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-scrypt-user.md @@ -0,0 +1,21 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createScryptUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<PASSWORD_SALT>', // passwordSalt + null, // passwordCpu + null, // passwordMemory + null, // passwordParallel + null, // passwordLength + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-session.md b/docs/examples/1.6.x/console-web/examples/users/create-session.md new file mode 100644 index 0000000000..83c3540508 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-session.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createSession( + '<USER_ID>' // userId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-target.md b/docs/examples/1.6.x/console-web/examples/users/create-target.md new file mode 100644 index 0000000000..b44a7bceed --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-target.md @@ -0,0 +1,18 @@ +import { Client, Users, MessagingProviderType } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createTarget( + '<USER_ID>', // userId + '<TARGET_ID>', // targetId + MessagingProviderType.Email, // providerType + '<IDENTIFIER>', // identifier + '<PROVIDER_ID>', // providerId (optional) + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-token.md b/docs/examples/1.6.x/console-web/examples/users/create-token.md new file mode 100644 index 0000000000..54611cb8dc --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create-token.md @@ -0,0 +1,15 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.createToken( + '<USER_ID>', // userId + 4, // length (optional) + 60 // expire (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create.md b/docs/examples/1.6.x/console-web/examples/users/create.md new file mode 100644 index 0000000000..488bea064a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/create.md @@ -0,0 +1,17 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.create( + '<USER_ID>', // userId + 'email@example.com', // email (optional) + '+12065550100', // phone (optional) + '', // password (optional) + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete-identity.md b/docs/examples/1.6.x/console-web/examples/users/delete-identity.md new file mode 100644 index 0000000000..bd44e19df6 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/delete-identity.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.deleteIdentity( + '<IDENTITY_ID>' // identityId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/console-web/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..6264163605 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,14 @@ +import { Client, Users, AuthenticatorType } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.deleteMfaAuthenticator( + '<USER_ID>', // userId + AuthenticatorType.Totp // type +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete-session.md b/docs/examples/1.6.x/console-web/examples/users/delete-session.md new file mode 100644 index 0000000000..95832cddc7 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/delete-session.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.deleteSession( + '<USER_ID>', // userId + '<SESSION_ID>' // sessionId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete-sessions.md b/docs/examples/1.6.x/console-web/examples/users/delete-sessions.md new file mode 100644 index 0000000000..6e272418f0 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/delete-sessions.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.deleteSessions( + '<USER_ID>' // userId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete-target.md b/docs/examples/1.6.x/console-web/examples/users/delete-target.md new file mode 100644 index 0000000000..62ea4fff20 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/delete-target.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.deleteTarget( + '<USER_ID>', // userId + '<TARGET_ID>' // targetId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete.md b/docs/examples/1.6.x/console-web/examples/users/delete.md new file mode 100644 index 0000000000..6304bf4dbe --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/delete.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.delete( + '<USER_ID>' // userId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..96b1e53793 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.getMfaRecoveryCodes( + '<USER_ID>' // userId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/get-prefs.md b/docs/examples/1.6.x/console-web/examples/users/get-prefs.md new file mode 100644 index 0000000000..30f0e87967 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/get-prefs.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.getPrefs( + '<USER_ID>' // userId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/get-target.md b/docs/examples/1.6.x/console-web/examples/users/get-target.md new file mode 100644 index 0000000000..e568bec924 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/get-target.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.getTarget( + '<USER_ID>', // userId + '<TARGET_ID>' // targetId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/get-usage.md b/docs/examples/1.6.x/console-web/examples/users/get-usage.md new file mode 100644 index 0000000000..7690def7d9 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/get-usage.md @@ -0,0 +1,13 @@ +import { Client, Users, UserUsageRange } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.getUsage( + UserUsageRange.TwentyFourHours // range (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/get.md b/docs/examples/1.6.x/console-web/examples/users/get.md new file mode 100644 index 0000000000..3fe5d22dd5 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/get.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.get( + '<USER_ID>' // userId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-identities.md b/docs/examples/1.6.x/console-web/examples/users/list-identities.md new file mode 100644 index 0000000000..a56388cf54 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/list-identities.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.listIdentities( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-logs.md b/docs/examples/1.6.x/console-web/examples/users/list-logs.md new file mode 100644 index 0000000000..4ec5e667d7 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/list-logs.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.listLogs( + '<USER_ID>', // userId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-memberships.md b/docs/examples/1.6.x/console-web/examples/users/list-memberships.md new file mode 100644 index 0000000000..389a2cd136 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/list-memberships.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.listMemberships( + '<USER_ID>' // userId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/console-web/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..5a34a5d38c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/list-mfa-factors.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.listMfaFactors( + '<USER_ID>' // userId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-sessions.md b/docs/examples/1.6.x/console-web/examples/users/list-sessions.md new file mode 100644 index 0000000000..3aaa019413 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/list-sessions.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.listSessions( + '<USER_ID>' // userId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-targets.md b/docs/examples/1.6.x/console-web/examples/users/list-targets.md new file mode 100644 index 0000000000..950fa08ed3 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/list-targets.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.listTargets( + '<USER_ID>', // userId + [] // queries (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list.md b/docs/examples/1.6.x/console-web/examples/users/list.md new file mode 100644 index 0000000000..f3421fdca3 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/list.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-email-verification.md b/docs/examples/1.6.x/console-web/examples/users/update-email-verification.md new file mode 100644 index 0000000000..991af51cc8 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-email-verification.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updateEmailVerification( + '<USER_ID>', // userId + false // emailVerification +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-email.md b/docs/examples/1.6.x/console-web/examples/users/update-email.md new file mode 100644 index 0000000000..28c892aef6 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-email.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updateEmail( + '<USER_ID>', // userId + 'email@example.com' // email +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-labels.md b/docs/examples/1.6.x/console-web/examples/users/update-labels.md new file mode 100644 index 0000000000..b5031d7583 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-labels.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updateLabels( + '<USER_ID>', // userId + [] // labels +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..0b7586da0d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,13 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updateMfaRecoveryCodes( + '<USER_ID>' // userId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-mfa.md b/docs/examples/1.6.x/console-web/examples/users/update-mfa.md new file mode 100644 index 0000000000..16bc49c5c3 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-mfa.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updateMfa( + '<USER_ID>', // userId + false // mfa +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-name.md b/docs/examples/1.6.x/console-web/examples/users/update-name.md new file mode 100644 index 0000000000..59aca8c013 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-name.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updateName( + '<USER_ID>', // userId + '<NAME>' // name +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-password.md b/docs/examples/1.6.x/console-web/examples/users/update-password.md new file mode 100644 index 0000000000..f6e7c4c369 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-password.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updatePassword( + '<USER_ID>', // userId + '' // password +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-phone-verification.md b/docs/examples/1.6.x/console-web/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..f477ec2419 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-phone-verification.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updatePhoneVerification( + '<USER_ID>', // userId + false // phoneVerification +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-phone.md b/docs/examples/1.6.x/console-web/examples/users/update-phone.md new file mode 100644 index 0000000000..1d942f384a --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-phone.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updatePhone( + '<USER_ID>', // userId + '+12065550100' // number +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-prefs.md b/docs/examples/1.6.x/console-web/examples/users/update-prefs.md new file mode 100644 index 0000000000..853631e0cb --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-prefs.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updatePrefs( + '<USER_ID>', // userId + {} // prefs +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-status.md b/docs/examples/1.6.x/console-web/examples/users/update-status.md new file mode 100644 index 0000000000..6b28c5d744 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-status.md @@ -0,0 +1,14 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updateStatus( + '<USER_ID>', // userId + false // status +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-target.md b/docs/examples/1.6.x/console-web/examples/users/update-target.md new file mode 100644 index 0000000000..86fc1c3154 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/users/update-target.md @@ -0,0 +1,17 @@ +import { Client, Users } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const users = new Users(client); + +const result = await users.updateTarget( + '<USER_ID>', // userId + '<TARGET_ID>', // targetId + '<IDENTIFIER>', // identifier (optional) + '<PROVIDER_ID>', // providerId (optional) + '<NAME>' // name (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/create-repository-detection.md b/docs/examples/1.6.x/console-web/examples/vcs/create-repository-detection.md new file mode 100644 index 0000000000..dd71b6757d --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/vcs/create-repository-detection.md @@ -0,0 +1,15 @@ +import { Client, Vcs } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const vcs = new Vcs(client); + +const result = await vcs.createRepositoryDetection( + '<INSTALLATION_ID>', // installationId + '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId + '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/create-repository.md b/docs/examples/1.6.x/console-web/examples/vcs/create-repository.md new file mode 100644 index 0000000000..7d73b2ab83 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/vcs/create-repository.md @@ -0,0 +1,15 @@ +import { Client, Vcs } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const vcs = new Vcs(client); + +const result = await vcs.createRepository( + '<INSTALLATION_ID>', // installationId + '<NAME>', // name + false // private +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/delete-installation.md b/docs/examples/1.6.x/console-web/examples/vcs/delete-installation.md new file mode 100644 index 0000000000..a770bb66eb --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/vcs/delete-installation.md @@ -0,0 +1,13 @@ +import { Client, Vcs } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const vcs = new Vcs(client); + +const result = await vcs.deleteInstallation( + '<INSTALLATION_ID>' // installationId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/get-installation.md b/docs/examples/1.6.x/console-web/examples/vcs/get-installation.md new file mode 100644 index 0000000000..961a6c4d70 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/vcs/get-installation.md @@ -0,0 +1,13 @@ +import { Client, Vcs } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const vcs = new Vcs(client); + +const result = await vcs.getInstallation( + '<INSTALLATION_ID>' // installationId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/get-repository-contents.md b/docs/examples/1.6.x/console-web/examples/vcs/get-repository-contents.md new file mode 100644 index 0000000000..e9c57376e6 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/vcs/get-repository-contents.md @@ -0,0 +1,15 @@ +import { Client, Vcs } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const vcs = new Vcs(client); + +const result = await vcs.getRepositoryContents( + '<INSTALLATION_ID>', // installationId + '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId + '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/get-repository.md b/docs/examples/1.6.x/console-web/examples/vcs/get-repository.md new file mode 100644 index 0000000000..05d8b6c453 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/vcs/get-repository.md @@ -0,0 +1,14 @@ +import { Client, Vcs } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const vcs = new Vcs(client); + +const result = await vcs.getRepository( + '<INSTALLATION_ID>', // installationId + '<PROVIDER_REPOSITORY_ID>' // providerRepositoryId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/list-installations.md b/docs/examples/1.6.x/console-web/examples/vcs/list-installations.md new file mode 100644 index 0000000000..64ff523c0c --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/vcs/list-installations.md @@ -0,0 +1,14 @@ +import { Client, Vcs } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const vcs = new Vcs(client); + +const result = await vcs.listInstallations( + [], // queries (optional) + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/list-repositories.md b/docs/examples/1.6.x/console-web/examples/vcs/list-repositories.md new file mode 100644 index 0000000000..80115d6c24 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/vcs/list-repositories.md @@ -0,0 +1,14 @@ +import { Client, Vcs } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const vcs = new Vcs(client); + +const result = await vcs.listRepositories( + '<INSTALLATION_ID>', // installationId + '<SEARCH>' // search (optional) +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/list-repository-branches.md b/docs/examples/1.6.x/console-web/examples/vcs/list-repository-branches.md new file mode 100644 index 0000000000..d236f8b598 --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/vcs/list-repository-branches.md @@ -0,0 +1,14 @@ +import { Client, Vcs } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const vcs = new Vcs(client); + +const result = await vcs.listRepositoryBranches( + '<INSTALLATION_ID>', // installationId + '<PROVIDER_REPOSITORY_ID>' // providerRepositoryId +); + +console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/update-external-deployments.md b/docs/examples/1.6.x/console-web/examples/vcs/update-external-deployments.md new file mode 100644 index 0000000000..577e0ac59b --- /dev/null +++ b/docs/examples/1.6.x/console-web/examples/vcs/update-external-deployments.md @@ -0,0 +1,15 @@ +import { Client, Vcs } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const vcs = new Vcs(client); + +const result = await vcs.updateExternalDeployments( + '<INSTALLATION_ID>', // installationId + '<REPOSITORY_ID>', // repositoryId + '<PROVIDER_PULL_REQUEST_ID>' // providerPullRequestId +); + +console.log(response); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-dart/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..63e0e12f4a --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-anonymous-session.md @@ -0,0 +1,9 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.createAnonymousSession(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-dart/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..bf2fa29a24 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-email-password-session.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.createEmailPasswordSession( + email: 'email@example.com', + password: 'password', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-email-token.md b/docs/examples/1.6.x/server-dart/examples/account/create-email-token.md new file mode 100644 index 0000000000..9c85d1b974 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-email-token.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.createEmailToken( + userId: '<USER_ID>', + email: 'email@example.com', + phrase: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-dart/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..eba3e5e638 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-j-w-t.md @@ -0,0 +1,9 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Jwt result = await account.createJWT(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-dart/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..8518b35c63 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.createMagicURLToken( + userId: '<USER_ID>', + email: 'email@example.com', + url: 'https://example.com', // (optional) + phrase: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-dart/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..27ba997aab --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-mfa-authenticator.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +MfaType result = await account.createMfaAuthenticator( + type: AuthenticatorType.totp, +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-dart/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..7837505840 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-mfa-challenge.md @@ -0,0 +1,11 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +MfaChallenge result = await account.createMfaChallenge( + factor: AuthenticationFactor.email, +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..aae8a6ac60 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +MfaRecoveryCodes result = await account.createMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-dart/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..fc2d19abd0 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-o-auth2token.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +await account.createOAuth2Token( + provider: OAuthProvider.amazon, + success: 'https://example.com', // (optional) + failure: 'https://example.com', // (optional) + scopes: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-dart/examples/account/create-phone-token.md new file mode 100644 index 0000000000..08d177d777 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-phone-token.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Token result = await account.createPhoneToken( + userId: '<USER_ID>', + phone: '+12065550100', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-dart/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..be0a51448f --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-phone-verification.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +Token result = await account.createPhoneVerification(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-recovery.md b/docs/examples/1.6.x/server-dart/examples/account/create-recovery.md new file mode 100644 index 0000000000..51fa49ef29 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-recovery.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +Token result = await account.createRecovery( + email: 'email@example.com', + url: 'https://example.com', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-session.md b/docs/examples/1.6.x/server-dart/examples/account/create-session.md new file mode 100644 index 0000000000..654e6aaa1b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-session.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.createSession( + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-verification.md b/docs/examples/1.6.x/server-dart/examples/account/create-verification.md new file mode 100644 index 0000000000..c4fc88e9bf --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create-verification.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +Token result = await account.createVerification( + url: 'https://example.com', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create.md b/docs/examples/1.6.x/server-dart/examples/account/create.md new file mode 100644 index 0000000000..6f5e57fb03 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/create.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +User result = await account.create( + userId: '<USER_ID>', + email: 'email@example.com', + password: '', + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/delete-identity.md b/docs/examples/1.6.x/server-dart/examples/account/delete-identity.md new file mode 100644 index 0000000000..d42ac24541 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/delete-identity.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +await account.deleteIdentity( + identityId: '<IDENTITY_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-dart/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..1a5903f145 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +await account.deleteMfaAuthenticator( + type: AuthenticatorType.totp, +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/delete-session.md b/docs/examples/1.6.x/server-dart/examples/account/delete-session.md new file mode 100644 index 0000000000..5f5141af62 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/delete-session.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +await account.deleteSession( + sessionId: '<SESSION_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-dart/examples/account/delete-sessions.md new file mode 100644 index 0000000000..a545b5416c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/delete-sessions.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +await account.deleteSessions(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..0f174f8513 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +MfaRecoveryCodes result = await account.getMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/get-prefs.md b/docs/examples/1.6.x/server-dart/examples/account/get-prefs.md new file mode 100644 index 0000000000..5a65d67e67 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/get-prefs.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +Preferences result = await account.getPrefs(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/get-session.md b/docs/examples/1.6.x/server-dart/examples/account/get-session.md new file mode 100644 index 0000000000..848aecf23c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/get-session.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +Session result = await account.getSession( + sessionId: '<SESSION_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/get.md b/docs/examples/1.6.x/server-dart/examples/account/get.md new file mode 100644 index 0000000000..635203634a --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/get.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +User result = await account.get(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/list-identities.md b/docs/examples/1.6.x/server-dart/examples/account/list-identities.md new file mode 100644 index 0000000000..21bd264bd9 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/list-identities.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +IdentityList result = await account.listIdentities( + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/list-logs.md b/docs/examples/1.6.x/server-dart/examples/account/list-logs.md new file mode 100644 index 0000000000..754e89fce1 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/list-logs.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +LogList result = await account.listLogs( + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-dart/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..3da79444f7 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/list-mfa-factors.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +MfaFactors result = await account.listMfaFactors(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/list-sessions.md b/docs/examples/1.6.x/server-dart/examples/account/list-sessions.md new file mode 100644 index 0000000000..f444d7d2d0 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/list-sessions.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +SessionList result = await account.listSessions(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-email.md b/docs/examples/1.6.x/server-dart/examples/account/update-email.md new file mode 100644 index 0000000000..7defb487b3 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-email.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +User result = await account.updateEmail( + email: 'email@example.com', + password: 'password', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-dart/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..b7f4f491ba --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-m-f-a.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +User result = await account.updateMFA( + mfa: false, +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-dart/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..fe47afdb51 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.updateMagicURLSession( + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-dart/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..cf6beb4346 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-mfa-authenticator.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +User result = await account.updateMfaAuthenticator( + type: AuthenticatorType.totp, + otp: '<OTP>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-dart/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..c84520a744 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-mfa-challenge.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + + result = await account.updateMfaChallenge( + challengeId: '<CHALLENGE_ID>', + otp: '<OTP>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..1fe007c4ee --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +MfaRecoveryCodes result = await account.updateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-name.md b/docs/examples/1.6.x/server-dart/examples/account/update-name.md new file mode 100644 index 0000000000..742fb7a4d8 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-name.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +User result = await account.updateName( + name: '<NAME>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-password.md b/docs/examples/1.6.x/server-dart/examples/account/update-password.md new file mode 100644 index 0000000000..086dbb7185 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-password.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +User result = await account.updatePassword( + password: '', + oldPassword: 'password', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-dart/examples/account/update-phone-session.md new file mode 100644 index 0000000000..5ecc6e2a32 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-phone-session.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +Account account = Account(client); + +Session result = await account.updatePhoneSession( + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-dart/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..d729bf0c2f --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-phone-verification.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +Token result = await account.updatePhoneVerification( + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-phone.md b/docs/examples/1.6.x/server-dart/examples/account/update-phone.md new file mode 100644 index 0000000000..8dc0ef08a8 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-phone.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +User result = await account.updatePhone( + phone: '+12065550100', + password: 'password', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-prefs.md b/docs/examples/1.6.x/server-dart/examples/account/update-prefs.md new file mode 100644 index 0000000000..b53439fe9d --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-prefs.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +User result = await account.updatePrefs( + prefs: {}, +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-recovery.md b/docs/examples/1.6.x/server-dart/examples/account/update-recovery.md new file mode 100644 index 0000000000..5613e85c5c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-recovery.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +Token result = await account.updateRecovery( + userId: '<USER_ID>', + secret: '<SECRET>', + password: '', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-session.md b/docs/examples/1.6.x/server-dart/examples/account/update-session.md new file mode 100644 index 0000000000..c0a8bed918 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-session.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +Session result = await account.updateSession( + sessionId: '<SESSION_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-status.md b/docs/examples/1.6.x/server-dart/examples/account/update-status.md new file mode 100644 index 0000000000..3a19c84d9e --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-status.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +User result = await account.updateStatus(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-verification.md b/docs/examples/1.6.x/server-dart/examples/account/update-verification.md new file mode 100644 index 0000000000..95b5b3bfad --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/account/update-verification.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Account account = Account(client); + +Token result = await account.updateVerification( + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-browser.md new file mode 100644 index 0000000000..b145341d4a --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/avatars/get-browser.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Avatars avatars = Avatars(client); + +UInt8List result = await avatars.getBrowser( + code: Browser.avantBrowser, + width: 0, // (optional) + height: 0, // (optional) + quality: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..f2cec4f9af --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/avatars/get-credit-card.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Avatars avatars = Avatars(client); + +UInt8List result = await avatars.getCreditCard( + code: CreditCard.americanExpress, + width: 0, // (optional) + height: 0, // (optional) + quality: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..07f510d9d3 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/avatars/get-favicon.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Avatars avatars = Avatars(client); + +UInt8List result = await avatars.getFavicon( + url: 'https://example.com', +); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-flag.md new file mode 100644 index 0000000000..d4c170c121 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/avatars/get-flag.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Avatars avatars = Avatars(client); + +UInt8List result = await avatars.getFlag( + code: Flag.afghanistan, + width: 0, // (optional) + height: 0, // (optional) + quality: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-image.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-image.md new file mode 100644 index 0000000000..cdbe4770b0 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/avatars/get-image.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Avatars avatars = Avatars(client); + +UInt8List result = await avatars.getImage( + url: 'https://example.com', + width: 0, // (optional) + height: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-initials.md new file mode 100644 index 0000000000..dbe79cc4cb --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/avatars/get-initials.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Avatars avatars = Avatars(client); + +UInt8List result = await avatars.getInitials( + name: '<NAME>', // (optional) + width: 0, // (optional) + height: 0, // (optional) + background: '', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..693ad55dcc --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/avatars/get-q-r.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Avatars avatars = Avatars(client); + +UInt8List result = await avatars.getQR( + text: '<TEXT>', + size: 1, // (optional) + margin: 0, // (optional) + download: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..75e3a2c74c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-boolean-attribute.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeBoolean result = await databases.createBooleanAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + xdefault: false, // (optional) + array: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-collection.md b/docs/examples/1.6.x/server-dart/examples/databases/create-collection.md new file mode 100644 index 0000000000..860d6e4db3 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-collection.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +Collection result = await databases.createCollection( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + name: '<NAME>', + permissions: ["read("any")"], // (optional) + documentSecurity: false, // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..38fb373dd4 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-datetime-attribute.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeDatetime result = await databases.createDatetimeAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + xdefault: '', // (optional) + array: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-document.md b/docs/examples/1.6.x/server-dart/examples/databases/create-document.md new file mode 100644 index 0000000000..4867432c5b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-document.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Databases databases = Databases(client); + +Document result = await databases.createDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>', + data: {}, + permissions: ["read("any")"], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..caf11c20c2 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-email-attribute.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeEmail result = await databases.createEmailAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + xdefault: 'email@example.com', // (optional) + array: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..eeb050570c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-enum-attribute.md @@ -0,0 +1,18 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeEnum result = await databases.createEnumAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + elements: [], + xrequired: false, + xdefault: '<DEFAULT>', // (optional) + array: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..b735c49656 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-float-attribute.md @@ -0,0 +1,19 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeFloat result = await databases.createFloatAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + min: 0, // (optional) + max: 0, // (optional) + xdefault: 0, // (optional) + array: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-index.md b/docs/examples/1.6.x/server-dart/examples/databases/create-index.md new file mode 100644 index 0000000000..5350d0df23 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-index.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +Index result = await databases.createIndex( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + type: IndexType.key, + attributes: [], + orders: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..c0528bca98 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-integer-attribute.md @@ -0,0 +1,19 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeInteger result = await databases.createIntegerAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + min: 0, // (optional) + max: 0, // (optional) + xdefault: 0, // (optional) + array: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..ebe5361113 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-ip-attribute.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeIp result = await databases.createIpAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + xdefault: '', // (optional) + array: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..24f9681fc5 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-relationship-attribute.md @@ -0,0 +1,19 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeRelationship result = await databases.createRelationshipAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + relatedCollectionId: '<RELATED_COLLECTION_ID>', + type: RelationshipType.oneToOne, + twoWay: false, // (optional) + key: '', // (optional) + twoWayKey: '', // (optional) + onDelete: RelationMutate.cascade, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..30ecaa0ef5 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-string-attribute.md @@ -0,0 +1,19 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeString result = await databases.createStringAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + size: 1, + xrequired: false, + xdefault: '<DEFAULT>', // (optional) + array: false, // (optional) + encrypt: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..530ff80f03 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create-url-attribute.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeUrl result = await databases.createUrlAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + xdefault: 'https://example.com', // (optional) + array: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create.md b/docs/examples/1.6.x/server-dart/examples/databases/create.md new file mode 100644 index 0000000000..e59c6c8a98 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/create.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +Database result = await databases.create( + databaseId: '<DATABASE_ID>', + name: '<NAME>', + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..264dac1c2b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/delete-attribute.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +await databases.deleteAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-dart/examples/databases/delete-collection.md new file mode 100644 index 0000000000..c4532a4705 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/delete-collection.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +await databases.deleteCollection( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/delete-document.md b/docs/examples/1.6.x/server-dart/examples/databases/delete-document.md new file mode 100644 index 0000000000..b9745650d2 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/delete-document.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Databases databases = Databases(client); + +await databases.deleteDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/delete-index.md b/docs/examples/1.6.x/server-dart/examples/databases/delete-index.md new file mode 100644 index 0000000000..5c1e6196f0 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/delete-index.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +await databases.deleteIndex( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/delete.md b/docs/examples/1.6.x/server-dart/examples/databases/delete.md new file mode 100644 index 0000000000..9cf51c982f --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/delete.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +await databases.delete( + databaseId: '<DATABASE_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/get-attribute.md new file mode 100644 index 0000000000..fdfd2d0379 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/get-attribute.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + + result = await databases.getAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/get-collection.md b/docs/examples/1.6.x/server-dart/examples/databases/get-collection.md new file mode 100644 index 0000000000..36c10dfdda --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/get-collection.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +Collection result = await databases.getCollection( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/get-document.md b/docs/examples/1.6.x/server-dart/examples/databases/get-document.md new file mode 100644 index 0000000000..1af05af08f --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/get-document.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Databases databases = Databases(client); + +Document result = await databases.getDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>', + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/get-index.md b/docs/examples/1.6.x/server-dart/examples/databases/get-index.md new file mode 100644 index 0000000000..634d5e1407 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/get-index.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +Index result = await databases.getIndex( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/get.md b/docs/examples/1.6.x/server-dart/examples/databases/get.md new file mode 100644 index 0000000000..e2bd07899e --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/get.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +Database result = await databases.get( + databaseId: '<DATABASE_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-dart/examples/databases/list-attributes.md new file mode 100644 index 0000000000..a36d4a3912 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/list-attributes.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeList result = await databases.listAttributes( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/list-collections.md b/docs/examples/1.6.x/server-dart/examples/databases/list-collections.md new file mode 100644 index 0000000000..5d34294848 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/list-collections.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +CollectionList result = await databases.listCollections( + databaseId: '<DATABASE_ID>', + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/list-documents.md b/docs/examples/1.6.x/server-dart/examples/databases/list-documents.md new file mode 100644 index 0000000000..91df920f54 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/list-documents.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Databases databases = Databases(client); + +DocumentList result = await databases.listDocuments( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-dart/examples/databases/list-indexes.md new file mode 100644 index 0000000000..c45e542c12 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/list-indexes.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +IndexList result = await databases.listIndexes( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/list.md b/docs/examples/1.6.x/server-dart/examples/databases/list.md new file mode 100644 index 0000000000..674994c669 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/list.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +DatabaseList result = await databases.list( + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..8654edd0dd --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-boolean-attribute.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeBoolean result = await databases.updateBooleanAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + xdefault: false, +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-collection.md b/docs/examples/1.6.x/server-dart/examples/databases/update-collection.md new file mode 100644 index 0000000000..8af12c2e09 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-collection.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +Collection result = await databases.updateCollection( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + name: '<NAME>', + permissions: ["read("any")"], // (optional) + documentSecurity: false, // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..6a91f4d624 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-datetime-attribute.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeDatetime result = await databases.updateDatetimeAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + xdefault: '', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-document.md b/docs/examples/1.6.x/server-dart/examples/databases/update-document.md new file mode 100644 index 0000000000..d4c442bd5e --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-document.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Databases databases = Databases(client); + +Document result = await databases.updateDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>', + data: {}, // (optional) + permissions: ["read("any")"], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..1d2b0f8302 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-email-attribute.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeEmail result = await databases.updateEmailAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + xdefault: 'email@example.com', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..e37cd64b2d --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-enum-attribute.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeEnum result = await databases.updateEnumAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + elements: [], + xrequired: false, + xdefault: '<DEFAULT>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..fd4f56b0b5 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-float-attribute.md @@ -0,0 +1,18 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeFloat result = await databases.updateFloatAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + min: 0, + max: 0, + xdefault: 0, +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..5fa3a7c974 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-integer-attribute.md @@ -0,0 +1,18 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeInteger result = await databases.updateIntegerAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + min: 0, + max: 0, + xdefault: 0, +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..31a3045159 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-ip-attribute.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeIp result = await databases.updateIpAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + xdefault: '', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..7bb811720f --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-relationship-attribute.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeRelationship result = await databases.updateRelationshipAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + onDelete: RelationMutate.cascade, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..72519d8ad0 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-string-attribute.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeString result = await databases.updateStringAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + xdefault: '<DEFAULT>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..cb9959dc1b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update-url-attribute.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +AttributeUrl result = await databases.updateUrlAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + xrequired: false, + xdefault: 'https://example.com', +); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update.md b/docs/examples/1.6.x/server-dart/examples/databases/update.md new file mode 100644 index 0000000000..403c21dfb4 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/databases/update.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Databases databases = Databases(client); + +Database result = await databases.update( + databaseId: '<DATABASE_ID>', + name: '<NAME>', + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/create-build.md b/docs/examples/1.6.x/server-dart/examples/functions/create-build.md new file mode 100644 index 0000000000..11f927d04e --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/create-build.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + + result = await functions.createBuild( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>', + buildId: '<BUILD_ID>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-dart/examples/functions/create-deployment.md new file mode 100644 index 0000000000..2900c45901 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/create-deployment.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +Deployment result = await functions.createDeployment( + functionId: '<FUNCTION_ID>', + code: InputFile(path: './path-to-files/image.jpg', filename: 'image.jpg'), + activate: false, + entrypoint: '<ENTRYPOINT>', // (optional) + commands: '<COMMANDS>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/create-execution.md b/docs/examples/1.6.x/server-dart/examples/functions/create-execution.md new file mode 100644 index 0000000000..4ff0835b3b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/create-execution.md @@ -0,0 +1,18 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Functions functions = Functions(client); + +Execution result = await functions.createExecution( + functionId: '<FUNCTION_ID>', + body: '<BODY>', // (optional) + xasync: false, // (optional) + path: '<PATH>', // (optional) + method: ExecutionMethod.gET, // (optional) + headers: {}, // (optional) + scheduledAt: '', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/create-variable.md b/docs/examples/1.6.x/server-dart/examples/functions/create-variable.md new file mode 100644 index 0000000000..51250999e8 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/create-variable.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +Variable result = await functions.createVariable( + functionId: '<FUNCTION_ID>', + key: '<KEY>', + value: '<VALUE>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/create.md b/docs/examples/1.6.x/server-dart/examples/functions/create.md new file mode 100644 index 0000000000..8991cbca5c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/create.md @@ -0,0 +1,32 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +Func result = await functions.create( + functionId: '<FUNCTION_ID>', + name: '<NAME>', + runtime: .node145, + execute: ["any"], // (optional) + events: [], // (optional) + schedule: '', // (optional) + timeout: 1, // (optional) + enabled: false, // (optional) + logging: false, // (optional) + entrypoint: '<ENTRYPOINT>', // (optional) + commands: '<COMMANDS>', // (optional) + scopes: [], // (optional) + installationId: '<INSTALLATION_ID>', // (optional) + providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // (optional) + providerBranch: '<PROVIDER_BRANCH>', // (optional) + providerSilentMode: false, // (optional) + providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // (optional) + templateRepository: '<TEMPLATE_REPOSITORY>', // (optional) + templateOwner: '<TEMPLATE_OWNER>', // (optional) + templateRootDirectory: '<TEMPLATE_ROOT_DIRECTORY>', // (optional) + templateBranch: '<TEMPLATE_BRANCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-dart/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..b67a598806 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/delete-deployment.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +await functions.deleteDeployment( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-dart/examples/functions/delete-execution.md new file mode 100644 index 0000000000..a976cc6dec --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/delete-execution.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +await functions.deleteExecution( + functionId: '<FUNCTION_ID>', + executionId: '<EXECUTION_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-dart/examples/functions/delete-variable.md new file mode 100644 index 0000000000..38779c6609 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/delete-variable.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +await functions.deleteVariable( + functionId: '<FUNCTION_ID>', + variableId: '<VARIABLE_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/delete.md b/docs/examples/1.6.x/server-dart/examples/functions/delete.md new file mode 100644 index 0000000000..2f73b8196b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/delete.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +await functions.delete( + functionId: '<FUNCTION_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-dart/examples/functions/download-deployment.md new file mode 100644 index 0000000000..e5d5de36a8 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/download-deployment.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +UInt8List result = await functions.downloadDeployment( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-dart/examples/functions/get-deployment.md new file mode 100644 index 0000000000..69f9bb0422 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/get-deployment.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +Deployment result = await functions.getDeployment( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/get-execution.md b/docs/examples/1.6.x/server-dart/examples/functions/get-execution.md new file mode 100644 index 0000000000..3348df992f --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/get-execution.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Functions functions = Functions(client); + +Execution result = await functions.getExecution( + functionId: '<FUNCTION_ID>', + executionId: '<EXECUTION_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/get-variable.md b/docs/examples/1.6.x/server-dart/examples/functions/get-variable.md new file mode 100644 index 0000000000..98c28c331d --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/get-variable.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +Variable result = await functions.getVariable( + functionId: '<FUNCTION_ID>', + variableId: '<VARIABLE_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/get.md b/docs/examples/1.6.x/server-dart/examples/functions/get.md new file mode 100644 index 0000000000..9072f1f641 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/get.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +Func result = await functions.get( + functionId: '<FUNCTION_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-dart/examples/functions/list-deployments.md new file mode 100644 index 0000000000..613c55db2e --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/list-deployments.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +DeploymentList result = await functions.listDeployments( + functionId: '<FUNCTION_ID>', + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/list-executions.md b/docs/examples/1.6.x/server-dart/examples/functions/list-executions.md new file mode 100644 index 0000000000..13a3a46333 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/list-executions.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Functions functions = Functions(client); + +ExecutionList result = await functions.listExecutions( + functionId: '<FUNCTION_ID>', + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-dart/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..e5dbabc896 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/list-runtimes.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +RuntimeList result = await functions.listRuntimes(); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/list-variables.md b/docs/examples/1.6.x/server-dart/examples/functions/list-variables.md new file mode 100644 index 0000000000..bb3f780b28 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/list-variables.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +VariableList result = await functions.listVariables( + functionId: '<FUNCTION_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/list.md b/docs/examples/1.6.x/server-dart/examples/functions/list.md new file mode 100644 index 0000000000..e4cf5ad78c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/list.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +FunctionList result = await functions.list( + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-dart/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..955fcf857c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/update-deployment-build.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +Build result = await functions.updateDeploymentBuild( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-dart/examples/functions/update-deployment.md new file mode 100644 index 0000000000..5ae6dd955b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/update-deployment.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +Func result = await functions.updateDeployment( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/update-variable.md b/docs/examples/1.6.x/server-dart/examples/functions/update-variable.md new file mode 100644 index 0000000000..eafc5528b8 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/update-variable.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +Variable result = await functions.updateVariable( + functionId: '<FUNCTION_ID>', + variableId: '<VARIABLE_ID>', + key: '<KEY>', + value: '<VALUE>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/update.md b/docs/examples/1.6.x/server-dart/examples/functions/update.md new file mode 100644 index 0000000000..075763333b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/functions/update.md @@ -0,0 +1,28 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Functions functions = Functions(client); + +Func result = await functions.update( + functionId: '<FUNCTION_ID>', + name: '<NAME>', + runtime: .node145, // (optional) + execute: ["any"], // (optional) + events: [], // (optional) + schedule: '', // (optional) + timeout: 1, // (optional) + enabled: false, // (optional) + logging: false, // (optional) + entrypoint: '<ENTRYPOINT>', // (optional) + commands: '<COMMANDS>', // (optional) + scopes: [], // (optional) + installationId: '<INSTALLATION_ID>', // (optional) + providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // (optional) + providerBranch: '<PROVIDER_BRANCH>', // (optional) + providerSilentMode: false, // (optional) + providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/graphql/mutation.md b/docs/examples/1.6.x/server-dart/examples/graphql/mutation.md new file mode 100644 index 0000000000..e29dce1af9 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/graphql/mutation.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Graphql graphql = Graphql(client); + +Any result = await graphql.mutation( + query: {}, +); diff --git a/docs/examples/1.6.x/server-dart/examples/graphql/query.md b/docs/examples/1.6.x/server-dart/examples/graphql/query.md new file mode 100644 index 0000000000..808176e88d --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/graphql/query.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Graphql graphql = Graphql(client); + +Any result = await graphql.query( + query: {}, +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-dart/examples/health/get-antivirus.md new file mode 100644 index 0000000000..e5867032b4 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-antivirus.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthAntivirus result = await health.getAntivirus(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-cache.md b/docs/examples/1.6.x/server-dart/examples/health/get-cache.md new file mode 100644 index 0000000000..04a316da51 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-cache.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthStatus result = await health.getCache(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-certificate.md b/docs/examples/1.6.x/server-dart/examples/health/get-certificate.md new file mode 100644 index 0000000000..4faf20df5c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-certificate.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthCertificate result = await health.getCertificate( + domain: '', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-d-b.md b/docs/examples/1.6.x/server-dart/examples/health/get-d-b.md new file mode 100644 index 0000000000..2750e695b3 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-d-b.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthStatus result = await health.getDB(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-dart/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..3d4e2b7559 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-failed-jobs.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getFailedJobs( + name: .v1Database, + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-dart/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..eeac613b80 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-pub-sub.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthStatus result = await health.getPubSub(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..e234bba6f1 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-builds.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueBuilds( + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..1de734af76 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-certificates.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueCertificates( + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..ba62b5ec64 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-databases.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueDatabases( + name: '<NAME>', // (optional) + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..f5dc69727c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-deletes.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueDeletes( + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..febdbee581 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-functions.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueFunctions( + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..de4e3e6ac4 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-logs.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueLogs( + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..52ed24dd7e --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-mails.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueMails( + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..62d5aa73be --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-messaging.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueMessaging( + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..97ee00ea6e --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-migrations.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueMigrations( + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..bd40162940 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage-dump.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueUsageDump( + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..126e16a732 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueUsage( + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..cff783564b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue-webhooks.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthQueue result = await health.getQueueWebhooks( + threshold: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue.md new file mode 100644 index 0000000000..c856504af4 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-queue.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthStatus result = await health.getQueue(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-dart/examples/health/get-storage-local.md new file mode 100644 index 0000000000..421ebe9822 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-storage-local.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthStatus result = await health.getStorageLocal(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-storage.md b/docs/examples/1.6.x/server-dart/examples/health/get-storage.md new file mode 100644 index 0000000000..bcbec9c652 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-storage.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthStatus result = await health.getStorage(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-time.md b/docs/examples/1.6.x/server-dart/examples/health/get-time.md new file mode 100644 index 0000000000..a68ec49156 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get-time.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthTime result = await health.getTime(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get.md b/docs/examples/1.6.x/server-dart/examples/health/get.md new file mode 100644 index 0000000000..6288d666ee --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/health/get.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Health health = Health(client); + +HealthStatus result = await health.get(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/get.md b/docs/examples/1.6.x/server-dart/examples/locale/get.md new file mode 100644 index 0000000000..acc3c4dd1c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/locale/get.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Locale locale = Locale(client); + +Locale result = await locale.get(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-codes.md b/docs/examples/1.6.x/server-dart/examples/locale/list-codes.md new file mode 100644 index 0000000000..9e7420284c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/locale/list-codes.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Locale locale = Locale(client); + +LocaleCodeList result = await locale.listCodes(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-continents.md b/docs/examples/1.6.x/server-dart/examples/locale/list-continents.md new file mode 100644 index 0000000000..3320937649 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/locale/list-continents.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Locale locale = Locale(client); + +ContinentList result = await locale.listContinents(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-dart/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..9a66b08158 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/locale/list-countries-e-u.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Locale locale = Locale(client); + +CountryList result = await locale.listCountriesEU(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-dart/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..35098e0ff3 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/locale/list-countries-phones.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Locale locale = Locale(client); + +PhoneList result = await locale.listCountriesPhones(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-countries.md b/docs/examples/1.6.x/server-dart/examples/locale/list-countries.md new file mode 100644 index 0000000000..d11b4c42b5 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/locale/list-countries.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Locale locale = Locale(client); + +CountryList result = await locale.listCountries(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-dart/examples/locale/list-currencies.md new file mode 100644 index 0000000000..4701ce9a81 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/locale/list-currencies.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Locale locale = Locale(client); + +CurrencyList result = await locale.listCurrencies(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-languages.md b/docs/examples/1.6.x/server-dart/examples/locale/list-languages.md new file mode 100644 index 0000000000..e5d52b3ee8 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/locale/list-languages.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Locale locale = Locale(client); + +LanguageList result = await locale.listLanguages(); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..db7672ddc7 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-apns-provider.md @@ -0,0 +1,19 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.createApnsProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + authKey: '<AUTH_KEY>', // (optional) + authKeyId: '<AUTH_KEY_ID>', // (optional) + teamId: '<TEAM_ID>', // (optional) + bundleId: '<BUNDLE_ID>', // (optional) + sandbox: false, // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-email.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-email.md new file mode 100644 index 0000000000..26fda3eeab --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-email.md @@ -0,0 +1,23 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Message result = await messaging.createEmail( + messageId: '<MESSAGE_ID>', + subject: '<SUBJECT>', + content: '<CONTENT>', + topics: [], // (optional) + users: [], // (optional) + targets: [], // (optional) + cc: [], // (optional) + bcc: [], // (optional) + attachments: [], // (optional) + draft: false, // (optional) + html: false, // (optional) + scheduledAt: '', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..f02b5b6df7 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-fcm-provider.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.createFcmProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + serviceAccountJSON: {}, // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..4161d5263c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,21 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.createMailgunProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + apiKey: '<API_KEY>', // (optional) + domain: '<DOMAIN>', // (optional) + isEuRegion: false, // (optional) + fromName: '<FROM_NAME>', // (optional) + fromEmail: 'email@example.com', // (optional) + replyToName: '<REPLY_TO_NAME>', // (optional) + replyToEmail: 'email@example.com', // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..ed8b24b6a5 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-msg91provider.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.createMsg91Provider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + templateId: '<TEMPLATE_ID>', // (optional) + senderId: '<SENDER_ID>', // (optional) + authKey: '<AUTH_KEY>', // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-push.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-push.md new file mode 100644 index 0000000000..3e6f5ac4c7 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-push.md @@ -0,0 +1,27 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Message result = await messaging.createPush( + messageId: '<MESSAGE_ID>', + title: '<TITLE>', + body: '<BODY>', + topics: [], // (optional) + users: [], // (optional) + targets: [], // (optional) + data: {}, // (optional) + action: '<ACTION>', // (optional) + image: '[ID1:ID2]', // (optional) + icon: '<ICON>', // (optional) + sound: '<SOUND>', // (optional) + color: '<COLOR>', // (optional) + tag: '<TAG>', // (optional) + badge: '<BADGE>', // (optional) + draft: false, // (optional) + scheduledAt: '', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..9bf683cd9e --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,19 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.createSendgridProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + apiKey: '<API_KEY>', // (optional) + fromName: '<FROM_NAME>', // (optional) + fromEmail: 'email@example.com', // (optional) + replyToName: '<REPLY_TO_NAME>', // (optional) + replyToEmail: 'email@example.com', // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-sms.md new file mode 100644 index 0000000000..7c4bdb84c4 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-sms.md @@ -0,0 +1,18 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Message result = await messaging.createSms( + messageId: '<MESSAGE_ID>', + content: '<CONTENT>', + topics: [], // (optional) + users: [], // (optional) + targets: [], // (optional) + draft: false, // (optional) + scheduledAt: '', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..3125fbe685 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-smtp-provider.md @@ -0,0 +1,25 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.createSmtpProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + host: '<HOST>', + port: 1, // (optional) + username: '<USERNAME>', // (optional) + password: '<PASSWORD>', // (optional) + encryption: SmtpEncryption.none, // (optional) + autoTLS: false, // (optional) + mailer: '<MAILER>', // (optional) + fromName: '<FROM_NAME>', // (optional) + fromEmail: 'email@example.com', // (optional) + replyToName: '<REPLY_TO_NAME>', // (optional) + replyToEmail: 'email@example.com', // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..ff5291c940 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-subscriber.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token + +Messaging messaging = Messaging(client); + +Subscriber result = await messaging.createSubscriber( + topicId: '<TOPIC_ID>', + subscriberId: '<SUBSCRIBER_ID>', + targetId: '<TARGET_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..dd66f12ac3 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-telesign-provider.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.createTelesignProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', // (optional) + customerId: '<CUSTOMER_ID>', // (optional) + apiKey: '<API_KEY>', // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..0c4f9ea774 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.createTextmagicProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', // (optional) + username: '<USERNAME>', // (optional) + apiKey: '<API_KEY>', // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-topic.md new file mode 100644 index 0000000000..8cadab11af --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-topic.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Topic result = await messaging.createTopic( + topicId: '<TOPIC_ID>', + name: '<NAME>', + subscribe: ["any"], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..625cd5fcd0 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-twilio-provider.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.createTwilioProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', // (optional) + accountSid: '<ACCOUNT_SID>', // (optional) + authToken: '<AUTH_TOKEN>', // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..5b80c50c1c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/create-vonage-provider.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.createVonageProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', // (optional) + apiKey: '<API_KEY>', // (optional) + apiSecret: '<API_SECRET>', // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..927ae2bfae --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/delete-provider.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +await messaging.deleteProvider( + providerId: '<PROVIDER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-dart/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..7b2b833d01 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/delete-subscriber.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token + +Messaging messaging = Messaging(client); + +await messaging.deleteSubscriber( + topicId: '<TOPIC_ID>', + subscriberId: '<SUBSCRIBER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-dart/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..4947637a94 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/delete-topic.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +await messaging.deleteTopic( + topicId: '<TOPIC_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/delete.md b/docs/examples/1.6.x/server-dart/examples/messaging/delete.md new file mode 100644 index 0000000000..743a4b629f --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/delete.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +await messaging.delete( + messageId: '<MESSAGE_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/get-message.md b/docs/examples/1.6.x/server-dart/examples/messaging/get-message.md new file mode 100644 index 0000000000..987f0f7a1c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/get-message.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Message result = await messaging.getMessage( + messageId: '<MESSAGE_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/get-provider.md new file mode 100644 index 0000000000..1154897d81 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/get-provider.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.getProvider( + providerId: '<PROVIDER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-dart/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..358a6d0ea0 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/get-subscriber.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Subscriber result = await messaging.getSubscriber( + topicId: '<TOPIC_ID>', + subscriberId: '<SUBSCRIBER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-dart/examples/messaging/get-topic.md new file mode 100644 index 0000000000..28d79fbb99 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/get-topic.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Topic result = await messaging.getTopic( + topicId: '<TOPIC_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..5c9ec2ec93 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/list-message-logs.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +LogList result = await messaging.listMessageLogs( + messageId: '<MESSAGE_ID>', + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-messages.md new file mode 100644 index 0000000000..d99f21ffa6 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/list-messages.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +MessageList result = await messaging.listMessages( + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..acabb4eb15 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/list-provider-logs.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +LogList result = await messaging.listProviderLogs( + providerId: '<PROVIDER_ID>', + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-providers.md new file mode 100644 index 0000000000..d8e076681d --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/list-providers.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +ProviderList result = await messaging.listProviders( + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..bf25d498fe --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +LogList result = await messaging.listSubscriberLogs( + subscriberId: '<SUBSCRIBER_ID>', + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..ec3b078397 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/list-subscribers.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +SubscriberList result = await messaging.listSubscribers( + topicId: '<TOPIC_ID>', + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-targets.md new file mode 100644 index 0000000000..278272b45f --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/list-targets.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +TargetList result = await messaging.listTargets( + messageId: '<MESSAGE_ID>', + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..85d054061d --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/list-topic-logs.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +LogList result = await messaging.listTopicLogs( + topicId: '<TOPIC_ID>', + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-topics.md new file mode 100644 index 0000000000..425b2979ea --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/list-topics.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +TopicList result = await messaging.listTopics( + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..0920513373 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-apns-provider.md @@ -0,0 +1,19 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.updateApnsProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // (optional) + enabled: false, // (optional) + authKey: '<AUTH_KEY>', // (optional) + authKeyId: '<AUTH_KEY_ID>', // (optional) + teamId: '<TEAM_ID>', // (optional) + bundleId: '<BUNDLE_ID>', // (optional) + sandbox: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-email.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-email.md new file mode 100644 index 0000000000..3fdebac380 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-email.md @@ -0,0 +1,23 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Message result = await messaging.updateEmail( + messageId: '<MESSAGE_ID>', + topics: [], // (optional) + users: [], // (optional) + targets: [], // (optional) + subject: '<SUBJECT>', // (optional) + content: '<CONTENT>', // (optional) + draft: false, // (optional) + html: false, // (optional) + cc: [], // (optional) + bcc: [], // (optional) + scheduledAt: '', // (optional) + attachments: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..9404d5951b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-fcm-provider.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.updateFcmProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // (optional) + enabled: false, // (optional) + serviceAccountJSON: {}, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..be806274ea --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,21 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.updateMailgunProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // (optional) + apiKey: '<API_KEY>', // (optional) + domain: '<DOMAIN>', // (optional) + isEuRegion: false, // (optional) + enabled: false, // (optional) + fromName: '<FROM_NAME>', // (optional) + fromEmail: 'email@example.com', // (optional) + replyToName: '<REPLY_TO_NAME>', // (optional) + replyToEmail: '<REPLY_TO_EMAIL>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..4c86428c43 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-msg91provider.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.updateMsg91Provider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // (optional) + enabled: false, // (optional) + templateId: '<TEMPLATE_ID>', // (optional) + senderId: '<SENDER_ID>', // (optional) + authKey: '<AUTH_KEY>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-push.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-push.md new file mode 100644 index 0000000000..fee14c76e3 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-push.md @@ -0,0 +1,27 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Message result = await messaging.updatePush( + messageId: '<MESSAGE_ID>', + topics: [], // (optional) + users: [], // (optional) + targets: [], // (optional) + title: '<TITLE>', // (optional) + body: '<BODY>', // (optional) + data: {}, // (optional) + action: '<ACTION>', // (optional) + image: '[ID1:ID2]', // (optional) + icon: '<ICON>', // (optional) + sound: '<SOUND>', // (optional) + color: '<COLOR>', // (optional) + tag: '<TAG>', // (optional) + badge: 0, // (optional) + draft: false, // (optional) + scheduledAt: '', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..7a762a66b5 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,19 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.updateSendgridProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // (optional) + enabled: false, // (optional) + apiKey: '<API_KEY>', // (optional) + fromName: '<FROM_NAME>', // (optional) + fromEmail: 'email@example.com', // (optional) + replyToName: '<REPLY_TO_NAME>', // (optional) + replyToEmail: '<REPLY_TO_EMAIL>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-sms.md new file mode 100644 index 0000000000..4eda4c51c0 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-sms.md @@ -0,0 +1,18 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Message result = await messaging.updateSms( + messageId: '<MESSAGE_ID>', + topics: [], // (optional) + users: [], // (optional) + targets: [], // (optional) + content: '<CONTENT>', // (optional) + draft: false, // (optional) + scheduledAt: '', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..f0b53d23c4 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-smtp-provider.md @@ -0,0 +1,25 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.updateSmtpProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // (optional) + host: '<HOST>', // (optional) + port: 1, // (optional) + username: '<USERNAME>', // (optional) + password: '<PASSWORD>', // (optional) + encryption: SmtpEncryption.none, // (optional) + autoTLS: false, // (optional) + mailer: '<MAILER>', // (optional) + fromName: '<FROM_NAME>', // (optional) + fromEmail: 'email@example.com', // (optional) + replyToName: '<REPLY_TO_NAME>', // (optional) + replyToEmail: '<REPLY_TO_EMAIL>', // (optional) + enabled: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..6465a68d90 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-telesign-provider.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.updateTelesignProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // (optional) + enabled: false, // (optional) + customerId: '<CUSTOMER_ID>', // (optional) + apiKey: '<API_KEY>', // (optional) + from: '<FROM>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..4f030e7087 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.updateTextmagicProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // (optional) + enabled: false, // (optional) + username: '<USERNAME>', // (optional) + apiKey: '<API_KEY>', // (optional) + from: '<FROM>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-topic.md new file mode 100644 index 0000000000..ba4289ae59 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-topic.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Topic result = await messaging.updateTopic( + topicId: '<TOPIC_ID>', + name: '<NAME>', // (optional) + subscribe: ["any"], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..b0c6d976ec --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-twilio-provider.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.updateTwilioProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // (optional) + enabled: false, // (optional) + accountSid: '<ACCOUNT_SID>', // (optional) + authToken: '<AUTH_TOKEN>', // (optional) + from: '<FROM>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..0171ec154f --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/messaging/update-vonage-provider.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Messaging messaging = Messaging(client); + +Provider result = await messaging.updateVonageProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // (optional) + enabled: false, // (optional) + apiKey: '<API_KEY>', // (optional) + apiSecret: '<API_SECRET>', // (optional) + from: '<FROM>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-dart/examples/storage/create-bucket.md new file mode 100644 index 0000000000..eb8abbd76c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/create-bucket.md @@ -0,0 +1,21 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Storage storage = Storage(client); + +Bucket result = await storage.createBucket( + bucketId: '<BUCKET_ID>', + name: '<NAME>', + permissions: ["read("any")"], // (optional) + fileSecurity: false, // (optional) + enabled: false, // (optional) + maximumFileSize: 1, // (optional) + allowedFileExtensions: [], // (optional) + compression: .none, // (optional) + encryption: false, // (optional) + antivirus: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/create-file.md b/docs/examples/1.6.x/server-dart/examples/storage/create-file.md new file mode 100644 index 0000000000..7f08a98417 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/create-file.md @@ -0,0 +1,16 @@ +import 'dart:io'; +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Storage storage = Storage(client); + +File result = await storage.createFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', + file: InputFile(path: './path-to-files/image.jpg', filename: 'image.jpg'), + permissions: ["read("any")"], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-dart/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..07ec35c999 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/delete-bucket.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Storage storage = Storage(client); + +await storage.deleteBucket( + bucketId: '<BUCKET_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/delete-file.md b/docs/examples/1.6.x/server-dart/examples/storage/delete-file.md new file mode 100644 index 0000000000..fddfd66711 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/delete-file.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Storage storage = Storage(client); + +await storage.deleteFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-dart/examples/storage/get-bucket.md new file mode 100644 index 0000000000..2b4ec732c1 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/get-bucket.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Storage storage = Storage(client); + +Bucket result = await storage.getBucket( + bucketId: '<BUCKET_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-dart/examples/storage/get-file-download.md new file mode 100644 index 0000000000..de30bf50d7 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/get-file-download.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Storage storage = Storage(client); + +UInt8List result = await storage.getFileDownload( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-dart/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..f36af81b23 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/get-file-preview.md @@ -0,0 +1,24 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Storage storage = Storage(client); + +UInt8List result = await storage.getFilePreview( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', + width: 0, // (optional) + height: 0, // (optional) + gravity: ImageGravity.center, // (optional) + quality: 0, // (optional) + borderWidth: 0, // (optional) + borderColor: '', // (optional) + borderRadius: 0, // (optional) + opacity: 0, // (optional) + rotation: -360, // (optional) + background: '', // (optional) + output: ImageFormat.jpg, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-dart/examples/storage/get-file-view.md new file mode 100644 index 0000000000..ad64c168a0 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/get-file-view.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Storage storage = Storage(client); + +UInt8List result = await storage.getFileView( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/get-file.md b/docs/examples/1.6.x/server-dart/examples/storage/get-file.md new file mode 100644 index 0000000000..3255043228 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/get-file.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Storage storage = Storage(client); + +File result = await storage.getFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-dart/examples/storage/list-buckets.md new file mode 100644 index 0000000000..1f5040a77d --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/list-buckets.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Storage storage = Storage(client); + +BucketList result = await storage.listBuckets( + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/list-files.md b/docs/examples/1.6.x/server-dart/examples/storage/list-files.md new file mode 100644 index 0000000000..b5a1261d78 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/list-files.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Storage storage = Storage(client); + +FileList result = await storage.listFiles( + bucketId: '<BUCKET_ID>', + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-dart/examples/storage/update-bucket.md new file mode 100644 index 0000000000..04f76d041c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/update-bucket.md @@ -0,0 +1,21 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Storage storage = Storage(client); + +Bucket result = await storage.updateBucket( + bucketId: '<BUCKET_ID>', + name: '<NAME>', + permissions: ["read("any")"], // (optional) + fileSecurity: false, // (optional) + enabled: false, // (optional) + maximumFileSize: 1, // (optional) + allowedFileExtensions: [], // (optional) + compression: .none, // (optional) + encryption: false, // (optional) + antivirus: false, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/update-file.md b/docs/examples/1.6.x/server-dart/examples/storage/update-file.md new file mode 100644 index 0000000000..5ddabb9857 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/storage/update-file.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Storage storage = Storage(client); + +File result = await storage.updateFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', + name: '<NAME>', // (optional) + permissions: ["read("any")"], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/create-membership.md b/docs/examples/1.6.x/server-dart/examples/teams/create-membership.md new file mode 100644 index 0000000000..1faf629af5 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/create-membership.md @@ -0,0 +1,18 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +Membership result = await teams.createMembership( + teamId: '<TEAM_ID>', + roles: [], + email: 'email@example.com', // (optional) + userId: '<USER_ID>', // (optional) + phone: '+12065550100', // (optional) + url: 'https://example.com', // (optional) + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/create.md b/docs/examples/1.6.x/server-dart/examples/teams/create.md new file mode 100644 index 0000000000..653d800458 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/create.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +Team result = await teams.create( + teamId: '<TEAM_ID>', + name: '<NAME>', + roles: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-dart/examples/teams/delete-membership.md new file mode 100644 index 0000000000..15752a809c --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/delete-membership.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +await teams.deleteMembership( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/delete.md b/docs/examples/1.6.x/server-dart/examples/teams/delete.md new file mode 100644 index 0000000000..7017893ce2 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/delete.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +await teams.delete( + teamId: '<TEAM_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/get-membership.md b/docs/examples/1.6.x/server-dart/examples/teams/get-membership.md new file mode 100644 index 0000000000..06a3fc141b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/get-membership.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +Membership result = await teams.getMembership( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-dart/examples/teams/get-prefs.md new file mode 100644 index 0000000000..2af7475606 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/get-prefs.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +Preferences result = await teams.getPrefs( + teamId: '<TEAM_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/get.md b/docs/examples/1.6.x/server-dart/examples/teams/get.md new file mode 100644 index 0000000000..b086b06851 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/get.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +Team result = await teams.get( + teamId: '<TEAM_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-dart/examples/teams/list-memberships.md new file mode 100644 index 0000000000..4cf83235c0 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/list-memberships.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +MembershipList result = await teams.listMemberships( + teamId: '<TEAM_ID>', + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/list.md b/docs/examples/1.6.x/server-dart/examples/teams/list.md new file mode 100644 index 0000000000..51af7d3f56 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/list.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +TeamList result = await teams.list( + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-dart/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..9571193aa7 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/update-membership-status.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +Membership result = await teams.updateMembershipStatus( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>', + userId: '<USER_ID>', + secret: '<SECRET>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/update-membership.md b/docs/examples/1.6.x/server-dart/examples/teams/update-membership.md new file mode 100644 index 0000000000..fd2f4586e9 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/update-membership.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +Membership result = await teams.updateMembership( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>', + roles: [], +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/update-name.md b/docs/examples/1.6.x/server-dart/examples/teams/update-name.md new file mode 100644 index 0000000000..b795063073 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/update-name.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +Team result = await teams.updateName( + teamId: '<TEAM_ID>', + name: '<NAME>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-dart/examples/teams/update-prefs.md new file mode 100644 index 0000000000..434ffb9679 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/teams/update-prefs.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +Teams teams = Teams(client); + +Preferences result = await teams.updatePrefs( + teamId: '<TEAM_ID>', + prefs: {}, +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-dart/examples/users/create-argon2user.md new file mode 100644 index 0000000000..6a3f552df1 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-argon2user.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.createArgon2User( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-dart/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..d49f3b8ab6 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-bcrypt-user.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.createBcryptUser( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-dart/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..19fcf90b32 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-j-w-t.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +Jwt result = await users.createJWT( + userId: '<USER_ID>', + sessionId: '<SESSION_ID>', // (optional) + duration: 0, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-dart/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..43eeec651b --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-m-d5user.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.createMD5User( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..80ff25b0d5 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +MfaRecoveryCodes result = await users.createMfaRecoveryCodes( + userId: '<USER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-dart/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..cf1b7991c0 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-p-h-pass-user.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.createPHPassUser( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-dart/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..a532afe4ad --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-s-h-a-user.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.createSHAUser( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + passwordVersion: PasswordHash.sha1, // (optional) + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..0e7026b74e --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,18 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.createScryptModifiedUser( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + passwordSalt: '<PASSWORD_SALT>', + passwordSaltSeparator: '<PASSWORD_SALT_SEPARATOR>', + passwordSignerKey: '<PASSWORD_SIGNER_KEY>', + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..c785aa5867 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-user.md @@ -0,0 +1,20 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.createScryptUser( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + passwordSalt: '<PASSWORD_SALT>', + passwordCpu: 0, + passwordMemory: 0, + passwordParallel: 0, + passwordLength: 0, + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-session.md b/docs/examples/1.6.x/server-dart/examples/users/create-session.md new file mode 100644 index 0000000000..6ae18a6242 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-session.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +Session result = await users.createSession( + userId: '<USER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-target.md b/docs/examples/1.6.x/server-dart/examples/users/create-target.md new file mode 100644 index 0000000000..d8ed9192cd --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-target.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +Target result = await users.createTarget( + userId: '<USER_ID>', + targetId: '<TARGET_ID>', + providerType: MessagingProviderType.email, + identifier: '<IDENTIFIER>', + providerId: '<PROVIDER_ID>', // (optional) + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-token.md b/docs/examples/1.6.x/server-dart/examples/users/create-token.md new file mode 100644 index 0000000000..5eb25ea186 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create-token.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +Token result = await users.createToken( + userId: '<USER_ID>', + length: 4, // (optional) + expire: 60, // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create.md b/docs/examples/1.6.x/server-dart/examples/users/create.md new file mode 100644 index 0000000000..5ae3a54ac5 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/create.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.create( + userId: '<USER_ID>', + email: 'email@example.com', // (optional) + phone: '+12065550100', // (optional) + password: '', // (optional) + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete-identity.md b/docs/examples/1.6.x/server-dart/examples/users/delete-identity.md new file mode 100644 index 0000000000..8fbbb6d8db --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/delete-identity.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +await users.deleteIdentity( + identityId: '<IDENTITY_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-dart/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..e91ac5258a --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +await users.deleteMfaAuthenticator( + userId: '<USER_ID>', + type: AuthenticatorType.totp, +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete-session.md b/docs/examples/1.6.x/server-dart/examples/users/delete-session.md new file mode 100644 index 0000000000..bc5cc6a292 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/delete-session.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +await users.deleteSession( + userId: '<USER_ID>', + sessionId: '<SESSION_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-dart/examples/users/delete-sessions.md new file mode 100644 index 0000000000..7ab20ac93a --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/delete-sessions.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +await users.deleteSessions( + userId: '<USER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete-target.md b/docs/examples/1.6.x/server-dart/examples/users/delete-target.md new file mode 100644 index 0000000000..f8196a3483 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/delete-target.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +await users.deleteTarget( + userId: '<USER_ID>', + targetId: '<TARGET_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete.md b/docs/examples/1.6.x/server-dart/examples/users/delete.md new file mode 100644 index 0000000000..5cbca954f5 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/delete.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +await users.delete( + userId: '<USER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..cd923d64e6 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +MfaRecoveryCodes result = await users.getMfaRecoveryCodes( + userId: '<USER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/get-prefs.md b/docs/examples/1.6.x/server-dart/examples/users/get-prefs.md new file mode 100644 index 0000000000..2cf000189e --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/get-prefs.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +Preferences result = await users.getPrefs( + userId: '<USER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/get-target.md b/docs/examples/1.6.x/server-dart/examples/users/get-target.md new file mode 100644 index 0000000000..dbffb66be9 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/get-target.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +Target result = await users.getTarget( + userId: '<USER_ID>', + targetId: '<TARGET_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/get.md b/docs/examples/1.6.x/server-dart/examples/users/get.md new file mode 100644 index 0000000000..3170b93f01 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/get.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.get( + userId: '<USER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-identities.md b/docs/examples/1.6.x/server-dart/examples/users/list-identities.md new file mode 100644 index 0000000000..e36dfd9fdd --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/list-identities.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +IdentityList result = await users.listIdentities( + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-logs.md b/docs/examples/1.6.x/server-dart/examples/users/list-logs.md new file mode 100644 index 0000000000..53499537ab --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/list-logs.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +LogList result = await users.listLogs( + userId: '<USER_ID>', + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-memberships.md b/docs/examples/1.6.x/server-dart/examples/users/list-memberships.md new file mode 100644 index 0000000000..d786a71c26 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/list-memberships.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +MembershipList result = await users.listMemberships( + userId: '<USER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-dart/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..ef8ae21987 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/list-mfa-factors.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +MfaFactors result = await users.listMfaFactors( + userId: '<USER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-sessions.md b/docs/examples/1.6.x/server-dart/examples/users/list-sessions.md new file mode 100644 index 0000000000..745fcd1fce --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/list-sessions.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +SessionList result = await users.listSessions( + userId: '<USER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-targets.md b/docs/examples/1.6.x/server-dart/examples/users/list-targets.md new file mode 100644 index 0000000000..632655f29d --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/list-targets.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +TargetList result = await users.listTargets( + userId: '<USER_ID>', + queries: [], // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list.md b/docs/examples/1.6.x/server-dart/examples/users/list.md new file mode 100644 index 0000000000..b1bb2e90a5 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/list.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +UserList result = await users.list( + queries: [], // (optional) + search: '<SEARCH>', // (optional) +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-dart/examples/users/update-email-verification.md new file mode 100644 index 0000000000..8f64780c81 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-email-verification.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.updateEmailVerification( + userId: '<USER_ID>', + emailVerification: false, +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-email.md b/docs/examples/1.6.x/server-dart/examples/users/update-email.md new file mode 100644 index 0000000000..9cdf699dbd --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-email.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.updateEmail( + userId: '<USER_ID>', + email: 'email@example.com', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-labels.md b/docs/examples/1.6.x/server-dart/examples/users/update-labels.md new file mode 100644 index 0000000000..fffebdab67 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-labels.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.updateLabels( + userId: '<USER_ID>', + labels: [], +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..a3604e4be3 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +MfaRecoveryCodes result = await users.updateMfaRecoveryCodes( + userId: '<USER_ID>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-mfa.md b/docs/examples/1.6.x/server-dart/examples/users/update-mfa.md new file mode 100644 index 0000000000..403ff69b18 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-mfa.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.updateMfa( + userId: '<USER_ID>', + mfa: false, +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-name.md b/docs/examples/1.6.x/server-dart/examples/users/update-name.md new file mode 100644 index 0000000000..12b9da86cb --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-name.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.updateName( + userId: '<USER_ID>', + name: '<NAME>', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-password.md b/docs/examples/1.6.x/server-dart/examples/users/update-password.md new file mode 100644 index 0000000000..072ef7007d --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-password.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.updatePassword( + userId: '<USER_ID>', + password: '', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-dart/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..8ce9243509 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-phone-verification.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.updatePhoneVerification( + userId: '<USER_ID>', + phoneVerification: false, +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-phone.md b/docs/examples/1.6.x/server-dart/examples/users/update-phone.md new file mode 100644 index 0000000000..30d73a4e75 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-phone.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.updatePhone( + userId: '<USER_ID>', + number: '+12065550100', +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-prefs.md b/docs/examples/1.6.x/server-dart/examples/users/update-prefs.md new file mode 100644 index 0000000000..ca36f10799 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-prefs.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +Preferences result = await users.updatePrefs( + userId: '<USER_ID>', + prefs: {}, +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-status.md b/docs/examples/1.6.x/server-dart/examples/users/update-status.md new file mode 100644 index 0000000000..26288975dc --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-status.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +User result = await users.updateStatus( + userId: '<USER_ID>', + status: false, +); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-target.md b/docs/examples/1.6.x/server-dart/examples/users/update-target.md new file mode 100644 index 0000000000..ae9036e120 --- /dev/null +++ b/docs/examples/1.6.x/server-dart/examples/users/update-target.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +Users users = Users(client); + +Target result = await users.updateTarget( + userId: '<USER_ID>', + targetId: '<TARGET_ID>', + identifier: '<IDENTIFIER>', // (optional) + providerId: '<PROVIDER_ID>', // (optional) + name: '<NAME>', // (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-deno/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..978d038248 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-anonymous-session.md @@ -0,0 +1,9 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const response = await account.createAnonymousSession(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-deno/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..45ec40ded7 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-email-password-session.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const response = await account.createEmailPasswordSession( + 'email@example.com', // email + 'password' // password +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-email-token.md b/docs/examples/1.6.x/server-deno/examples/account/create-email-token.md new file mode 100644 index 0000000000..475d0d0027 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-email-token.md @@ -0,0 +1,13 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const response = await account.createEmailToken( + '<USER_ID>', // userId + 'email@example.com', // email + false // phrase (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-deno/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..a3e82bc631 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-j-w-t.md @@ -0,0 +1,9 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const response = await account.createJWT(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-deno/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..daed66564c --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,14 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const response = await account.createMagicURLToken( + '<USER_ID>', // userId + 'email@example.com', // email + 'https://example.com', // url (optional) + false // phrase (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-deno/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..80e3fd3f74 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-mfa-authenticator.md @@ -0,0 +1,12 @@ +import { Client, Account, AuthenticatorType } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.createMfaAuthenticator( + AuthenticatorType.Totp // type +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-deno/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..e19d2c841b --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-mfa-challenge.md @@ -0,0 +1,11 @@ +import { Client, Account, AuthenticationFactor } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const response = await account.createMfaChallenge( + AuthenticationFactor.Email // factor +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..aa07a1933f --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.createMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-deno/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..cebae56721 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-o-auth2token.md @@ -0,0 +1,14 @@ +import { Client, Account, OAuthProvider } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +account.createOAuth2Token( + OAuthProvider.Amazon, // provider + 'https://example.com', // success (optional) + 'https://example.com', // failure (optional) + [] // scopes (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-deno/examples/account/create-phone-token.md new file mode 100644 index 0000000000..bf4e554456 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-phone-token.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const response = await account.createPhoneToken( + '<USER_ID>', // userId + '+12065550100' // phone +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-deno/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..c130372025 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-phone-verification.md @@ -0,0 +1,10 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.createPhoneVerification(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-recovery.md b/docs/examples/1.6.x/server-deno/examples/account/create-recovery.md new file mode 100644 index 0000000000..91d2772f92 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-recovery.md @@ -0,0 +1,13 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.createRecovery( + 'email@example.com', // email + 'https://example.com' // url +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-session.md b/docs/examples/1.6.x/server-deno/examples/account/create-session.md new file mode 100644 index 0000000000..a501f219d0 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-session.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const response = await account.createSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-verification.md b/docs/examples/1.6.x/server-deno/examples/account/create-verification.md new file mode 100644 index 0000000000..75c3058fab --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create-verification.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.createVerification( + 'https://example.com' // url +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create.md b/docs/examples/1.6.x/server-deno/examples/account/create.md new file mode 100644 index 0000000000..8cc745505e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/create.md @@ -0,0 +1,14 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const response = await account.create( + '<USER_ID>', // userId + 'email@example.com', // email + '', // password + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/delete-identity.md b/docs/examples/1.6.x/server-deno/examples/account/delete-identity.md new file mode 100644 index 0000000000..3a08ca98aa --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/delete-identity.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.deleteIdentity( + '<IDENTITY_ID>' // identityId +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-deno/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..3fafb7efad --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,12 @@ +import { Client, Account, AuthenticatorType } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.deleteMfaAuthenticator( + AuthenticatorType.Totp // type +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/delete-session.md b/docs/examples/1.6.x/server-deno/examples/account/delete-session.md new file mode 100644 index 0000000000..2adec11ce3 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/delete-session.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.deleteSession( + '<SESSION_ID>' // sessionId +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-deno/examples/account/delete-sessions.md new file mode 100644 index 0000000000..daa325ce5e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/delete-sessions.md @@ -0,0 +1,10 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.deleteSessions(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..8531ce7e33 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.getMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/get-prefs.md b/docs/examples/1.6.x/server-deno/examples/account/get-prefs.md new file mode 100644 index 0000000000..e174d04cbe --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/get-prefs.md @@ -0,0 +1,10 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.getPrefs(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/get-session.md b/docs/examples/1.6.x/server-deno/examples/account/get-session.md new file mode 100644 index 0000000000..d7e23b913c --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/get-session.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.getSession( + '<SESSION_ID>' // sessionId +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/get.md b/docs/examples/1.6.x/server-deno/examples/account/get.md new file mode 100644 index 0000000000..922f34fe3a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/get.md @@ -0,0 +1,10 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.get(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/list-identities.md b/docs/examples/1.6.x/server-deno/examples/account/list-identities.md new file mode 100644 index 0000000000..ac175985c6 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/list-identities.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.listIdentities( + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/list-logs.md b/docs/examples/1.6.x/server-deno/examples/account/list-logs.md new file mode 100644 index 0000000000..ed2fac07c6 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/list-logs.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.listLogs( + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-deno/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..2f4a9ab193 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/list-mfa-factors.md @@ -0,0 +1,10 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.listMfaFactors(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/list-sessions.md b/docs/examples/1.6.x/server-deno/examples/account/list-sessions.md new file mode 100644 index 0000000000..9c4fc28234 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/list-sessions.md @@ -0,0 +1,10 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.listSessions(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-email.md b/docs/examples/1.6.x/server-deno/examples/account/update-email.md new file mode 100644 index 0000000000..9f30e53d3e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-email.md @@ -0,0 +1,13 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updateEmail( + 'email@example.com', // email + 'password' // password +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-deno/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..dbfbeffdca --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-m-f-a.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updateMFA( + false // mfa +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-deno/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..cfec5bffc6 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const response = await account.updateMagicURLSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-deno/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..6808d0db7f --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-mfa-authenticator.md @@ -0,0 +1,13 @@ +import { Client, Account, AuthenticatorType } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updateMfaAuthenticator( + AuthenticatorType.Totp, // type + '<OTP>' // otp +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-deno/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..a0eef5efe6 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-mfa-challenge.md @@ -0,0 +1,13 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updateMfaChallenge( + '<CHALLENGE_ID>', // challengeId + '<OTP>' // otp +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..97595cee58 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-name.md b/docs/examples/1.6.x/server-deno/examples/account/update-name.md new file mode 100644 index 0000000000..2c8f1a635c --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-name.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updateName( + '<NAME>' // name +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-password.md b/docs/examples/1.6.x/server-deno/examples/account/update-password.md new file mode 100644 index 0000000000..10193ae284 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-password.md @@ -0,0 +1,13 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updatePassword( + '', // password + 'password' // oldPassword (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-deno/examples/account/update-phone-session.md new file mode 100644 index 0000000000..6dbc3401d6 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-phone-session.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new Account(client); + +const response = await account.updatePhoneSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-deno/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..25609772c4 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-phone-verification.md @@ -0,0 +1,13 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updatePhoneVerification( + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-phone.md b/docs/examples/1.6.x/server-deno/examples/account/update-phone.md new file mode 100644 index 0000000000..af827086d0 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-phone.md @@ -0,0 +1,13 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updatePhone( + '+12065550100', // phone + 'password' // password +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-prefs.md b/docs/examples/1.6.x/server-deno/examples/account/update-prefs.md new file mode 100644 index 0000000000..13a166e370 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-prefs.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updatePrefs( + {} // prefs +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-recovery.md b/docs/examples/1.6.x/server-deno/examples/account/update-recovery.md new file mode 100644 index 0000000000..9a3c2569d2 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-recovery.md @@ -0,0 +1,14 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updateRecovery( + '<USER_ID>', // userId + '<SECRET>', // secret + '' // password +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-session.md b/docs/examples/1.6.x/server-deno/examples/account/update-session.md new file mode 100644 index 0000000000..77c149088a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-session.md @@ -0,0 +1,12 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updateSession( + '<SESSION_ID>' // sessionId +); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-status.md b/docs/examples/1.6.x/server-deno/examples/account/update-status.md new file mode 100644 index 0000000000..6474704c53 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-status.md @@ -0,0 +1,10 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updateStatus(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-verification.md b/docs/examples/1.6.x/server-deno/examples/account/update-verification.md new file mode 100644 index 0000000000..b5e2db640f --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/account/update-verification.md @@ -0,0 +1,13 @@ +import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new Account(client); + +const response = await account.updateVerification( + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-browser.md new file mode 100644 index 0000000000..3eb6239c09 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/avatars/get-browser.md @@ -0,0 +1,15 @@ +import { Client, Avatars, Browser } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new Avatars(client); + +const result = avatars.getBrowser( + Browser.AvantBrowser, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..f4a2efc3ac --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/avatars/get-credit-card.md @@ -0,0 +1,15 @@ +import { Client, Avatars, CreditCard } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new Avatars(client); + +const result = avatars.getCreditCard( + CreditCard.AmericanExpress, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..33830503a8 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/avatars/get-favicon.md @@ -0,0 +1,12 @@ +import { Client, Avatars } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new Avatars(client); + +const result = avatars.getFavicon( + 'https://example.com' // url +); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-flag.md new file mode 100644 index 0000000000..0999748876 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/avatars/get-flag.md @@ -0,0 +1,15 @@ +import { Client, Avatars, Flag } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new Avatars(client); + +const result = avatars.getFlag( + Flag.Afghanistan, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-image.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-image.md new file mode 100644 index 0000000000..63ddc95cf7 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/avatars/get-image.md @@ -0,0 +1,14 @@ +import { Client, Avatars } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new Avatars(client); + +const result = avatars.getImage( + 'https://example.com', // url + 0, // width (optional) + 0 // height (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-initials.md new file mode 100644 index 0000000000..285d63700d --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/avatars/get-initials.md @@ -0,0 +1,15 @@ +import { Client, Avatars } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new Avatars(client); + +const result = avatars.getInitials( + '<NAME>', // name (optional) + 0, // width (optional) + 0, // height (optional) + '' // background (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..ab48003577 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/avatars/get-q-r.md @@ -0,0 +1,15 @@ +import { Client, Avatars } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new Avatars(client); + +const result = avatars.getQR( + '<TEXT>', // text + 1, // size (optional) + 0, // margin (optional) + false // download (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..8b360ddd56 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-boolean-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createBooleanAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + false, // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-collection.md b/docs/examples/1.6.x/server-deno/examples/databases/create-collection.md new file mode 100644 index 0000000000..aef84aa328 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-collection.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // documentSecurity (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..aa541663c0 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-datetime-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createDatetimeAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '', // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-document.md b/docs/examples/1.6.x/server-deno/examples/databases/create-document.md new file mode 100644 index 0000000000..65729e1671 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-document.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const databases = new Databases(client); + +const response = await databases.createDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + {}, // data + ["read("any")"] // permissions (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..69e2fc4b4a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-email-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createEmailAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'email@example.com', // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..21736aa7a2 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-enum-attribute.md @@ -0,0 +1,18 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createEnumAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + [], // elements + false, // required + '<DEFAULT>', // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..376a9f154d --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-float-attribute.md @@ -0,0 +1,19 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createFloatAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min (optional) + null, // max (optional) + null, // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-index.md b/docs/examples/1.6.x/server-deno/examples/databases/create-index.md new file mode 100644 index 0000000000..dbf8558444 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-index.md @@ -0,0 +1,17 @@ +import { Client, Databases, IndexType } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createIndex( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + IndexType.Key, // type + [], // attributes + [] // orders (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..0958832172 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-integer-attribute.md @@ -0,0 +1,19 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createIntegerAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min (optional) + null, // max (optional) + null, // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..ecc9d7230e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-ip-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createIpAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '', // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..0f558968f2 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-relationship-attribute.md @@ -0,0 +1,19 @@ +import { Client, Databases, RelationshipType, RelationMutate } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createRelationshipAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<RELATED_COLLECTION_ID>', // relatedCollectionId + RelationshipType.OneToOne, // type + false, // twoWay (optional) + '', // key (optional) + '', // twoWayKey (optional) + RelationMutate.Cascade // onDelete (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..88a96c2364 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-string-attribute.md @@ -0,0 +1,19 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createStringAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + 1, // size + false, // required + '<DEFAULT>', // default (optional) + false, // array (optional) + false // encrypt (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..c97230f827 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create-url-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.createUrlAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'https://example.com', // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create.md b/docs/examples/1.6.x/server-deno/examples/databases/create.md new file mode 100644 index 0000000000..06872d6498 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/create.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.create( + '<DATABASE_ID>', // databaseId + '<NAME>', // name + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..51814cc913 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/delete-attribute.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.deleteAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-deno/examples/databases/delete-collection.md new file mode 100644 index 0000000000..69d00d365b --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/delete-collection.md @@ -0,0 +1,13 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.deleteCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>' // collectionId +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/delete-document.md b/docs/examples/1.6.x/server-deno/examples/databases/delete-document.md new file mode 100644 index 0000000000..1cd8d031bc --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/delete-document.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const databases = new Databases(client); + +const response = await databases.deleteDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>' // documentId +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/delete-index.md b/docs/examples/1.6.x/server-deno/examples/databases/delete-index.md new file mode 100644 index 0000000000..760d7d4b05 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/delete-index.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.deleteIndex( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/delete.md b/docs/examples/1.6.x/server-deno/examples/databases/delete.md new file mode 100644 index 0000000000..d376565a2c --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/delete.md @@ -0,0 +1,12 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.delete( + '<DATABASE_ID>' // databaseId +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/get-attribute.md new file mode 100644 index 0000000000..31157f34e8 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/get-attribute.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.getAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/get-collection.md b/docs/examples/1.6.x/server-deno/examples/databases/get-collection.md new file mode 100644 index 0000000000..c59849c180 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/get-collection.md @@ -0,0 +1,13 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.getCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>' // collectionId +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/get-document.md b/docs/examples/1.6.x/server-deno/examples/databases/get-document.md new file mode 100644 index 0000000000..3f53f8f228 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/get-document.md @@ -0,0 +1,15 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const databases = new Databases(client); + +const response = await databases.getDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/get-index.md b/docs/examples/1.6.x/server-deno/examples/databases/get-index.md new file mode 100644 index 0000000000..c99659014c --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/get-index.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.getIndex( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/get.md b/docs/examples/1.6.x/server-deno/examples/databases/get.md new file mode 100644 index 0000000000..448e516cb0 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/get.md @@ -0,0 +1,12 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.get( + '<DATABASE_ID>' // databaseId +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-deno/examples/databases/list-attributes.md new file mode 100644 index 0000000000..ea1921d394 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/list-attributes.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.listAttributes( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/list-collections.md b/docs/examples/1.6.x/server-deno/examples/databases/list-collections.md new file mode 100644 index 0000000000..46a8351676 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/list-collections.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.listCollections( + '<DATABASE_ID>', // databaseId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/list-documents.md b/docs/examples/1.6.x/server-deno/examples/databases/list-documents.md new file mode 100644 index 0000000000..685a7d9c6a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/list-documents.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const databases = new Databases(client); + +const response = await databases.listDocuments( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-deno/examples/databases/list-indexes.md new file mode 100644 index 0000000000..03e1837041 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/list-indexes.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.listIndexes( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/list.md b/docs/examples/1.6.x/server-deno/examples/databases/list.md new file mode 100644 index 0000000000..b6cfc71964 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/list.md @@ -0,0 +1,13 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..daee99dc56 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-boolean-attribute.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.updateBooleanAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + false // default +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-collection.md b/docs/examples/1.6.x/server-deno/examples/databases/update-collection.md new file mode 100644 index 0000000000..9c1ac96583 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-collection.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.updateCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // documentSecurity (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..7b4410d953 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-datetime-attribute.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.updateDatetimeAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '' // default +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-document.md b/docs/examples/1.6.x/server-deno/examples/databases/update-document.md new file mode 100644 index 0000000000..000cc00c60 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-document.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const databases = new Databases(client); + +const response = await databases.updateDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + {}, // data (optional) + ["read("any")"] // permissions (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..af06f493e5 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-email-attribute.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.updateEmailAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'email@example.com' // default +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..d4525ce226 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-enum-attribute.md @@ -0,0 +1,17 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.updateEnumAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + [], // elements + false, // required + '<DEFAULT>' // default +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..54b75fd5f3 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-float-attribute.md @@ -0,0 +1,18 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.updateFloatAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min + null, // max + null // default +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..0648e28663 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-integer-attribute.md @@ -0,0 +1,18 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.updateIntegerAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min + null, // max + null // default +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..23a8741717 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-ip-attribute.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.updateIpAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '' // default +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..c091a93b6b --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-relationship-attribute.md @@ -0,0 +1,15 @@ +import { Client, Databases, RelationMutate } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.updateRelationshipAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + RelationMutate.Cascade // onDelete (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..b12dbc27d0 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-string-attribute.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.updateStringAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '<DEFAULT>' // default +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..cd074c282b --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update-url-attribute.md @@ -0,0 +1,16 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.updateUrlAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'https://example.com' // default +); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update.md b/docs/examples/1.6.x/server-deno/examples/databases/update.md new file mode 100644 index 0000000000..9220d447b5 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/databases/update.md @@ -0,0 +1,14 @@ +import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new Databases(client); + +const response = await databases.update( + '<DATABASE_ID>', // databaseId + '<NAME>', // name + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/create-build.md b/docs/examples/1.6.x/server-deno/examples/functions/create-build.md new file mode 100644 index 0000000000..99160d7f8f --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/create-build.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.createBuild( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>', // deploymentId + '<BUILD_ID>' // buildId (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-deno/examples/functions/create-deployment.md new file mode 100644 index 0000000000..fc23e26b0c --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/create-deployment.md @@ -0,0 +1,16 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.createDeployment( + '<FUNCTION_ID>', // functionId + InputFile.fromPath('/path/to/file.png', 'file.png'), // code + false, // activate + '<ENTRYPOINT>', // entrypoint (optional) + '<COMMANDS>' // commands (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/create-execution.md b/docs/examples/1.6.x/server-deno/examples/functions/create-execution.md new file mode 100644 index 0000000000..b44aef84f9 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/create-execution.md @@ -0,0 +1,18 @@ +import { Client, Functions, ExecutionMethod } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const functions = new Functions(client); + +const response = await functions.createExecution( + '<FUNCTION_ID>', // functionId + '<BODY>', // body (optional) + false, // async (optional) + '<PATH>', // path (optional) + ExecutionMethod.GET, // method (optional) + {}, // headers (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/create-variable.md b/docs/examples/1.6.x/server-deno/examples/functions/create-variable.md new file mode 100644 index 0000000000..780d30990f --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/create-variable.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.createVariable( + '<FUNCTION_ID>', // functionId + '<KEY>', // key + '<VALUE>' // value +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/create.md b/docs/examples/1.6.x/server-deno/examples/functions/create.md new file mode 100644 index 0000000000..c31bdfe126 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/create.md @@ -0,0 +1,32 @@ +import { Client, Functions, } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.create( + '<FUNCTION_ID>', // functionId + '<NAME>', // name + .Node145, // runtime + ["any"], // execute (optional) + [], // events (optional) + '', // schedule (optional) + 1, // timeout (optional) + false, // enabled (optional) + false, // logging (optional) + '<ENTRYPOINT>', // entrypoint (optional) + '<COMMANDS>', // commands (optional) + [], // scopes (optional) + '<INSTALLATION_ID>', // installationId (optional) + '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) + '<PROVIDER_BRANCH>', // providerBranch (optional) + false, // providerSilentMode (optional) + '<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional) + '<TEMPLATE_REPOSITORY>', // templateRepository (optional) + '<TEMPLATE_OWNER>', // templateOwner (optional) + '<TEMPLATE_ROOT_DIRECTORY>', // templateRootDirectory (optional) + '<TEMPLATE_BRANCH>' // templateBranch (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-deno/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..7b72f7e639 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/delete-deployment.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.deleteDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-deno/examples/functions/delete-execution.md new file mode 100644 index 0000000000..6959261f79 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/delete-execution.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.deleteExecution( + '<FUNCTION_ID>', // functionId + '<EXECUTION_ID>' // executionId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-deno/examples/functions/delete-variable.md new file mode 100644 index 0000000000..910678b31a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/delete-variable.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.deleteVariable( + '<FUNCTION_ID>', // functionId + '<VARIABLE_ID>' // variableId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/delete.md b/docs/examples/1.6.x/server-deno/examples/functions/delete.md new file mode 100644 index 0000000000..fc9930e508 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/delete.md @@ -0,0 +1,12 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.delete( + '<FUNCTION_ID>' // functionId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-deno/examples/functions/download-deployment.md new file mode 100644 index 0000000000..2fdf148283 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/download-deployment.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const result = functions.downloadDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-deno/examples/functions/get-deployment.md new file mode 100644 index 0000000000..bc798e5e7b --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/get-deployment.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.getDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/get-execution.md b/docs/examples/1.6.x/server-deno/examples/functions/get-execution.md new file mode 100644 index 0000000000..afb6c6713a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/get-execution.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const functions = new Functions(client); + +const response = await functions.getExecution( + '<FUNCTION_ID>', // functionId + '<EXECUTION_ID>' // executionId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/get-variable.md b/docs/examples/1.6.x/server-deno/examples/functions/get-variable.md new file mode 100644 index 0000000000..8634ed3ee5 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/get-variable.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.getVariable( + '<FUNCTION_ID>', // functionId + '<VARIABLE_ID>' // variableId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/get.md b/docs/examples/1.6.x/server-deno/examples/functions/get.md new file mode 100644 index 0000000000..66b99d4bb1 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/get.md @@ -0,0 +1,12 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.get( + '<FUNCTION_ID>' // functionId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-deno/examples/functions/list-deployments.md new file mode 100644 index 0000000000..5dc5eb5552 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/list-deployments.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.listDeployments( + '<FUNCTION_ID>', // functionId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/list-executions.md b/docs/examples/1.6.x/server-deno/examples/functions/list-executions.md new file mode 100644 index 0000000000..34a34b4463 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/list-executions.md @@ -0,0 +1,14 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const functions = new Functions(client); + +const response = await functions.listExecutions( + '<FUNCTION_ID>', // functionId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-deno/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..cc1ecdff6a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/list-runtimes.md @@ -0,0 +1,10 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.listRuntimes(); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/list-variables.md b/docs/examples/1.6.x/server-deno/examples/functions/list-variables.md new file mode 100644 index 0000000000..f4ebb811bb --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/list-variables.md @@ -0,0 +1,12 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.listVariables( + '<FUNCTION_ID>' // functionId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/list.md b/docs/examples/1.6.x/server-deno/examples/functions/list.md new file mode 100644 index 0000000000..85b8caa446 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/list.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-deno/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..9b3d5ae428 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/update-deployment-build.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.updateDeploymentBuild( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-deno/examples/functions/update-deployment.md new file mode 100644 index 0000000000..dd71ab8842 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/update-deployment.md @@ -0,0 +1,13 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.updateDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/update-variable.md b/docs/examples/1.6.x/server-deno/examples/functions/update-variable.md new file mode 100644 index 0000000000..e1d931687f --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/update-variable.md @@ -0,0 +1,15 @@ +import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.updateVariable( + '<FUNCTION_ID>', // functionId + '<VARIABLE_ID>', // variableId + '<KEY>', // key + '<VALUE>' // value (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/update.md b/docs/examples/1.6.x/server-deno/examples/functions/update.md new file mode 100644 index 0000000000..5d37fb804c --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/functions/update.md @@ -0,0 +1,28 @@ +import { Client, Functions, } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new Functions(client); + +const response = await functions.update( + '<FUNCTION_ID>', // functionId + '<NAME>', // name + .Node145, // runtime (optional) + ["any"], // execute (optional) + [], // events (optional) + '', // schedule (optional) + 1, // timeout (optional) + false, // enabled (optional) + false, // logging (optional) + '<ENTRYPOINT>', // entrypoint (optional) + '<COMMANDS>', // commands (optional) + [], // scopes (optional) + '<INSTALLATION_ID>', // installationId (optional) + '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) + '<PROVIDER_BRANCH>', // providerBranch (optional) + false, // providerSilentMode (optional) + '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/graphql/mutation.md b/docs/examples/1.6.x/server-deno/examples/graphql/mutation.md new file mode 100644 index 0000000000..29fd054642 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/graphql/mutation.md @@ -0,0 +1,12 @@ +import { Client, Graphql } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const graphql = new Graphql(client); + +const response = await graphql.mutation( + {} // query +); diff --git a/docs/examples/1.6.x/server-deno/examples/graphql/query.md b/docs/examples/1.6.x/server-deno/examples/graphql/query.md new file mode 100644 index 0000000000..397973d817 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/graphql/query.md @@ -0,0 +1,12 @@ +import { Client, Graphql } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const graphql = new Graphql(client); + +const response = await graphql.query( + {} // query +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-deno/examples/health/get-antivirus.md new file mode 100644 index 0000000000..9e8a30778c --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-antivirus.md @@ -0,0 +1,10 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getAntivirus(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-cache.md b/docs/examples/1.6.x/server-deno/examples/health/get-cache.md new file mode 100644 index 0000000000..55b8bfb3cf --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-cache.md @@ -0,0 +1,10 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getCache(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-certificate.md b/docs/examples/1.6.x/server-deno/examples/health/get-certificate.md new file mode 100644 index 0000000000..29facfc22e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-certificate.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getCertificate( + '' // domain (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-d-b.md b/docs/examples/1.6.x/server-deno/examples/health/get-d-b.md new file mode 100644 index 0000000000..64d89c0ec2 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-d-b.md @@ -0,0 +1,10 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getDB(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-deno/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..362c235fc4 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-failed-jobs.md @@ -0,0 +1,13 @@ +import { Client, Health, } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getFailedJobs( + .V1Database, // name + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-deno/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..433b50cb9a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-pub-sub.md @@ -0,0 +1,10 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getPubSub(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..faee214414 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-builds.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueBuilds( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..2cf716a2f6 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-certificates.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueCertificates( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..e64798fe05 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-databases.md @@ -0,0 +1,13 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueDatabases( + '<NAME>', // name (optional) + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..dffd43f2a1 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-deletes.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueDeletes( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..9ee87d968a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-functions.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueFunctions( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..aa8639d557 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-logs.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueLogs( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..555a2b8d7d --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-mails.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueMails( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..f4191575bf --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-messaging.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueMessaging( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..557a3dba32 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-migrations.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueMigrations( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..27770d1a1e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage-dump.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueUsageDump( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..4d74e5babf --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueUsage( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..51032e3e7e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue-webhooks.md @@ -0,0 +1,12 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueueWebhooks( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue.md new file mode 100644 index 0000000000..f95f709c43 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-queue.md @@ -0,0 +1,10 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getQueue(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-deno/examples/health/get-storage-local.md new file mode 100644 index 0000000000..c66249503e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-storage-local.md @@ -0,0 +1,10 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getStorageLocal(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-storage.md b/docs/examples/1.6.x/server-deno/examples/health/get-storage.md new file mode 100644 index 0000000000..53f5dcf162 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-storage.md @@ -0,0 +1,10 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getStorage(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-time.md b/docs/examples/1.6.x/server-deno/examples/health/get-time.md new file mode 100644 index 0000000000..9c0e7a8543 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get-time.md @@ -0,0 +1,10 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.getTime(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get.md b/docs/examples/1.6.x/server-deno/examples/health/get.md new file mode 100644 index 0000000000..8c259d4d08 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/health/get.md @@ -0,0 +1,10 @@ +import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new Health(client); + +const response = await health.get(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/get.md b/docs/examples/1.6.x/server-deno/examples/locale/get.md new file mode 100644 index 0000000000..04e45b50e9 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/locale/get.md @@ -0,0 +1,10 @@ +import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new Locale(client); + +const response = await locale.get(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-codes.md b/docs/examples/1.6.x/server-deno/examples/locale/list-codes.md new file mode 100644 index 0000000000..2806ea2543 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/locale/list-codes.md @@ -0,0 +1,10 @@ +import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new Locale(client); + +const response = await locale.listCodes(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-continents.md b/docs/examples/1.6.x/server-deno/examples/locale/list-continents.md new file mode 100644 index 0000000000..2218f1bedb --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/locale/list-continents.md @@ -0,0 +1,10 @@ +import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new Locale(client); + +const response = await locale.listContinents(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-deno/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..0dbb50aff4 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/locale/list-countries-e-u.md @@ -0,0 +1,10 @@ +import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new Locale(client); + +const response = await locale.listCountriesEU(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-deno/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..3c5ae53b41 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/locale/list-countries-phones.md @@ -0,0 +1,10 @@ +import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new Locale(client); + +const response = await locale.listCountriesPhones(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-countries.md b/docs/examples/1.6.x/server-deno/examples/locale/list-countries.md new file mode 100644 index 0000000000..4bc430f0fc --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/locale/list-countries.md @@ -0,0 +1,10 @@ +import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new Locale(client); + +const response = await locale.listCountries(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-deno/examples/locale/list-currencies.md new file mode 100644 index 0000000000..44f1e606fb --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/locale/list-currencies.md @@ -0,0 +1,10 @@ +import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new Locale(client); + +const response = await locale.listCurrencies(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-languages.md b/docs/examples/1.6.x/server-deno/examples/locale/list-languages.md new file mode 100644 index 0000000000..af597ccf57 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/locale/list-languages.md @@ -0,0 +1,10 @@ +import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new Locale(client); + +const response = await locale.listLanguages(); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..a958f8e6ec --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-apns-provider.md @@ -0,0 +1,19 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createApnsProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<AUTH_KEY>', // authKey (optional) + '<AUTH_KEY_ID>', // authKeyId (optional) + '<TEAM_ID>', // teamId (optional) + '<BUNDLE_ID>', // bundleId (optional) + false, // sandbox (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-email.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-email.md new file mode 100644 index 0000000000..892fb12be0 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-email.md @@ -0,0 +1,23 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createEmail( + '<MESSAGE_ID>', // messageId + '<SUBJECT>', // subject + '<CONTENT>', // content + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + [], // cc (optional) + [], // bcc (optional) + [], // attachments (optional) + false, // draft (optional) + false, // html (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..5c4dc95cd8 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-fcm-provider.md @@ -0,0 +1,15 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createFcmProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + {}, // serviceAccountJSON (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..24fe54d3f3 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,21 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createMailgunProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<API_KEY>', // apiKey (optional) + '<DOMAIN>', // domain (optional) + false, // isEuRegion (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + 'email@example.com', // replyToEmail (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..7fb2671738 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-msg91provider.md @@ -0,0 +1,17 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createMsg91Provider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<TEMPLATE_ID>', // templateId (optional) + '<SENDER_ID>', // senderId (optional) + '<AUTH_KEY>', // authKey (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-push.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-push.md new file mode 100644 index 0000000000..efc73df645 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-push.md @@ -0,0 +1,27 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createPush( + '<MESSAGE_ID>', // messageId + '<TITLE>', // title + '<BODY>', // body + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + {}, // data (optional) + '<ACTION>', // action (optional) + '[ID1:ID2]', // image (optional) + '<ICON>', // icon (optional) + '<SOUND>', // sound (optional) + '<COLOR>', // color (optional) + '<TAG>', // tag (optional) + '<BADGE>', // badge (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..0b35009bae --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,19 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createSendgridProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<API_KEY>', // apiKey (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + 'email@example.com', // replyToEmail (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-sms.md new file mode 100644 index 0000000000..2823eb14e5 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-sms.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createSms( + '<MESSAGE_ID>', // messageId + '<CONTENT>', // content + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..bf7912500a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-smtp-provider.md @@ -0,0 +1,25 @@ +import { Client, Messaging, SmtpEncryption } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createSmtpProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<HOST>', // host + 1, // port (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) + SmtpEncryption.None, // encryption (optional) + false, // autoTLS (optional) + '<MAILER>', // mailer (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + 'email@example.com', // replyToEmail (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..1d510292b4 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-subscriber.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token + +const messaging = new Messaging(client); + +const response = await messaging.createSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>', // subscriberId + '<TARGET_ID>' // targetId +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..a5623ada10 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-telesign-provider.md @@ -0,0 +1,17 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createTelesignProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<CUSTOMER_ID>', // customerId (optional) + '<API_KEY>', // apiKey (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..e319a64d15 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,17 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createTextmagicProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<USERNAME>', // username (optional) + '<API_KEY>', // apiKey (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-topic.md new file mode 100644 index 0000000000..88217dd793 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-topic.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createTopic( + '<TOPIC_ID>', // topicId + '<NAME>', // name + ["any"] // subscribe (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..cf3ef29b2b --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-twilio-provider.md @@ -0,0 +1,17 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createTwilioProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<ACCOUNT_SID>', // accountSid (optional) + '<AUTH_TOKEN>', // authToken (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..565c4029f7 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/create-vonage-provider.md @@ -0,0 +1,17 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.createVonageProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<API_KEY>', // apiKey (optional) + '<API_SECRET>', // apiSecret (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..d3c2e5e03a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/delete-provider.md @@ -0,0 +1,12 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.deleteProvider( + '<PROVIDER_ID>' // providerId +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-deno/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..66ca92bd4b --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/delete-subscriber.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token + +const messaging = new Messaging(client); + +const response = await messaging.deleteSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>' // subscriberId +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-deno/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..3802874c56 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/delete-topic.md @@ -0,0 +1,12 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.deleteTopic( + '<TOPIC_ID>' // topicId +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/delete.md b/docs/examples/1.6.x/server-deno/examples/messaging/delete.md new file mode 100644 index 0000000000..0bf4473ae5 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/delete.md @@ -0,0 +1,12 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.delete( + '<MESSAGE_ID>' // messageId +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/get-message.md b/docs/examples/1.6.x/server-deno/examples/messaging/get-message.md new file mode 100644 index 0000000000..4ad50591ac --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/get-message.md @@ -0,0 +1,12 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.getMessage( + '<MESSAGE_ID>' // messageId +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/get-provider.md new file mode 100644 index 0000000000..10956547d0 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/get-provider.md @@ -0,0 +1,12 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.getProvider( + '<PROVIDER_ID>' // providerId +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-deno/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..c76b65a787 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/get-subscriber.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.getSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>' // subscriberId +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-deno/examples/messaging/get-topic.md new file mode 100644 index 0000000000..5202be495f --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/get-topic.md @@ -0,0 +1,12 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.getTopic( + '<TOPIC_ID>' // topicId +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..1101508823 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/list-message-logs.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.listMessageLogs( + '<MESSAGE_ID>', // messageId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-messages.md new file mode 100644 index 0000000000..9bdca84969 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/list-messages.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.listMessages( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..b2be21b03e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/list-provider-logs.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.listProviderLogs( + '<PROVIDER_ID>', // providerId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-providers.md new file mode 100644 index 0000000000..7797454e8e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/list-providers.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.listProviders( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..6a033f2e73 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.listSubscriberLogs( + '<SUBSCRIBER_ID>', // subscriberId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..71f856b7a5 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/list-subscribers.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.listSubscribers( + '<TOPIC_ID>', // topicId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-targets.md new file mode 100644 index 0000000000..0c7772cb00 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/list-targets.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.listTargets( + '<MESSAGE_ID>', // messageId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..ab0c021d0e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/list-topic-logs.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.listTopicLogs( + '<TOPIC_ID>', // topicId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-topics.md new file mode 100644 index 0000000000..b087d03a17 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/list-topics.md @@ -0,0 +1,13 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.listTopics( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..7427c6d8bf --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-apns-provider.md @@ -0,0 +1,19 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateApnsProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<AUTH_KEY>', // authKey (optional) + '<AUTH_KEY_ID>', // authKeyId (optional) + '<TEAM_ID>', // teamId (optional) + '<BUNDLE_ID>', // bundleId (optional) + false // sandbox (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-email.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-email.md new file mode 100644 index 0000000000..42a44f8f9a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-email.md @@ -0,0 +1,23 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateEmail( + '<MESSAGE_ID>', // messageId + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + '<SUBJECT>', // subject (optional) + '<CONTENT>', // content (optional) + false, // draft (optional) + false, // html (optional) + [], // cc (optional) + [], // bcc (optional) + '', // scheduledAt (optional) + [] // attachments (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..7ceb75166b --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-fcm-provider.md @@ -0,0 +1,15 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateFcmProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + {} // serviceAccountJSON (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..6b7605dba1 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,21 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateMailgunProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + '<API_KEY>', // apiKey (optional) + '<DOMAIN>', // domain (optional) + false, // isEuRegion (optional) + false, // enabled (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>' // replyToEmail (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..603303c63f --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-msg91provider.md @@ -0,0 +1,17 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateMsg91Provider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<TEMPLATE_ID>', // templateId (optional) + '<SENDER_ID>', // senderId (optional) + '<AUTH_KEY>' // authKey (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-push.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-push.md new file mode 100644 index 0000000000..e12890e2e9 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-push.md @@ -0,0 +1,27 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updatePush( + '<MESSAGE_ID>', // messageId + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + '<TITLE>', // title (optional) + '<BODY>', // body (optional) + {}, // data (optional) + '<ACTION>', // action (optional) + '[ID1:ID2]', // image (optional) + '<ICON>', // icon (optional) + '<SOUND>', // sound (optional) + '<COLOR>', // color (optional) + '<TAG>', // tag (optional) + null, // badge (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..ce4a6c2968 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,19 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateSendgridProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<API_KEY>', // apiKey (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>' // replyToEmail (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-sms.md new file mode 100644 index 0000000000..fc0ca688d1 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-sms.md @@ -0,0 +1,18 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateSms( + '<MESSAGE_ID>', // messageId + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + '<CONTENT>', // content (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..c227026184 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-smtp-provider.md @@ -0,0 +1,25 @@ +import { Client, Messaging, SmtpEncryption } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateSmtpProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + '<HOST>', // host (optional) + 1, // port (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) + SmtpEncryption.None, // encryption (optional) + false, // autoTLS (optional) + '<MAILER>', // mailer (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>', // replyToEmail (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..4e4d3839ac --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-telesign-provider.md @@ -0,0 +1,17 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateTelesignProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<CUSTOMER_ID>', // customerId (optional) + '<API_KEY>', // apiKey (optional) + '<FROM>' // from (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..13ea0433c7 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,17 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateTextmagicProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<USERNAME>', // username (optional) + '<API_KEY>', // apiKey (optional) + '<FROM>' // from (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-topic.md new file mode 100644 index 0000000000..385df4ffd6 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-topic.md @@ -0,0 +1,14 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateTopic( + '<TOPIC_ID>', // topicId + '<NAME>', // name (optional) + ["any"] // subscribe (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..ac0c5516f6 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-twilio-provider.md @@ -0,0 +1,17 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateTwilioProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<ACCOUNT_SID>', // accountSid (optional) + '<AUTH_TOKEN>', // authToken (optional) + '<FROM>' // from (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..9b8451dac0 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/messaging/update-vonage-provider.md @@ -0,0 +1,17 @@ +import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new Messaging(client); + +const response = await messaging.updateVonageProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<API_KEY>', // apiKey (optional) + '<API_SECRET>', // apiSecret (optional) + '<FROM>' // from (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-deno/examples/storage/create-bucket.md new file mode 100644 index 0000000000..85a60abdbc --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/create-bucket.md @@ -0,0 +1,21 @@ +import { Client, Storage, } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const storage = new Storage(client); + +const response = await storage.createBucket( + '<BUCKET_ID>', // bucketId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // fileSecurity (optional) + false, // enabled (optional) + 1, // maximumFileSize (optional) + [], // allowedFileExtensions (optional) + .None, // compression (optional) + false, // encryption (optional) + false // antivirus (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/create-file.md b/docs/examples/1.6.x/server-deno/examples/storage/create-file.md new file mode 100644 index 0000000000..0a18e9246a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/create-file.md @@ -0,0 +1,15 @@ +import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new Storage(client); + +const response = await storage.createFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + InputFile.fromPath('/path/to/file.png', 'file.png'), // file + ["read("any")"] // permissions (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-deno/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..48690b08e3 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/delete-bucket.md @@ -0,0 +1,12 @@ +import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const storage = new Storage(client); + +const response = await storage.deleteBucket( + '<BUCKET_ID>' // bucketId +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/delete-file.md b/docs/examples/1.6.x/server-deno/examples/storage/delete-file.md new file mode 100644 index 0000000000..ae67b9f1e7 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/delete-file.md @@ -0,0 +1,13 @@ +import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new Storage(client); + +const response = await storage.deleteFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-deno/examples/storage/get-bucket.md new file mode 100644 index 0000000000..80be0c0e37 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/get-bucket.md @@ -0,0 +1,12 @@ +import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const storage = new Storage(client); + +const response = await storage.getBucket( + '<BUCKET_ID>' // bucketId +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-deno/examples/storage/get-file-download.md new file mode 100644 index 0000000000..eeb248daf6 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/get-file-download.md @@ -0,0 +1,13 @@ +import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new Storage(client); + +const result = storage.getFileDownload( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-deno/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..a75cd2b36f --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/get-file-preview.md @@ -0,0 +1,24 @@ +import { Client, Storage, ImageGravity, ImageFormat } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new Storage(client); + +const result = storage.getFilePreview( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + 0, // width (optional) + 0, // height (optional) + ImageGravity.Center, // gravity (optional) + 0, // quality (optional) + 0, // borderWidth (optional) + '', // borderColor (optional) + 0, // borderRadius (optional) + 0, // opacity (optional) + -360, // rotation (optional) + '', // background (optional) + ImageFormat.Jpg // output (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-deno/examples/storage/get-file-view.md new file mode 100644 index 0000000000..fd919b7627 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/get-file-view.md @@ -0,0 +1,13 @@ +import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new Storage(client); + +const result = storage.getFileView( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/get-file.md b/docs/examples/1.6.x/server-deno/examples/storage/get-file.md new file mode 100644 index 0000000000..84289b22de --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/get-file.md @@ -0,0 +1,13 @@ +import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new Storage(client); + +const response = await storage.getFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-deno/examples/storage/list-buckets.md new file mode 100644 index 0000000000..4b6a93dc36 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/list-buckets.md @@ -0,0 +1,13 @@ +import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const storage = new Storage(client); + +const response = await storage.listBuckets( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/list-files.md b/docs/examples/1.6.x/server-deno/examples/storage/list-files.md new file mode 100644 index 0000000000..2e9a9e0bd4 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/list-files.md @@ -0,0 +1,14 @@ +import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new Storage(client); + +const response = await storage.listFiles( + '<BUCKET_ID>', // bucketId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-deno/examples/storage/update-bucket.md new file mode 100644 index 0000000000..46ee2ba190 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/update-bucket.md @@ -0,0 +1,21 @@ +import { Client, Storage, } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const storage = new Storage(client); + +const response = await storage.updateBucket( + '<BUCKET_ID>', // bucketId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // fileSecurity (optional) + false, // enabled (optional) + 1, // maximumFileSize (optional) + [], // allowedFileExtensions (optional) + .None, // compression (optional) + false, // encryption (optional) + false // antivirus (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/update-file.md b/docs/examples/1.6.x/server-deno/examples/storage/update-file.md new file mode 100644 index 0000000000..249fc09b4e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/storage/update-file.md @@ -0,0 +1,15 @@ +import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new Storage(client); + +const response = await storage.updateFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + '<NAME>', // name (optional) + ["read("any")"] // permissions (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/create-membership.md b/docs/examples/1.6.x/server-deno/examples/teams/create-membership.md new file mode 100644 index 0000000000..3636727f0c --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/create-membership.md @@ -0,0 +1,18 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.createMembership( + '<TEAM_ID>', // teamId + [], // roles + 'email@example.com', // email (optional) + '<USER_ID>', // userId (optional) + '+12065550100', // phone (optional) + 'https://example.com', // url (optional) + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/create.md b/docs/examples/1.6.x/server-deno/examples/teams/create.md new file mode 100644 index 0000000000..330bb4385d --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/create.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.create( + '<TEAM_ID>', // teamId + '<NAME>', // name + [] // roles (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-deno/examples/teams/delete-membership.md new file mode 100644 index 0000000000..7d2a4ed3ab --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/delete-membership.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.deleteMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/delete.md b/docs/examples/1.6.x/server-deno/examples/teams/delete.md new file mode 100644 index 0000000000..bd140f8da6 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/delete.md @@ -0,0 +1,12 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.delete( + '<TEAM_ID>' // teamId +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/get-membership.md b/docs/examples/1.6.x/server-deno/examples/teams/get-membership.md new file mode 100644 index 0000000000..3b88441a6e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/get-membership.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.getMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-deno/examples/teams/get-prefs.md new file mode 100644 index 0000000000..4e7882ade1 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/get-prefs.md @@ -0,0 +1,12 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.getPrefs( + '<TEAM_ID>' // teamId +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/get.md b/docs/examples/1.6.x/server-deno/examples/teams/get.md new file mode 100644 index 0000000000..2835d9eab1 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/get.md @@ -0,0 +1,12 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.get( + '<TEAM_ID>' // teamId +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-deno/examples/teams/list-memberships.md new file mode 100644 index 0000000000..1688ad4852 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/list-memberships.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.listMemberships( + '<TEAM_ID>', // teamId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/list.md b/docs/examples/1.6.x/server-deno/examples/teams/list.md new file mode 100644 index 0000000000..8e7dad2d65 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/list.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-deno/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..f7459703d2 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/update-membership-status.md @@ -0,0 +1,15 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.updateMembershipStatus( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/update-membership.md b/docs/examples/1.6.x/server-deno/examples/teams/update-membership.md new file mode 100644 index 0000000000..ee0ce5a812 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/update-membership.md @@ -0,0 +1,14 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.updateMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId + [] // roles +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/update-name.md b/docs/examples/1.6.x/server-deno/examples/teams/update-name.md new file mode 100644 index 0000000000..f20b6ed19f --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/update-name.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.updateName( + '<TEAM_ID>', // teamId + '<NAME>' // name +); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-deno/examples/teams/update-prefs.md new file mode 100644 index 0000000000..35452a6b90 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/teams/update-prefs.md @@ -0,0 +1,13 @@ +import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new Teams(client); + +const response = await teams.updatePrefs( + '<TEAM_ID>', // teamId + {} // prefs +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-deno/examples/users/create-argon2user.md new file mode 100644 index 0000000000..e92126bc13 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-argon2user.md @@ -0,0 +1,15 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createArgon2User( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-deno/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..f59770a304 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-bcrypt-user.md @@ -0,0 +1,15 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createBcryptUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-deno/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..fbaefa9535 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-j-w-t.md @@ -0,0 +1,14 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createJWT( + '<USER_ID>', // userId + '<SESSION_ID>', // sessionId (optional) + 0 // duration (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-deno/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..4a60e956e4 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-m-d5user.md @@ -0,0 +1,15 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createMD5User( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..5c58e5b5d4 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createMfaRecoveryCodes( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-deno/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..e353c4abef --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-p-h-pass-user.md @@ -0,0 +1,15 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createPHPassUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-deno/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..16c1b0cc5d --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-s-h-a-user.md @@ -0,0 +1,16 @@ +import { Client, Users, PasswordHash } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createSHAUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + PasswordHash.Sha1, // passwordVersion (optional) + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..0bcb2bc710 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,18 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createScryptModifiedUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<PASSWORD_SALT>', // passwordSalt + '<PASSWORD_SALT_SEPARATOR>', // passwordSaltSeparator + '<PASSWORD_SIGNER_KEY>', // passwordSignerKey + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..6813a0d300 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-user.md @@ -0,0 +1,20 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createScryptUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<PASSWORD_SALT>', // passwordSalt + null, // passwordCpu + null, // passwordMemory + null, // passwordParallel + null, // passwordLength + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-session.md b/docs/examples/1.6.x/server-deno/examples/users/create-session.md new file mode 100644 index 0000000000..3c3bf4e54e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-session.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createSession( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-target.md b/docs/examples/1.6.x/server-deno/examples/users/create-target.md new file mode 100644 index 0000000000..9597b30b3a --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-target.md @@ -0,0 +1,17 @@ +import { Client, Users, MessagingProviderType } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createTarget( + '<USER_ID>', // userId + '<TARGET_ID>', // targetId + MessagingProviderType.Email, // providerType + '<IDENTIFIER>', // identifier + '<PROVIDER_ID>', // providerId (optional) + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-token.md b/docs/examples/1.6.x/server-deno/examples/users/create-token.md new file mode 100644 index 0000000000..26be7e629d --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create-token.md @@ -0,0 +1,14 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.createToken( + '<USER_ID>', // userId + 4, // length (optional) + 60 // expire (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create.md b/docs/examples/1.6.x/server-deno/examples/users/create.md new file mode 100644 index 0000000000..832d9e0b16 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/create.md @@ -0,0 +1,16 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.create( + '<USER_ID>', // userId + 'email@example.com', // email (optional) + '+12065550100', // phone (optional) + '', // password (optional) + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete-identity.md b/docs/examples/1.6.x/server-deno/examples/users/delete-identity.md new file mode 100644 index 0000000000..28e6685904 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/delete-identity.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.deleteIdentity( + '<IDENTITY_ID>' // identityId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-deno/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..5fd7ee9f5e --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,13 @@ +import { Client, Users, AuthenticatorType } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.deleteMfaAuthenticator( + '<USER_ID>', // userId + AuthenticatorType.Totp // type +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete-session.md b/docs/examples/1.6.x/server-deno/examples/users/delete-session.md new file mode 100644 index 0000000000..61dbc25855 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/delete-session.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.deleteSession( + '<USER_ID>', // userId + '<SESSION_ID>' // sessionId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-deno/examples/users/delete-sessions.md new file mode 100644 index 0000000000..2a8cae1a40 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/delete-sessions.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.deleteSessions( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete-target.md b/docs/examples/1.6.x/server-deno/examples/users/delete-target.md new file mode 100644 index 0000000000..f7b74e3afc --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/delete-target.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.deleteTarget( + '<USER_ID>', // userId + '<TARGET_ID>' // targetId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete.md b/docs/examples/1.6.x/server-deno/examples/users/delete.md new file mode 100644 index 0000000000..2e102cdadd --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/delete.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.delete( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..671b7b244f --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.getMfaRecoveryCodes( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/get-prefs.md b/docs/examples/1.6.x/server-deno/examples/users/get-prefs.md new file mode 100644 index 0000000000..5db7e51302 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/get-prefs.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.getPrefs( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/get-target.md b/docs/examples/1.6.x/server-deno/examples/users/get-target.md new file mode 100644 index 0000000000..0ede3716be --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/get-target.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.getTarget( + '<USER_ID>', // userId + '<TARGET_ID>' // targetId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/get.md b/docs/examples/1.6.x/server-deno/examples/users/get.md new file mode 100644 index 0000000000..54dfde6e8d --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/get.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.get( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-identities.md b/docs/examples/1.6.x/server-deno/examples/users/list-identities.md new file mode 100644 index 0000000000..5726b980b2 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/list-identities.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.listIdentities( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-logs.md b/docs/examples/1.6.x/server-deno/examples/users/list-logs.md new file mode 100644 index 0000000000..e6b65ceabf --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/list-logs.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.listLogs( + '<USER_ID>', // userId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-memberships.md b/docs/examples/1.6.x/server-deno/examples/users/list-memberships.md new file mode 100644 index 0000000000..4d8f523357 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/list-memberships.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.listMemberships( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-deno/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..5672006db2 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/list-mfa-factors.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.listMfaFactors( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-sessions.md b/docs/examples/1.6.x/server-deno/examples/users/list-sessions.md new file mode 100644 index 0000000000..c5f88cba60 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/list-sessions.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.listSessions( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-targets.md b/docs/examples/1.6.x/server-deno/examples/users/list-targets.md new file mode 100644 index 0000000000..61ec71f280 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/list-targets.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.listTargets( + '<USER_ID>', // userId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list.md b/docs/examples/1.6.x/server-deno/examples/users/list.md new file mode 100644 index 0000000000..9415a842ff --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/list.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-deno/examples/users/update-email-verification.md new file mode 100644 index 0000000000..0038cdfdff --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-email-verification.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updateEmailVerification( + '<USER_ID>', // userId + false // emailVerification +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-email.md b/docs/examples/1.6.x/server-deno/examples/users/update-email.md new file mode 100644 index 0000000000..3088e7f7dd --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-email.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updateEmail( + '<USER_ID>', // userId + 'email@example.com' // email +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-labels.md b/docs/examples/1.6.x/server-deno/examples/users/update-labels.md new file mode 100644 index 0000000000..bd4d330140 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-labels.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updateLabels( + '<USER_ID>', // userId + [] // labels +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..b3fbbbb674 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updateMfaRecoveryCodes( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-mfa.md b/docs/examples/1.6.x/server-deno/examples/users/update-mfa.md new file mode 100644 index 0000000000..bf66612077 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-mfa.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updateMfa( + '<USER_ID>', // userId + false // mfa +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-name.md b/docs/examples/1.6.x/server-deno/examples/users/update-name.md new file mode 100644 index 0000000000..e7e59c6091 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-name.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updateName( + '<USER_ID>', // userId + '<NAME>' // name +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-password.md b/docs/examples/1.6.x/server-deno/examples/users/update-password.md new file mode 100644 index 0000000000..dc678f833c --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-password.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updatePassword( + '<USER_ID>', // userId + '' // password +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-deno/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..df9acac575 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-phone-verification.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updatePhoneVerification( + '<USER_ID>', // userId + false // phoneVerification +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-phone.md b/docs/examples/1.6.x/server-deno/examples/users/update-phone.md new file mode 100644 index 0000000000..63d7cb8030 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-phone.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updatePhone( + '<USER_ID>', // userId + '+12065550100' // number +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-prefs.md b/docs/examples/1.6.x/server-deno/examples/users/update-prefs.md new file mode 100644 index 0000000000..b5e24815d3 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-prefs.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updatePrefs( + '<USER_ID>', // userId + {} // prefs +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-status.md b/docs/examples/1.6.x/server-deno/examples/users/update-status.md new file mode 100644 index 0000000000..79c846fbd6 --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-status.md @@ -0,0 +1,13 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updateStatus( + '<USER_ID>', // userId + false // status +); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-target.md b/docs/examples/1.6.x/server-deno/examples/users/update-target.md new file mode 100644 index 0000000000..614e019fee --- /dev/null +++ b/docs/examples/1.6.x/server-deno/examples/users/update-target.md @@ -0,0 +1,16 @@ +import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new Users(client); + +const response = await users.updateTarget( + '<USER_ID>', // userId + '<TARGET_ID>', // targetId + '<IDENTIFIER>', // identifier (optional) + '<PROVIDER_ID>', // providerId (optional) + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..840ecff650 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-anonymous-session.md @@ -0,0 +1,11 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +Session result = await account.CreateAnonymousSession(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..f9b982f2d7 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-email-password-session.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +Session result = await account.CreateEmailPasswordSession( + email: "email@example.com", + password: "password" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-email-token.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-email-token.md new file mode 100644 index 0000000000..fd770b280c --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-email-token.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +Token result = await account.CreateEmailToken( + userId: "<USER_ID>", + email: "email@example.com", + phrase: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..b70daadc74 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-j-w-t.md @@ -0,0 +1,11 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +JWT result = await account.CreateJWT(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..3ca10c0b5a --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +Token result = await account.CreateMagicURLToken( + userId: "<USER_ID>", + email: "email@example.com", + url: "https://example.com", // optional + phrase: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..f30f8ddc83 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-authenticator.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +MfaType result = await account.CreateMfaAuthenticator( + type: AuthenticatorType.Totp +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..b719c23b6b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-challenge.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +MfaChallenge result = await account.CreateMfaChallenge( + factor: AuthenticationFactor.Email +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..4b1b97ff72 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +MfaRecoveryCodes result = await account.CreateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..6fcbd7b063 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-o-auth2token.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +await account.CreateOAuth2Token( + provider: OAuthProvider.Amazon, + success: "https://example.com", // optional + failure: "https://example.com", // optional + scopes: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-token.md new file mode 100644 index 0000000000..df58414cba --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-token.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +Token result = await account.CreatePhoneToken( + userId: "<USER_ID>", + phone: "+12065550100" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..23ea8b1996 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-verification.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +Token result = await account.CreatePhoneVerification(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-recovery.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-recovery.md new file mode 100644 index 0000000000..d86edcf048 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-recovery.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +Token result = await account.CreateRecovery( + email: "email@example.com", + url: "https://example.com" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-session.md new file mode 100644 index 0000000000..9b33e5ba93 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-session.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +Session result = await account.CreateSession( + userId: "<USER_ID>", + secret: "<SECRET>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-verification.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-verification.md new file mode 100644 index 0000000000..7fd8668786 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create-verification.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +Token result = await account.CreateVerification( + url: "https://example.com" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create.md b/docs/examples/1.6.x/server-dotnet/examples/account/create.md new file mode 100644 index 0000000000..5073fa5606 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/create.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +User result = await account.Create( + userId: "<USER_ID>", + email: "email@example.com", + password: "", + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/delete-identity.md b/docs/examples/1.6.x/server-dotnet/examples/account/delete-identity.md new file mode 100644 index 0000000000..0c54a3c677 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/delete-identity.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +await account.DeleteIdentity( + identityId: "<IDENTITY_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-dotnet/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..8cb1ac7956 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +await account.DeleteMfaAuthenticator( + type: AuthenticatorType.Totp +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/delete-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/delete-session.md new file mode 100644 index 0000000000..a2ae74662c --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/delete-session.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +await account.DeleteSession( + sessionId: "<SESSION_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-dotnet/examples/account/delete-sessions.md new file mode 100644 index 0000000000..e892d1d93b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/delete-sessions.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +await account.DeleteSessions(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..8aa3376b31 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +MfaRecoveryCodes result = await account.GetMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/get-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/account/get-prefs.md new file mode 100644 index 0000000000..d65405a455 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/get-prefs.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +Preferences result = await account.GetPrefs(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/get-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/get-session.md new file mode 100644 index 0000000000..55ff7fb1cb --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/get-session.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +Session result = await account.GetSession( + sessionId: "<SESSION_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/get.md b/docs/examples/1.6.x/server-dotnet/examples/account/get.md new file mode 100644 index 0000000000..ee8ddface7 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/get.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +User result = await account.Get(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/list-identities.md b/docs/examples/1.6.x/server-dotnet/examples/account/list-identities.md new file mode 100644 index 0000000000..317475f2a3 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/list-identities.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +IdentityList result = await account.ListIdentities( + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/list-logs.md b/docs/examples/1.6.x/server-dotnet/examples/account/list-logs.md new file mode 100644 index 0000000000..1ae4fcbefd --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/list-logs.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +LogList result = await account.ListLogs( + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-dotnet/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..00d818f61f --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/list-mfa-factors.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +MfaFactors result = await account.ListMfaFactors(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/list-sessions.md b/docs/examples/1.6.x/server-dotnet/examples/account/list-sessions.md new file mode 100644 index 0000000000..bf6fdb2567 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/list-sessions.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +SessionList result = await account.ListSessions(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-email.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-email.md new file mode 100644 index 0000000000..990202c952 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-email.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +User result = await account.UpdateEmail( + email: "email@example.com", + password: "password" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..1604d7d0b2 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-m-f-a.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +User result = await account.UpdateMFA( + mfa: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..5964385630 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +Session result = await account.UpdateMagicURLSession( + userId: "<USER_ID>", + secret: "<SECRET>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..8f8cb09ffa --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-authenticator.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +User result = await account.UpdateMfaAuthenticator( + type: AuthenticatorType.Totp, + otp: "<OTP>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..acf51e5093 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-challenge.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + + result = await account.UpdateMfaChallenge( + challengeId: "<CHALLENGE_ID>", + otp: "<OTP>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..2733351ed1 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +MfaRecoveryCodes result = await account.UpdateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-name.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-name.md new file mode 100644 index 0000000000..6979848f72 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-name.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +User result = await account.UpdateName( + name: "<NAME>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-password.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-password.md new file mode 100644 index 0000000000..14aceaa2d1 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-password.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +User result = await account.UpdatePassword( + password: "", + oldPassword: "password" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-session.md new file mode 100644 index 0000000000..f3d6bf5da7 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-session.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +Session result = await account.UpdatePhoneSession( + userId: "<USER_ID>", + secret: "<SECRET>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..e63f1a7cd6 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-verification.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +Token result = await account.UpdatePhoneVerification( + userId: "<USER_ID>", + secret: "<SECRET>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-phone.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-phone.md new file mode 100644 index 0000000000..21ecfa585b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-phone.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +User result = await account.UpdatePhone( + phone: "+12065550100", + password: "password" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-prefs.md new file mode 100644 index 0000000000..a56f3ea7ec --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-prefs.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +User result = await account.UpdatePrefs( + prefs: [object] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-recovery.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-recovery.md new file mode 100644 index 0000000000..6836da6710 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-recovery.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +Token result = await account.UpdateRecovery( + userId: "<USER_ID>", + secret: "<SECRET>", + password: "" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-session.md new file mode 100644 index 0000000000..36c4ad345f --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-session.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +Session result = await account.UpdateSession( + sessionId: "<SESSION_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-status.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-status.md new file mode 100644 index 0000000000..eb66de894b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-status.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +User result = await account.UpdateStatus(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-verification.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-verification.md new file mode 100644 index 0000000000..0a60c554b8 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/account/update-verification.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Account account = new Account(client); + +Token result = await account.UpdateVerification( + userId: "<USER_ID>", + secret: "<SECRET>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-browser.md new file mode 100644 index 0000000000..6c7adb8a5d --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-browser.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +byte[] result = await avatars.GetBrowser( + code: Browser.AvantBrowser, + width: 0, // optional + height: 0, // optional + quality: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..2b6151dfcd --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-credit-card.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +byte[] result = await avatars.GetCreditCard( + code: CreditCard.AmericanExpress, + width: 0, // optional + height: 0, // optional + quality: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..8e6f170200 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-favicon.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +byte[] result = await avatars.GetFavicon( + url: "https://example.com" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-flag.md new file mode 100644 index 0000000000..9e1ac41041 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-flag.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +byte[] result = await avatars.GetFlag( + code: Flag.Afghanistan, + width: 0, // optional + height: 0, // optional + quality: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-image.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-image.md new file mode 100644 index 0000000000..1af7dc05e2 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-image.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +byte[] result = await avatars.GetImage( + url: "https://example.com", + width: 0, // optional + height: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-initials.md new file mode 100644 index 0000000000..745eb47fbc --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-initials.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +byte[] result = await avatars.GetInitials( + name: "<NAME>", // optional + width: 0, // optional + height: 0, // optional + background: "" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..defeb130dc --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-q-r.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +byte[] result = await avatars.GetQR( + text: "<TEXT>", + size: 1, // optional + margin: 0, // optional + download: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..6c6793cb8f --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-boolean-attribute.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeBoolean result = await databases.CreateBooleanAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: false, // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-collection.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-collection.md new file mode 100644 index 0000000000..43fd90d516 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-collection.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +Collection result = await databases.CreateCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + name: "<NAME>", + permissions: ["read("any")"], // optional + documentSecurity: false, // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..b2a35549e1 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-datetime-attribute.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeDatetime result = await databases.CreateDatetimeAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "", // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-document.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-document.md new file mode 100644 index 0000000000..16fa53ca38 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-document.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Databases databases = new Databases(client); + +Document result = await databases.CreateDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: [object], + permissions: ["read("any")"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..ff8a6fbe3c --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-email-attribute.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeEmail result = await databases.CreateEmailAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "email@example.com", // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..6b714e0e1d --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-enum-attribute.md @@ -0,0 +1,20 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeEnum result = await databases.CreateEnumAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + elements: new List<string>(), + required: false, + default: "<DEFAULT>", // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..fc38da07ef --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-float-attribute.md @@ -0,0 +1,21 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeFloat result = await databases.CreateFloatAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, // optional + max: 0, // optional + default: 0, // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-index.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-index.md new file mode 100644 index 0000000000..cee911120d --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-index.md @@ -0,0 +1,20 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +Index result = await databases.CreateIndex( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + type: IndexType.Key, + attributes: new List<string>(), + orders: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..91f8d422a3 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-integer-attribute.md @@ -0,0 +1,21 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeInteger result = await databases.CreateIntegerAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, // optional + max: 0, // optional + default: 0, // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..912c553eba --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-ip-attribute.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeIp result = await databases.CreateIpAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "", // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..a749ab2df2 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-relationship-attribute.md @@ -0,0 +1,22 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeRelationship result = await databases.CreateRelationshipAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + relatedCollectionId: "<RELATED_COLLECTION_ID>", + type: RelationshipType.OneToOne, + twoWay: false, // optional + key: "", // optional + twoWayKey: "", // optional + onDelete: RelationMutate.Cascade // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..09a05c692c --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-string-attribute.md @@ -0,0 +1,21 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeString result = await databases.CreateStringAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + size: 1, + required: false, + default: "<DEFAULT>", // optional + array: false, // optional + encrypt: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..397ba17731 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create-url-attribute.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeUrl result = await databases.CreateUrlAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "https://example.com", // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create.md new file mode 100644 index 0000000000..b8f58e117c --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/create.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +Database result = await databases.Create( + databaseId: "<DATABASE_ID>", + name: "<NAME>", + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..12a702de52 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-attribute.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +await databases.DeleteAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-collection.md new file mode 100644 index 0000000000..0a5e837ac9 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-collection.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +await databases.DeleteCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-document.md b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-document.md new file mode 100644 index 0000000000..b986508afd --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-document.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Databases databases = new Databases(client); + +await databases.DeleteDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-index.md b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-index.md new file mode 100644 index 0000000000..5dd53c0143 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-index.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +await databases.DeleteIndex( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/delete.md b/docs/examples/1.6.x/server-dotnet/examples/databases/delete.md new file mode 100644 index 0000000000..8358d953a3 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/delete.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +await databases.Delete( + databaseId: "<DATABASE_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/get-attribute.md new file mode 100644 index 0000000000..d5ecf81daa --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/get-attribute.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + + result = await databases.GetAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/get-collection.md b/docs/examples/1.6.x/server-dotnet/examples/databases/get-collection.md new file mode 100644 index 0000000000..1fc63dc84b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/get-collection.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +Collection result = await databases.GetCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/get-document.md b/docs/examples/1.6.x/server-dotnet/examples/databases/get-document.md new file mode 100644 index 0000000000..624639a46b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/get-document.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Databases databases = new Databases(client); + +Document result = await databases.GetDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/get-index.md b/docs/examples/1.6.x/server-dotnet/examples/databases/get-index.md new file mode 100644 index 0000000000..c8bef4d687 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/get-index.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +Index result = await databases.GetIndex( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/get.md b/docs/examples/1.6.x/server-dotnet/examples/databases/get.md new file mode 100644 index 0000000000..9ce607c6c5 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/get.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +Database result = await databases.Get( + databaseId: "<DATABASE_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-dotnet/examples/databases/list-attributes.md new file mode 100644 index 0000000000..dd467262a4 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/list-attributes.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeList result = await databases.ListAttributes( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/list-collections.md b/docs/examples/1.6.x/server-dotnet/examples/databases/list-collections.md new file mode 100644 index 0000000000..99341e3e00 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/list-collections.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +CollectionList result = await databases.ListCollections( + databaseId: "<DATABASE_ID>", + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/list-documents.md b/docs/examples/1.6.x/server-dotnet/examples/databases/list-documents.md new file mode 100644 index 0000000000..1cc45b4fec --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/list-documents.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Databases databases = new Databases(client); + +DocumentList result = await databases.ListDocuments( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-dotnet/examples/databases/list-indexes.md new file mode 100644 index 0000000000..ebf0040f9b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/list-indexes.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +IndexList result = await databases.ListIndexes( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/list.md b/docs/examples/1.6.x/server-dotnet/examples/databases/list.md new file mode 100644 index 0000000000..1fe1db1b0d --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/list.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +DatabaseList result = await databases.List( + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..e8356d0f4d --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-boolean-attribute.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeBoolean result = await databases.UpdateBooleanAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-collection.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-collection.md new file mode 100644 index 0000000000..4238bd0597 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-collection.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +Collection result = await databases.UpdateCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + name: "<NAME>", + permissions: ["read("any")"], // optional + documentSecurity: false, // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..da1c6462b4 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-datetime-attribute.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeDatetime result = await databases.UpdateDatetimeAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-document.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-document.md new file mode 100644 index 0000000000..ee57ce6868 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-document.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Databases databases = new Databases(client); + +Document result = await databases.UpdateDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: [object], // optional + permissions: ["read("any")"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..e38a1773d8 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-email-attribute.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeEmail result = await databases.UpdateEmailAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "email@example.com" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..5c1bef8d87 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-enum-attribute.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeEnum result = await databases.UpdateEnumAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + elements: new List<string>(), + required: false, + default: "<DEFAULT>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..ac21ad76ea --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-float-attribute.md @@ -0,0 +1,20 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeFloat result = await databases.UpdateFloatAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0 +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..d15a7658fe --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-integer-attribute.md @@ -0,0 +1,20 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeInteger result = await databases.UpdateIntegerAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0 +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..e5f6dbd573 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-ip-attribute.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeIp result = await databases.UpdateIpAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..20f7831f09 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-relationship-attribute.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeRelationship result = await databases.UpdateRelationshipAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + onDelete: RelationMutate.Cascade // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..87a8d1ef59 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-string-attribute.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeString result = await databases.UpdateStringAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "<DEFAULT>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..9f98a83f46 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update-url-attribute.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +AttributeUrl result = await databases.UpdateUrlAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "https://example.com" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update.md new file mode 100644 index 0000000000..d52854a81b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/databases/update.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +Database result = await databases.Update( + databaseId: "<DATABASE_ID>", + name: "<NAME>", + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/create-build.md b/docs/examples/1.6.x/server-dotnet/examples/functions/create-build.md new file mode 100644 index 0000000000..fab595261f --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/create-build.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + + result = await functions.CreateBuild( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>", + buildId: "<BUILD_ID>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-dotnet/examples/functions/create-deployment.md new file mode 100644 index 0000000000..88333e1ef1 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/create-deployment.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +Deployment result = await functions.CreateDeployment( + functionId: "<FUNCTION_ID>", + code: InputFile.FromPath("./path-to-files/image.jpg"), + activate: false, + entrypoint: "<ENTRYPOINT>", // optional + commands: "<COMMANDS>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/create-execution.md b/docs/examples/1.6.x/server-dotnet/examples/functions/create-execution.md new file mode 100644 index 0000000000..fb688cd01d --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/create-execution.md @@ -0,0 +1,21 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Functions functions = new Functions(client); + +Execution result = await functions.CreateExecution( + functionId: "<FUNCTION_ID>", + body: "<BODY>", // optional + async: false, // optional + path: "<PATH>", // optional + method: ExecutionMethod.GET, // optional + headers: [object], // optional + scheduledAt: "" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/create-variable.md b/docs/examples/1.6.x/server-dotnet/examples/functions/create-variable.md new file mode 100644 index 0000000000..c8aa350af7 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/create-variable.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +Variable result = await functions.CreateVariable( + functionId: "<FUNCTION_ID>", + key: "<KEY>", + value: "<VALUE>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/create.md b/docs/examples/1.6.x/server-dotnet/examples/functions/create.md new file mode 100644 index 0000000000..880a68ce3d --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/create.md @@ -0,0 +1,35 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +Function result = await functions.Create( + functionId: "<FUNCTION_ID>", + name: "<NAME>", + runtime: .Node145, + execute: ["any"], // optional + events: new List<string>(), // optional + schedule: "", // optional + timeout: 1, // optional + enabled: false, // optional + logging: false, // optional + entrypoint: "<ENTRYPOINT>", // optional + commands: "<COMMANDS>", // optional + scopes: new List<string>(), // optional + installationId: "<INSTALLATION_ID>", // optional + providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", // optional + providerBranch: "<PROVIDER_BRANCH>", // optional + providerSilentMode: false, // optional + providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", // optional + templateRepository: "<TEMPLATE_REPOSITORY>", // optional + templateOwner: "<TEMPLATE_OWNER>", // optional + templateRootDirectory: "<TEMPLATE_ROOT_DIRECTORY>", // optional + templateBranch: "<TEMPLATE_BRANCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-dotnet/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..c0aca0d19e --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/delete-deployment.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +await functions.DeleteDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-dotnet/examples/functions/delete-execution.md new file mode 100644 index 0000000000..682d0e3dc8 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/delete-execution.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +await functions.DeleteExecution( + functionId: "<FUNCTION_ID>", + executionId: "<EXECUTION_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-dotnet/examples/functions/delete-variable.md new file mode 100644 index 0000000000..e08c0dfed2 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/delete-variable.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +await functions.DeleteVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/delete.md b/docs/examples/1.6.x/server-dotnet/examples/functions/delete.md new file mode 100644 index 0000000000..2605aec24a --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/delete.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +await functions.Delete( + functionId: "<FUNCTION_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-dotnet/examples/functions/download-deployment.md new file mode 100644 index 0000000000..02fd5a59f1 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/download-deployment.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +byte[] result = await functions.DownloadDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-dotnet/examples/functions/get-deployment.md new file mode 100644 index 0000000000..d19b66ee52 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/get-deployment.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +Deployment result = await functions.GetDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/get-execution.md b/docs/examples/1.6.x/server-dotnet/examples/functions/get-execution.md new file mode 100644 index 0000000000..08fea9f510 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/get-execution.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Functions functions = new Functions(client); + +Execution result = await functions.GetExecution( + functionId: "<FUNCTION_ID>", + executionId: "<EXECUTION_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/get-variable.md b/docs/examples/1.6.x/server-dotnet/examples/functions/get-variable.md new file mode 100644 index 0000000000..a441229209 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/get-variable.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +Variable result = await functions.GetVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/get.md b/docs/examples/1.6.x/server-dotnet/examples/functions/get.md new file mode 100644 index 0000000000..39d846f1a5 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/get.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +Function result = await functions.Get( + functionId: "<FUNCTION_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-dotnet/examples/functions/list-deployments.md new file mode 100644 index 0000000000..8d2f6837ee --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/list-deployments.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +DeploymentList result = await functions.ListDeployments( + functionId: "<FUNCTION_ID>", + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/list-executions.md b/docs/examples/1.6.x/server-dotnet/examples/functions/list-executions.md new file mode 100644 index 0000000000..6e8478a1f2 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/list-executions.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Functions functions = new Functions(client); + +ExecutionList result = await functions.ListExecutions( + functionId: "<FUNCTION_ID>", + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-dotnet/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..8974e02c2b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/list-runtimes.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +RuntimeList result = await functions.ListRuntimes(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/list-variables.md b/docs/examples/1.6.x/server-dotnet/examples/functions/list-variables.md new file mode 100644 index 0000000000..07f25ebc45 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/list-variables.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +VariableList result = await functions.ListVariables( + functionId: "<FUNCTION_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/list.md b/docs/examples/1.6.x/server-dotnet/examples/functions/list.md new file mode 100644 index 0000000000..820647ac83 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/list.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +FunctionList result = await functions.List( + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..bee45aef19 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment-build.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +Build result = await functions.UpdateDeploymentBuild( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment.md new file mode 100644 index 0000000000..12fcb9627c --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +Function result = await functions.UpdateDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/update-variable.md b/docs/examples/1.6.x/server-dotnet/examples/functions/update-variable.md new file mode 100644 index 0000000000..68d700b66b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/update-variable.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +Variable result = await functions.UpdateVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>", + key: "<KEY>", + value: "<VALUE>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/update.md b/docs/examples/1.6.x/server-dotnet/examples/functions/update.md new file mode 100644 index 0000000000..cfea7cd3dc --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/functions/update.md @@ -0,0 +1,31 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +Function result = await functions.Update( + functionId: "<FUNCTION_ID>", + name: "<NAME>", + runtime: .Node145, // optional + execute: ["any"], // optional + events: new List<string>(), // optional + schedule: "", // optional + timeout: 1, // optional + enabled: false, // optional + logging: false, // optional + entrypoint: "<ENTRYPOINT>", // optional + commands: "<COMMANDS>", // optional + scopes: new List<string>(), // optional + installationId: "<INSTALLATION_ID>", // optional + providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", // optional + providerBranch: "<PROVIDER_BRANCH>", // optional + providerSilentMode: false, // optional + providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/graphql/mutation.md b/docs/examples/1.6.x/server-dotnet/examples/graphql/mutation.md new file mode 100644 index 0000000000..ac78156a9a --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/graphql/mutation.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Graphql graphql = new Graphql(client); + +Any result = await graphql.Mutation( + query: [object] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/graphql/query.md b/docs/examples/1.6.x/server-dotnet/examples/graphql/query.md new file mode 100644 index 0000000000..f8ecc7948a --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/graphql/query.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Graphql graphql = new Graphql(client); + +Any result = await graphql.Query( + query: [object] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-antivirus.md new file mode 100644 index 0000000000..e4bfbe5769 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-antivirus.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthAntivirus result = await health.GetAntivirus(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-cache.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-cache.md new file mode 100644 index 0000000000..7c3495c67c --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-cache.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthStatus result = await health.GetCache(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-certificate.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-certificate.md new file mode 100644 index 0000000000..fbab107225 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-certificate.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthCertificate result = await health.GetCertificate( + domain: "" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-d-b.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-d-b.md new file mode 100644 index 0000000000..5b42c312a3 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-d-b.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthStatus result = await health.GetDB(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..3ca51b6474 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-failed-jobs.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetFailedJobs( + name: .V1Database, + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..52d7b1bc74 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-pub-sub.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthStatus result = await health.GetPubSub(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..98d2d10f2b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-builds.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueBuilds( + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..4b7bc7ff33 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-certificates.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueCertificates( + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..e2dec7775e --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-databases.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueDatabases( + name: "<NAME>", // optional + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..924f3785bb --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-deletes.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueDeletes( + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..cfc29fb885 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-functions.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueFunctions( + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..ae0c85e4ea --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-logs.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueLogs( + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..b747dec22e --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-mails.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueMails( + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..bc8d6fcc4d --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-messaging.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueMessaging( + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..92539ea42b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-migrations.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueMigrations( + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..9338172583 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage-dump.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueUsageDump( + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..07e7c4d761 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueUsage( + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..e6da4beac8 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-webhooks.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthQueue result = await health.GetQueueWebhooks( + threshold: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue.md new file mode 100644 index 0000000000..7cd0e355bc --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthStatus result = await health.GetQueue(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-storage-local.md new file mode 100644 index 0000000000..8aa1554008 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-storage-local.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthStatus result = await health.GetStorageLocal(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-storage.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-storage.md new file mode 100644 index 0000000000..445e1f6c28 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-storage.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthStatus result = await health.GetStorage(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-time.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-time.md new file mode 100644 index 0000000000..07297cf4c7 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get-time.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthTime result = await health.GetTime(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get.md b/docs/examples/1.6.x/server-dotnet/examples/health/get.md new file mode 100644 index 0000000000..bac7246117 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/health/get.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +HealthStatus result = await health.Get(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/get.md b/docs/examples/1.6.x/server-dotnet/examples/locale/get.md new file mode 100644 index 0000000000..2739b8f72c --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/locale/get.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +Locale result = await locale.Get(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-codes.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-codes.md new file mode 100644 index 0000000000..ed10936a6c --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/locale/list-codes.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +LocaleCodeList result = await locale.ListCodes(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-continents.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-continents.md new file mode 100644 index 0000000000..bdbcb0e9ed --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/locale/list-continents.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +ContinentList result = await locale.ListContinents(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..bd634fb2f9 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-e-u.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +CountryList result = await locale.ListCountriesEU(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..fc774574b5 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-phones.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +PhoneList result = await locale.ListCountriesPhones(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries.md new file mode 100644 index 0000000000..423611d91f --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +CountryList result = await locale.ListCountries(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-currencies.md new file mode 100644 index 0000000000..248d01727a --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/locale/list-currencies.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +CurrencyList result = await locale.ListCurrencies(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-languages.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-languages.md new file mode 100644 index 0000000000..41ad81c809 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/locale/list-languages.md @@ -0,0 +1,12 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +LanguageList result = await locale.ListLanguages(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..c10bbc0d71 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-apns-provider.md @@ -0,0 +1,21 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.CreateApnsProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + authKey: "<AUTH_KEY>", // optional + authKeyId: "<AUTH_KEY_ID>", // optional + teamId: "<TEAM_ID>", // optional + bundleId: "<BUNDLE_ID>", // optional + sandbox: false, // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-email.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-email.md new file mode 100644 index 0000000000..f6ab5457be --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-email.md @@ -0,0 +1,25 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Message result = await messaging.CreateEmail( + messageId: "<MESSAGE_ID>", + subject: "<SUBJECT>", + content: "<CONTENT>", + topics: new List<string>(), // optional + users: new List<string>(), // optional + targets: new List<string>(), // optional + cc: new List<string>(), // optional + bcc: new List<string>(), // optional + attachments: new List<string>(), // optional + draft: false, // optional + html: false, // optional + scheduledAt: "" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..c48efc389f --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-fcm-provider.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.CreateFcmProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + serviceAccountJSON: [object], // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..034ac71beb --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,23 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.CreateMailgunProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + apiKey: "<API_KEY>", // optional + domain: "<DOMAIN>", // optional + isEuRegion: false, // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "email@example.com", // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..d1442d58c6 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-msg91provider.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.CreateMsg91Provider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + templateId: "<TEMPLATE_ID>", // optional + senderId: "<SENDER_ID>", // optional + authKey: "<AUTH_KEY>", // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-push.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-push.md new file mode 100644 index 0000000000..8b45b8cda9 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-push.md @@ -0,0 +1,29 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Message result = await messaging.CreatePush( + messageId: "<MESSAGE_ID>", + title: "<TITLE>", + body: "<BODY>", + topics: new List<string>(), // optional + users: new List<string>(), // optional + targets: new List<string>(), // optional + data: [object], // optional + action: "<ACTION>", // optional + image: "[ID1:ID2]", // optional + icon: "<ICON>", // optional + sound: "<SOUND>", // optional + color: "<COLOR>", // optional + tag: "<TAG>", // optional + badge: "<BADGE>", // optional + draft: false, // optional + scheduledAt: "" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..12969698bd --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,21 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.CreateSendgridProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + apiKey: "<API_KEY>", // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "email@example.com", // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sms.md new file mode 100644 index 0000000000..d9aa79ff8c --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sms.md @@ -0,0 +1,20 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Message result = await messaging.CreateSms( + messageId: "<MESSAGE_ID>", + content: "<CONTENT>", + topics: new List<string>(), // optional + users: new List<string>(), // optional + targets: new List<string>(), // optional + draft: false, // optional + scheduledAt: "" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..5a2e65f95f --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-smtp-provider.md @@ -0,0 +1,28 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.CreateSmtpProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + host: "<HOST>", + port: 1, // optional + username: "<USERNAME>", // optional + password: "<PASSWORD>", // optional + encryption: SmtpEncryption.None, // optional + autoTLS: false, // optional + mailer: "<MAILER>", // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "email@example.com", // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..ae0bd90e38 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-subscriber.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetJWT("<YOUR_JWT>"); // Your secret JSON Web Token + +Messaging messaging = new Messaging(client); + +Subscriber result = await messaging.CreateSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>", + targetId: "<TARGET_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..8bfe9cfaac --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-telesign-provider.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.CreateTelesignProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", // optional + customerId: "<CUSTOMER_ID>", // optional + apiKey: "<API_KEY>", // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..a9c73f9eb6 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.CreateTextmagicProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", // optional + username: "<USERNAME>", // optional + apiKey: "<API_KEY>", // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-topic.md new file mode 100644 index 0000000000..2d8f78ac15 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-topic.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Topic result = await messaging.CreateTopic( + topicId: "<TOPIC_ID>", + name: "<NAME>", + subscribe: ["any"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..760be4691d --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-twilio-provider.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.CreateTwilioProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", // optional + accountSid: "<ACCOUNT_SID>", // optional + authToken: "<AUTH_TOKEN>", // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..762930d066 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-vonage-provider.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.CreateVonageProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", // optional + apiKey: "<API_KEY>", // optional + apiSecret: "<API_SECRET>", // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..e2ec88d320 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-provider.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +await messaging.DeleteProvider( + providerId: "<PROVIDER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..a2e9fab7e0 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-subscriber.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetJWT("<YOUR_JWT>"); // Your secret JSON Web Token + +Messaging messaging = new Messaging(client); + +await messaging.DeleteSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..807431e5af --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-topic.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +await messaging.DeleteTopic( + topicId: "<TOPIC_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete.md new file mode 100644 index 0000000000..5cbd9c62e9 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +await messaging.Delete( + messageId: "<MESSAGE_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-message.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-message.md new file mode 100644 index 0000000000..48a59fcc36 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-message.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Message result = await messaging.GetMessage( + messageId: "<MESSAGE_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-provider.md new file mode 100644 index 0000000000..7aa8d02086 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-provider.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.GetProvider( + providerId: "<PROVIDER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..addeb0589f --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-subscriber.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Subscriber result = await messaging.GetSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-topic.md new file mode 100644 index 0000000000..3f6adac550 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-topic.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Topic result = await messaging.GetTopic( + topicId: "<TOPIC_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..a391a5f28d --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-message-logs.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +LogList result = await messaging.ListMessageLogs( + messageId: "<MESSAGE_ID>", + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-messages.md new file mode 100644 index 0000000000..ef3beafeca --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-messages.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +MessageList result = await messaging.ListMessages( + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..877fed54ab --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-provider-logs.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +LogList result = await messaging.ListProviderLogs( + providerId: "<PROVIDER_ID>", + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-providers.md new file mode 100644 index 0000000000..c52c95be75 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-providers.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +ProviderList result = await messaging.ListProviders( + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..c63b654167 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +LogList result = await messaging.ListSubscriberLogs( + subscriberId: "<SUBSCRIBER_ID>", + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..6bcd7acbee --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscribers.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +SubscriberList result = await messaging.ListSubscribers( + topicId: "<TOPIC_ID>", + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-targets.md new file mode 100644 index 0000000000..13c616d909 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-targets.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +TargetList result = await messaging.ListTargets( + messageId: "<MESSAGE_ID>", + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..2089b5ea3c --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topic-logs.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +LogList result = await messaging.ListTopicLogs( + topicId: "<TOPIC_ID>", + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topics.md new file mode 100644 index 0000000000..a0d3074673 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topics.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +TopicList result = await messaging.ListTopics( + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..7ac93b80f5 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-apns-provider.md @@ -0,0 +1,21 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.UpdateApnsProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + authKey: "<AUTH_KEY>", // optional + authKeyId: "<AUTH_KEY_ID>", // optional + teamId: "<TEAM_ID>", // optional + bundleId: "<BUNDLE_ID>", // optional + sandbox: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-email.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-email.md new file mode 100644 index 0000000000..2e37a967a8 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-email.md @@ -0,0 +1,25 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Message result = await messaging.UpdateEmail( + messageId: "<MESSAGE_ID>", + topics: new List<string>(), // optional + users: new List<string>(), // optional + targets: new List<string>(), // optional + subject: "<SUBJECT>", // optional + content: "<CONTENT>", // optional + draft: false, // optional + html: false, // optional + cc: new List<string>(), // optional + bcc: new List<string>(), // optional + scheduledAt: "", // optional + attachments: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..363edb346e --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-fcm-provider.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.UpdateFcmProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + serviceAccountJSON: [object] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..8df2b85c4b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,23 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.UpdateMailgunProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + apiKey: "<API_KEY>", // optional + domain: "<DOMAIN>", // optional + isEuRegion: false, // optional + enabled: false, // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "<REPLY_TO_EMAIL>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..4dca186680 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-msg91provider.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.UpdateMsg91Provider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + templateId: "<TEMPLATE_ID>", // optional + senderId: "<SENDER_ID>", // optional + authKey: "<AUTH_KEY>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-push.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-push.md new file mode 100644 index 0000000000..1d68ddfd50 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-push.md @@ -0,0 +1,29 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Message result = await messaging.UpdatePush( + messageId: "<MESSAGE_ID>", + topics: new List<string>(), // optional + users: new List<string>(), // optional + targets: new List<string>(), // optional + title: "<TITLE>", // optional + body: "<BODY>", // optional + data: [object], // optional + action: "<ACTION>", // optional + image: "[ID1:ID2]", // optional + icon: "<ICON>", // optional + sound: "<SOUND>", // optional + color: "<COLOR>", // optional + tag: "<TAG>", // optional + badge: 0, // optional + draft: false, // optional + scheduledAt: "" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..33387e5bc9 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,21 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.UpdateSendgridProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + apiKey: "<API_KEY>", // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "<REPLY_TO_EMAIL>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sms.md new file mode 100644 index 0000000000..8d02a37945 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sms.md @@ -0,0 +1,20 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Message result = await messaging.UpdateSms( + messageId: "<MESSAGE_ID>", + topics: new List<string>(), // optional + users: new List<string>(), // optional + targets: new List<string>(), // optional + content: "<CONTENT>", // optional + draft: false, // optional + scheduledAt: "" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..df288179f7 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-smtp-provider.md @@ -0,0 +1,28 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.UpdateSmtpProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + host: "<HOST>", // optional + port: 1, // optional + username: "<USERNAME>", // optional + password: "<PASSWORD>", // optional + encryption: SmtpEncryption.None, // optional + autoTLS: false, // optional + mailer: "<MAILER>", // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "<REPLY_TO_EMAIL>", // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..a91adf2dff --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-telesign-provider.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.UpdateTelesignProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + customerId: "<CUSTOMER_ID>", // optional + apiKey: "<API_KEY>", // optional + from: "<FROM>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..1d47ac1f57 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.UpdateTextmagicProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + username: "<USERNAME>", // optional + apiKey: "<API_KEY>", // optional + from: "<FROM>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-topic.md new file mode 100644 index 0000000000..8999d6e258 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-topic.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Topic result = await messaging.UpdateTopic( + topicId: "<TOPIC_ID>", + name: "<NAME>", // optional + subscribe: ["any"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..749cb670ed --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-twilio-provider.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.UpdateTwilioProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + accountSid: "<ACCOUNT_SID>", // optional + authToken: "<AUTH_TOKEN>", // optional + from: "<FROM>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..b3c317c349 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-vonage-provider.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +Provider result = await messaging.UpdateVonageProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + apiKey: "<API_KEY>", // optional + apiSecret: "<API_SECRET>", // optional + from: "<FROM>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-dotnet/examples/storage/create-bucket.md new file mode 100644 index 0000000000..d79549155e --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/create-bucket.md @@ -0,0 +1,24 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Storage storage = new Storage(client); + +Bucket result = await storage.CreateBucket( + bucketId: "<BUCKET_ID>", + name: "<NAME>", + permissions: ["read("any")"], // optional + fileSecurity: false, // optional + enabled: false, // optional + maximumFileSize: 1, // optional + allowedFileExtensions: new List<string>(), // optional + compression: .None, // optional + encryption: false, // optional + antivirus: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/create-file.md b/docs/examples/1.6.x/server-dotnet/examples/storage/create-file.md new file mode 100644 index 0000000000..ffeb90d6ef --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/create-file.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +File result = await storage.CreateFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + file: InputFile.FromPath("./path-to-files/image.jpg"), + permissions: ["read("any")"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-dotnet/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..db7af3a4ce --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/delete-bucket.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Storage storage = new Storage(client); + +await storage.DeleteBucket( + bucketId: "<BUCKET_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/delete-file.md b/docs/examples/1.6.x/server-dotnet/examples/storage/delete-file.md new file mode 100644 index 0000000000..fd3eb96d29 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/delete-file.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +await storage.DeleteFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-dotnet/examples/storage/get-bucket.md new file mode 100644 index 0000000000..8c188971f2 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/get-bucket.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Storage storage = new Storage(client); + +Bucket result = await storage.GetBucket( + bucketId: "<BUCKET_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-download.md new file mode 100644 index 0000000000..b274cdfdb6 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-download.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +byte[] result = await storage.GetFileDownload( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..3643747369 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-preview.md @@ -0,0 +1,27 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +byte[] result = await storage.GetFilePreview( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + width: 0, // optional + height: 0, // optional + gravity: ImageGravity.Center, // optional + quality: 0, // optional + borderWidth: 0, // optional + borderColor: "", // optional + borderRadius: 0, // optional + opacity: 0, // optional + rotation: -360, // optional + background: "", // optional + output: ImageFormat.Jpg // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-view.md new file mode 100644 index 0000000000..0356ec1bee --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-view.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +byte[] result = await storage.GetFileView( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file.md b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file.md new file mode 100644 index 0000000000..b861800bc8 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +File result = await storage.GetFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-dotnet/examples/storage/list-buckets.md new file mode 100644 index 0000000000..bdb8f21fe7 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/list-buckets.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Storage storage = new Storage(client); + +BucketList result = await storage.ListBuckets( + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/list-files.md b/docs/examples/1.6.x/server-dotnet/examples/storage/list-files.md new file mode 100644 index 0000000000..84869bb564 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/list-files.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +FileList result = await storage.ListFiles( + bucketId: "<BUCKET_ID>", + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-dotnet/examples/storage/update-bucket.md new file mode 100644 index 0000000000..e4f85a87b0 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/update-bucket.md @@ -0,0 +1,24 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Storage storage = new Storage(client); + +Bucket result = await storage.UpdateBucket( + bucketId: "<BUCKET_ID>", + name: "<NAME>", + permissions: ["read("any")"], // optional + fileSecurity: false, // optional + enabled: false, // optional + maximumFileSize: 1, // optional + allowedFileExtensions: new List<string>(), // optional + compression: .None, // optional + encryption: false, // optional + antivirus: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/update-file.md b/docs/examples/1.6.x/server-dotnet/examples/storage/update-file.md new file mode 100644 index 0000000000..741b74adcc --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/storage/update-file.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +File result = await storage.UpdateFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + name: "<NAME>", // optional + permissions: ["read("any")"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/create-membership.md b/docs/examples/1.6.x/server-dotnet/examples/teams/create-membership.md new file mode 100644 index 0000000000..1e71650c2e --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/create-membership.md @@ -0,0 +1,20 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +Membership result = await teams.CreateMembership( + teamId: "<TEAM_ID>", + roles: new List<string>(), + email: "email@example.com", // optional + userId: "<USER_ID>", // optional + phone: "+12065550100", // optional + url: "https://example.com", // optional + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/create.md b/docs/examples/1.6.x/server-dotnet/examples/teams/create.md new file mode 100644 index 0000000000..10c925a698 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/create.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +Team result = await teams.Create( + teamId: "<TEAM_ID>", + name: "<NAME>", + roles: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-dotnet/examples/teams/delete-membership.md new file mode 100644 index 0000000000..edf88761bb --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/delete-membership.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +await teams.DeleteMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/delete.md b/docs/examples/1.6.x/server-dotnet/examples/teams/delete.md new file mode 100644 index 0000000000..22bd5a8ea4 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/delete.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +await teams.Delete( + teamId: "<TEAM_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/get-membership.md b/docs/examples/1.6.x/server-dotnet/examples/teams/get-membership.md new file mode 100644 index 0000000000..c294385524 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/get-membership.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +Membership result = await teams.GetMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/teams/get-prefs.md new file mode 100644 index 0000000000..ccdccb3935 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/get-prefs.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +Preferences result = await teams.GetPrefs( + teamId: "<TEAM_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/get.md b/docs/examples/1.6.x/server-dotnet/examples/teams/get.md new file mode 100644 index 0000000000..10549a907e --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/get.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +Team result = await teams.Get( + teamId: "<TEAM_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-dotnet/examples/teams/list-memberships.md new file mode 100644 index 0000000000..2125040d94 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/list-memberships.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +MembershipList result = await teams.ListMemberships( + teamId: "<TEAM_ID>", + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/list.md b/docs/examples/1.6.x/server-dotnet/examples/teams/list.md new file mode 100644 index 0000000000..df7ab5e6d3 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/list.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +TeamList result = await teams.List( + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..61de48e1de --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership-status.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +Membership result = await teams.UpdateMembershipStatus( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + userId: "<USER_ID>", + secret: "<SECRET>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership.md b/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership.md new file mode 100644 index 0000000000..40dd9c947f --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +Membership result = await teams.UpdateMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + roles: new List<string>() +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/update-name.md b/docs/examples/1.6.x/server-dotnet/examples/teams/update-name.md new file mode 100644 index 0000000000..fed64a981a --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/update-name.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +Team result = await teams.UpdateName( + teamId: "<TEAM_ID>", + name: "<NAME>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/teams/update-prefs.md new file mode 100644 index 0000000000..4547656acf --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/teams/update-prefs.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +Preferences result = await teams.UpdatePrefs( + teamId: "<TEAM_ID>", + prefs: [object] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-argon2user.md new file mode 100644 index 0000000000..1f7eea86e0 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-argon2user.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.CreateArgon2User( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..c08650a9bb --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-bcrypt-user.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.CreateBcryptUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..d3a3fecc38 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-j-w-t.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +JWT result = await users.CreateJWT( + userId: "<USER_ID>", + sessionId: "<SESSION_ID>", // optional + duration: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..d0f4824ad7 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-m-d5user.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.CreateMD5User( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..4a725f1bcd --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +MfaRecoveryCodes result = await users.CreateMfaRecoveryCodes( + userId: "<USER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..02d164b2fe --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-p-h-pass-user.md @@ -0,0 +1,17 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.CreatePHPassUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..26a660bc9a --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-s-h-a-user.md @@ -0,0 +1,19 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.CreateSHAUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordVersion: PasswordHash.Sha1, // optional + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..0fdb1136dc --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,20 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.CreateScryptModifiedUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordSalt: "<PASSWORD_SALT>", + passwordSaltSeparator: "<PASSWORD_SALT_SEPARATOR>", + passwordSignerKey: "<PASSWORD_SIGNER_KEY>", + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..cd66ae9ea5 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-user.md @@ -0,0 +1,22 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.CreateScryptUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordSalt: "<PASSWORD_SALT>", + passwordCpu: 0, + passwordMemory: 0, + passwordParallel: 0, + passwordLength: 0, + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-session.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-session.md new file mode 100644 index 0000000000..d26cb7e479 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-session.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +Session result = await users.CreateSession( + userId: "<USER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-target.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-target.md new file mode 100644 index 0000000000..3e82d90634 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-target.md @@ -0,0 +1,20 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +Target result = await users.CreateTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>", + providerType: MessagingProviderType.Email, + identifier: "<IDENTIFIER>", + providerId: "<PROVIDER_ID>", // optional + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-token.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-token.md new file mode 100644 index 0000000000..a37e90a8d5 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create-token.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +Token result = await users.CreateToken( + userId: "<USER_ID>", + length: 4, // optional + expire: 60 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create.md b/docs/examples/1.6.x/server-dotnet/examples/users/create.md new file mode 100644 index 0000000000..2a369f9567 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/create.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.Create( + userId: "<USER_ID>", + email: "email@example.com", // optional + phone: "+12065550100", // optional + password: "", // optional + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete-identity.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete-identity.md new file mode 100644 index 0000000000..ec45f5e7e4 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/delete-identity.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +await users.DeleteIdentity( + identityId: "<IDENTITY_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..074c6c6fe2 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,16 @@ +using Appwrite; +using Appwrite.Enums; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +await users.DeleteMfaAuthenticator( + userId: "<USER_ID>", + type: AuthenticatorType.Totp +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete-session.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete-session.md new file mode 100644 index 0000000000..483208d137 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/delete-session.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +await users.DeleteSession( + userId: "<USER_ID>", + sessionId: "<SESSION_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete-sessions.md new file mode 100644 index 0000000000..4d5e68ba3e --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/delete-sessions.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +await users.DeleteSessions( + userId: "<USER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete-target.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete-target.md new file mode 100644 index 0000000000..a0f14ccae8 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/delete-target.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +await users.DeleteTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete.md new file mode 100644 index 0000000000..95e2fcd362 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/delete.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +await users.Delete( + userId: "<USER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..c5a8daadb8 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +MfaRecoveryCodes result = await users.GetMfaRecoveryCodes( + userId: "<USER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/get-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/users/get-prefs.md new file mode 100644 index 0000000000..edfc8cd5a2 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/get-prefs.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +Preferences result = await users.GetPrefs( + userId: "<USER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/get-target.md b/docs/examples/1.6.x/server-dotnet/examples/users/get-target.md new file mode 100644 index 0000000000..6ca5eda798 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/get-target.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +Target result = await users.GetTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/get.md b/docs/examples/1.6.x/server-dotnet/examples/users/get.md new file mode 100644 index 0000000000..58109c4eaa --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/get.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.Get( + userId: "<USER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-identities.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-identities.md new file mode 100644 index 0000000000..b64981ca86 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/list-identities.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +IdentityList result = await users.ListIdentities( + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-logs.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-logs.md new file mode 100644 index 0000000000..75529b31a3 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/list-logs.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +LogList result = await users.ListLogs( + userId: "<USER_ID>", + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-memberships.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-memberships.md new file mode 100644 index 0000000000..e9e6fb739a --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/list-memberships.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +MembershipList result = await users.ListMemberships( + userId: "<USER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..e7d9c8bb97 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/list-mfa-factors.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +MfaFactors result = await users.ListMfaFactors( + userId: "<USER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-sessions.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-sessions.md new file mode 100644 index 0000000000..2b488e1520 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/list-sessions.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +SessionList result = await users.ListSessions( + userId: "<USER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-targets.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-targets.md new file mode 100644 index 0000000000..e6cc0b5748 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/list-targets.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +TargetList result = await users.ListTargets( + userId: "<USER_ID>", + queries: new List<string>() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list.md b/docs/examples/1.6.x/server-dotnet/examples/users/list.md new file mode 100644 index 0000000000..ea880bcaa8 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/list.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +UserList result = await users.List( + queries: new List<string>(), // optional + search: "<SEARCH>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-email-verification.md new file mode 100644 index 0000000000..6154f55524 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-email-verification.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.UpdateEmailVerification( + userId: "<USER_ID>", + emailVerification: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-email.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-email.md new file mode 100644 index 0000000000..1f3e1856be --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-email.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.UpdateEmail( + userId: "<USER_ID>", + email: "email@example.com" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-labels.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-labels.md new file mode 100644 index 0000000000..fd0337916b --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-labels.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.UpdateLabels( + userId: "<USER_ID>", + labels: new List<string>() +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..55a021a7ed --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,14 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +MfaRecoveryCodes result = await users.UpdateMfaRecoveryCodes( + userId: "<USER_ID>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa.md new file mode 100644 index 0000000000..711ca07575 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.UpdateMfa( + userId: "<USER_ID>", + mfa: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-name.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-name.md new file mode 100644 index 0000000000..19add9e9e8 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-name.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.UpdateName( + userId: "<USER_ID>", + name: "<NAME>" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-password.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-password.md new file mode 100644 index 0000000000..b11bb28883 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-password.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.UpdatePassword( + userId: "<USER_ID>", + password: "" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..135359f995 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-phone-verification.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.UpdatePhoneVerification( + userId: "<USER_ID>", + phoneVerification: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-phone.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-phone.md new file mode 100644 index 0000000000..9dd9757ea7 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-phone.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.UpdatePhone( + userId: "<USER_ID>", + number: "+12065550100" +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-prefs.md new file mode 100644 index 0000000000..775fb848a0 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-prefs.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +Preferences result = await users.UpdatePrefs( + userId: "<USER_ID>", + prefs: [object] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-status.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-status.md new file mode 100644 index 0000000000..5e52c4c294 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-status.md @@ -0,0 +1,15 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +User result = await users.UpdateStatus( + userId: "<USER_ID>", + status: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-target.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-target.md new file mode 100644 index 0000000000..0a1387ca43 --- /dev/null +++ b/docs/examples/1.6.x/server-dotnet/examples/users/update-target.md @@ -0,0 +1,18 @@ +using Appwrite; +using Appwrite.Models; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .SetProject("<YOUR_PROJECT_ID>") // Your project ID + .SetKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +Target result = await users.UpdateTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>", + identifier: "<IDENTIFIER>", // optional + providerId: "<PROVIDER_ID>", // optional + name: "<NAME>" // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-graphql/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..92c12acee5 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-anonymous-session.md @@ -0,0 +1,33 @@ +mutation { + accountCreateAnonymousSession { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-graphql/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..931bb4add0 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-email-password-session.md @@ -0,0 +1,36 @@ +mutation { + accountCreateEmailPasswordSession( + email: "email@example.com", + password: "password" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-email-token.md b/docs/examples/1.6.x/server-graphql/examples/account/create-email-token.md new file mode 100644 index 0000000000..de320b45ed --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-email-token.md @@ -0,0 +1,14 @@ +mutation { + accountCreateEmailToken( + userId: "<USER_ID>", + email: "email@example.com", + phrase: false + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-graphql/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..a5204f1256 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-j-w-t.md @@ -0,0 +1,5 @@ +mutation { + accountCreateJWT { + jwt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-graphql/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..4024a5b3a9 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,15 @@ +mutation { + accountCreateMagicURLToken( + userId: "<USER_ID>", + email: "email@example.com", + url: "https://example.com", + phrase: false + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..6b29292494 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-authenticator.md @@ -0,0 +1,8 @@ +mutation { + accountCreateMfaAuthenticator( + type: "totp" + ) { + secret + uri + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..eb5cba127d --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-challenge.md @@ -0,0 +1,10 @@ +mutation { + accountCreateMfaChallenge( + factor: "email" + ) { + _id + _createdAt + userId + expire + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..f39b7d080d --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,5 @@ +mutation { + accountCreateMfaRecoveryCodes { + recoveryCodes + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-graphql/examples/account/create-phone-token.md new file mode 100644 index 0000000000..b56c4eb4e4 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-phone-token.md @@ -0,0 +1,13 @@ +mutation { + accountCreatePhoneToken( + userId: "<USER_ID>", + phone: "+12065550100" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-graphql/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..a4cad59b1a --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-phone-verification.md @@ -0,0 +1,10 @@ +mutation { + accountCreatePhoneVerification { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-recovery.md b/docs/examples/1.6.x/server-graphql/examples/account/create-recovery.md new file mode 100644 index 0000000000..ad31fd82d7 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-recovery.md @@ -0,0 +1,13 @@ +mutation { + accountCreateRecovery( + email: "email@example.com", + url: "https://example.com" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-session.md b/docs/examples/1.6.x/server-graphql/examples/account/create-session.md new file mode 100644 index 0000000000..f473d14207 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-session.md @@ -0,0 +1,36 @@ +mutation { + accountCreateSession( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-verification.md b/docs/examples/1.6.x/server-graphql/examples/account/create-verification.md new file mode 100644 index 0000000000..df50dda529 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create-verification.md @@ -0,0 +1,12 @@ +mutation { + accountCreateVerification( + url: "https://example.com" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create.md b/docs/examples/1.6.x/server-graphql/examples/account/create.md new file mode 100644 index 0000000000..3f8e3c3cf7 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/create.md @@ -0,0 +1,39 @@ +mutation { + accountCreate( + userId: "<USER_ID>", + email: "email@example.com", + password: "", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/delete-identity.md b/docs/examples/1.6.x/server-graphql/examples/account/delete-identity.md new file mode 100644 index 0000000000..f3c2e2e7b9 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/delete-identity.md @@ -0,0 +1,7 @@ +mutation { + accountDeleteIdentity( + identityId: "<IDENTITY_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-graphql/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..fc5486623a --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,7 @@ +mutation { + accountDeleteMfaAuthenticator( + type: "totp" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/delete-session.md b/docs/examples/1.6.x/server-graphql/examples/account/delete-session.md new file mode 100644 index 0000000000..09aff38fdd --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/delete-session.md @@ -0,0 +1,7 @@ +mutation { + accountDeleteSession( + sessionId: "<SESSION_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-graphql/examples/account/delete-sessions.md new file mode 100644 index 0000000000..b0d61daa81 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/delete-sessions.md @@ -0,0 +1,5 @@ +mutation { + accountDeleteSessions { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..e2de72b57f --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,5 @@ +query { + accountGetMfaRecoveryCodes { + recoveryCodes + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/get-prefs.md b/docs/examples/1.6.x/server-graphql/examples/account/get-prefs.md new file mode 100644 index 0000000000..6cb48d2b58 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/get-prefs.md @@ -0,0 +1,5 @@ +query { + accountGetPrefs { + data + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/get-session.md b/docs/examples/1.6.x/server-graphql/examples/account/get-session.md new file mode 100644 index 0000000000..65c824f68b --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/get-session.md @@ -0,0 +1,35 @@ +query { + accountGetSession( + sessionId: "<SESSION_ID>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/get.md b/docs/examples/1.6.x/server-graphql/examples/account/get.md new file mode 100644 index 0000000000..e4db8f0e41 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/get.md @@ -0,0 +1,34 @@ +query { + accountGet { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/list-identities.md b/docs/examples/1.6.x/server-graphql/examples/account/list-identities.md new file mode 100644 index 0000000000..b7a2a6d39a --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/list-identities.md @@ -0,0 +1,19 @@ +query { + accountListIdentities( + queries: [] + ) { + total + identities { + _id + _createdAt + _updatedAt + userId + provider + providerUid + providerEmail + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/list-logs.md b/docs/examples/1.6.x/server-graphql/examples/account/list-logs.md new file mode 100644 index 0000000000..1e17b2f69f --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/list-logs.md @@ -0,0 +1,30 @@ +query { + accountListLogs( + queries: [] + ) { + total + logs { + event + userId + userEmail + userName + mode + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-graphql/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..2a78b901b3 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/list-mfa-factors.md @@ -0,0 +1,8 @@ +query { + accountListMfaFactors { + totp + phone + email + recoveryCode + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/list-sessions.md b/docs/examples/1.6.x/server-graphql/examples/account/list-sessions.md new file mode 100644 index 0000000000..6d45f1d4ae --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/list-sessions.md @@ -0,0 +1,36 @@ +query { + accountListSessions { + total + sessions { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-email.md b/docs/examples/1.6.x/server-graphql/examples/account/update-email.md new file mode 100644 index 0000000000..b207bad4bb --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-email.md @@ -0,0 +1,37 @@ +mutation { + accountUpdateEmail( + email: "email@example.com", + password: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-graphql/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..d2cd3d6ae5 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-m-f-a.md @@ -0,0 +1,36 @@ +mutation { + accountUpdateMFA( + mfa: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-graphql/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..075bc91d17 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,36 @@ +mutation { + accountUpdateMagicURLSession( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..c74062c7d4 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-authenticator.md @@ -0,0 +1,37 @@ +mutation { + accountUpdateMfaAuthenticator( + type: "totp", + otp: "<OTP>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..8237431bcf --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-challenge.md @@ -0,0 +1,8 @@ +mutation { + accountUpdateMfaChallenge( + challengeId: "<CHALLENGE_ID>", + otp: "<OTP>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..e706d2b9d7 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,5 @@ +mutation { + accountUpdateMfaRecoveryCodes { + recoveryCodes + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-name.md b/docs/examples/1.6.x/server-graphql/examples/account/update-name.md new file mode 100644 index 0000000000..850b5760a0 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-name.md @@ -0,0 +1,36 @@ +mutation { + accountUpdateName( + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-password.md b/docs/examples/1.6.x/server-graphql/examples/account/update-password.md new file mode 100644 index 0000000000..5904da0842 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-password.md @@ -0,0 +1,37 @@ +mutation { + accountUpdatePassword( + password: "", + oldPassword: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-graphql/examples/account/update-phone-session.md new file mode 100644 index 0000000000..199e774ab0 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-phone-session.md @@ -0,0 +1,36 @@ +mutation { + accountUpdatePhoneSession( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-graphql/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..dd62298bb9 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-phone-verification.md @@ -0,0 +1,13 @@ +mutation { + accountUpdatePhoneVerification( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-phone.md b/docs/examples/1.6.x/server-graphql/examples/account/update-phone.md new file mode 100644 index 0000000000..408a203300 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-phone.md @@ -0,0 +1,37 @@ +mutation { + accountUpdatePhone( + phone: "+12065550100", + password: "password" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-prefs.md b/docs/examples/1.6.x/server-graphql/examples/account/update-prefs.md new file mode 100644 index 0000000000..40db7b43db --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-prefs.md @@ -0,0 +1,36 @@ +mutation { + accountUpdatePrefs( + prefs: "{}" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-recovery.md b/docs/examples/1.6.x/server-graphql/examples/account/update-recovery.md new file mode 100644 index 0000000000..2d15fdcaa1 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-recovery.md @@ -0,0 +1,14 @@ +mutation { + accountUpdateRecovery( + userId: "<USER_ID>", + secret: "<SECRET>", + password: "" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-session.md b/docs/examples/1.6.x/server-graphql/examples/account/update-session.md new file mode 100644 index 0000000000..29a8979872 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-session.md @@ -0,0 +1,35 @@ +mutation { + accountUpdateSession( + sessionId: "<SESSION_ID>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-status.md b/docs/examples/1.6.x/server-graphql/examples/account/update-status.md new file mode 100644 index 0000000000..aca8c098e7 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-status.md @@ -0,0 +1,34 @@ +mutation { + accountUpdateStatus { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-verification.md b/docs/examples/1.6.x/server-graphql/examples/account/update-verification.md new file mode 100644 index 0000000000..11e63c7da3 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/account/update-verification.md @@ -0,0 +1,13 @@ +mutation { + accountUpdateVerification( + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-browser.md new file mode 100644 index 0000000000..817e1e54c2 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/avatars/get-browser.md @@ -0,0 +1,10 @@ +query { + avatarsGetBrowser( + code: "aa", + width: 0, + height: 0, + quality: 0 + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..e4b5dc18d9 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/avatars/get-credit-card.md @@ -0,0 +1,10 @@ +query { + avatarsGetCreditCard( + code: "amex", + width: 0, + height: 0, + quality: 0 + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..bfea71f498 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/avatars/get-favicon.md @@ -0,0 +1,7 @@ +query { + avatarsGetFavicon( + url: "https://example.com" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-flag.md new file mode 100644 index 0000000000..1502128581 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/avatars/get-flag.md @@ -0,0 +1,10 @@ +query { + avatarsGetFlag( + code: "af", + width: 0, + height: 0, + quality: 0 + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-image.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-image.md new file mode 100644 index 0000000000..3b9aa104dc --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/avatars/get-image.md @@ -0,0 +1,9 @@ +query { + avatarsGetImage( + url: "https://example.com", + width: 0, + height: 0 + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-initials.md new file mode 100644 index 0000000000..51ae36136b --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/avatars/get-initials.md @@ -0,0 +1,10 @@ +query { + avatarsGetInitials( + name: "<NAME>", + width: 0, + height: 0, + background: "" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..a19f218412 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/avatars/get-q-r.md @@ -0,0 +1,10 @@ +query { + avatarsGetQR( + text: "<TEXT>", + size: 1, + margin: 0, + download: false + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..6e969a587e --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-boolean-attribute.md @@ -0,0 +1,18 @@ +mutation { + databasesCreateBooleanAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: false, + array: false + ) { + key + type + status + error + required + array + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-collection.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-collection.md new file mode 100644 index 0000000000..05175cc1e7 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-collection.md @@ -0,0 +1,28 @@ +mutation { + databasesCreateCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + name: "<NAME>", + permissions: ["read("any")"], + documentSecurity: false, + enabled: false + ) { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + documentSecurity + attributes + indexes { + key + type + status + error + attributes + orders + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..fcd5cb37a2 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-datetime-attribute.md @@ -0,0 +1,19 @@ +mutation { + databasesCreateDatetimeAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "", + array: false + ) { + key + type + status + error + required + array + format + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-document.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-document.md new file mode 100644 index 0000000000..4e2d90660b --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-document.md @@ -0,0 +1,17 @@ +mutation { + databasesCreateDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: "{}", + permissions: ["read("any")"] + ) { + _id + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..1f23a23ba7 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-email-attribute.md @@ -0,0 +1,19 @@ +mutation { + databasesCreateEmailAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "email@example.com", + array: false + ) { + key + type + status + error + required + array + format + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..410a7983b4 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-enum-attribute.md @@ -0,0 +1,21 @@ +mutation { + databasesCreateEnumAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + elements: [], + required: false, + default: "<DEFAULT>", + array: false + ) { + key + type + status + error + required + array + elements + format + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..ae6f9f72d6 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-float-attribute.md @@ -0,0 +1,22 @@ +mutation { + databasesCreateFloatAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0, + array: false + ) { + key + type + status + error + required + array + min + max + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-index.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-index.md new file mode 100644 index 0000000000..efc92a798c --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-index.md @@ -0,0 +1,17 @@ +mutation { + databasesCreateIndex( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + type: "key", + attributes: [], + orders: [] + ) { + key + type + status + error + attributes + orders + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..1dc43f6b0d --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-integer-attribute.md @@ -0,0 +1,22 @@ +mutation { + databasesCreateIntegerAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0, + array: false + ) { + key + type + status + error + required + array + min + max + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..b2fd7215a0 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-ip-attribute.md @@ -0,0 +1,19 @@ +mutation { + databasesCreateIpAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "", + array: false + ) { + key + type + status + error + required + array + format + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..ddca20b83a --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-relationship-attribute.md @@ -0,0 +1,25 @@ +mutation { + databasesCreateRelationshipAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + relatedCollectionId: "<RELATED_COLLECTION_ID>", + type: "oneToOne", + twoWay: false, + key: "", + twoWayKey: "", + onDelete: "cascade" + ) { + key + type + status + error + required + array + relatedCollection + relationType + twoWay + twoWayKey + onDelete + side + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..3c290712e9 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-string-attribute.md @@ -0,0 +1,21 @@ +mutation { + databasesCreateStringAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + size: 1, + required: false, + default: "<DEFAULT>", + array: false, + encrypt: false + ) { + key + type + status + error + required + array + size + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..d2a39756c9 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create-url-attribute.md @@ -0,0 +1,19 @@ +mutation { + databasesCreateUrlAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "https://example.com", + array: false + ) { + key + type + status + error + required + array + format + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create.md b/docs/examples/1.6.x/server-graphql/examples/databases/create.md new file mode 100644 index 0000000000..c48e024e7c --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/create.md @@ -0,0 +1,13 @@ +mutation { + databasesCreate( + databaseId: "<DATABASE_ID>", + name: "<NAME>", + enabled: false + ) { + _id + name + _createdAt + _updatedAt + enabled + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..af0f9d6615 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/delete-attribute.md @@ -0,0 +1,9 @@ +mutation { + databasesDeleteAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-graphql/examples/databases/delete-collection.md new file mode 100644 index 0000000000..8683bd87a4 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/delete-collection.md @@ -0,0 +1,8 @@ +mutation { + databasesDeleteCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/delete-document.md b/docs/examples/1.6.x/server-graphql/examples/databases/delete-document.md new file mode 100644 index 0000000000..848371bca0 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/delete-document.md @@ -0,0 +1,9 @@ +mutation { + databasesDeleteDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/delete-index.md b/docs/examples/1.6.x/server-graphql/examples/databases/delete-index.md new file mode 100644 index 0000000000..a2389cf9d4 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/delete-index.md @@ -0,0 +1,9 @@ +mutation { + databasesDeleteIndex( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/delete.md b/docs/examples/1.6.x/server-graphql/examples/databases/delete.md new file mode 100644 index 0000000000..7cd4c92341 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/delete.md @@ -0,0 +1,7 @@ +mutation { + databasesDelete( + databaseId: "<DATABASE_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/get-attribute.md new file mode 100644 index 0000000000..873d03b708 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/get-attribute.md @@ -0,0 +1,9 @@ +query { + databasesGetAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/get-collection.md b/docs/examples/1.6.x/server-graphql/examples/databases/get-collection.md new file mode 100644 index 0000000000..f76b71b6ba --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/get-collection.md @@ -0,0 +1,24 @@ +query { + databasesGetCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>" + ) { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + documentSecurity + attributes + indexes { + key + type + status + error + attributes + orders + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/get-document.md b/docs/examples/1.6.x/server-graphql/examples/databases/get-document.md new file mode 100644 index 0000000000..7cff0a18c1 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/get-document.md @@ -0,0 +1,16 @@ +query { + databasesGetDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + queries: [] + ) { + _id + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/get-index.md b/docs/examples/1.6.x/server-graphql/examples/databases/get-index.md new file mode 100644 index 0000000000..de3c44ebe0 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/get-index.md @@ -0,0 +1,14 @@ +query { + databasesGetIndex( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" + ) { + key + type + status + error + attributes + orders + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/get.md b/docs/examples/1.6.x/server-graphql/examples/databases/get.md new file mode 100644 index 0000000000..74c4fe5619 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/get.md @@ -0,0 +1,11 @@ +query { + databasesGet( + databaseId: "<DATABASE_ID>" + ) { + _id + name + _createdAt + _updatedAt + enabled + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-graphql/examples/databases/list-attributes.md new file mode 100644 index 0000000000..660c0945a7 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/list-attributes.md @@ -0,0 +1,10 @@ +query { + databasesListAttributes( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [] + ) { + total + attributes + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/list-collections.md b/docs/examples/1.6.x/server-graphql/examples/databases/list-collections.md new file mode 100644 index 0000000000..b821b6c4cf --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/list-collections.md @@ -0,0 +1,28 @@ +query { + databasesListCollections( + databaseId: "<DATABASE_ID>", + queries: [], + search: "<SEARCH>" + ) { + total + collections { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + documentSecurity + attributes + indexes { + key + type + status + error + attributes + orders + } + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/list-documents.md b/docs/examples/1.6.x/server-graphql/examples/databases/list-documents.md new file mode 100644 index 0000000000..077d7c8f12 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/list-documents.md @@ -0,0 +1,18 @@ +query { + databasesListDocuments( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [] + ) { + total + documents { + _id + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-graphql/examples/databases/list-indexes.md new file mode 100644 index 0000000000..e1c11b6c03 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/list-indexes.md @@ -0,0 +1,17 @@ +query { + databasesListIndexes( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [] + ) { + total + indexes { + key + type + status + error + attributes + orders + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/list.md b/docs/examples/1.6.x/server-graphql/examples/databases/list.md new file mode 100644 index 0000000000..1adf3d3b48 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/list.md @@ -0,0 +1,15 @@ +query { + databasesList( + queries: [], + search: "<SEARCH>" + ) { + total + databases { + _id + name + _createdAt + _updatedAt + enabled + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..4c9aa62ef0 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-boolean-attribute.md @@ -0,0 +1,17 @@ +mutation { + databasesUpdateBooleanAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: false + ) { + key + type + status + error + required + array + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-collection.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-collection.md new file mode 100644 index 0000000000..fc78bb8efc --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-collection.md @@ -0,0 +1,28 @@ +mutation { + databasesUpdateCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + name: "<NAME>", + permissions: ["read("any")"], + documentSecurity: false, + enabled: false + ) { + _id + _createdAt + _updatedAt + _permissions + databaseId + name + enabled + documentSecurity + attributes + indexes { + key + type + status + error + attributes + orders + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..3da4483837 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-datetime-attribute.md @@ -0,0 +1,18 @@ +mutation { + databasesUpdateDatetimeAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "" + ) { + key + type + status + error + required + array + format + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-document.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-document.md new file mode 100644 index 0000000000..5e80894620 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-document.md @@ -0,0 +1,17 @@ +mutation { + databasesUpdateDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: "{}", + permissions: ["read("any")"] + ) { + _id + _collectionId + _databaseId + _createdAt + _updatedAt + _permissions + data + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..36dd14d646 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-email-attribute.md @@ -0,0 +1,18 @@ +mutation { + databasesUpdateEmailAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "email@example.com" + ) { + key + type + status + error + required + array + format + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..f2954f070f --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-enum-attribute.md @@ -0,0 +1,20 @@ +mutation { + databasesUpdateEnumAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + elements: [], + required: false, + default: "<DEFAULT>" + ) { + key + type + status + error + required + array + elements + format + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..de987485a7 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-float-attribute.md @@ -0,0 +1,21 @@ +mutation { + databasesUpdateFloatAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0 + ) { + key + type + status + error + required + array + min + max + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..34ceca93af --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-integer-attribute.md @@ -0,0 +1,21 @@ +mutation { + databasesUpdateIntegerAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0 + ) { + key + type + status + error + required + array + min + max + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..a3a2aec585 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-ip-attribute.md @@ -0,0 +1,18 @@ +mutation { + databasesUpdateIpAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "" + ) { + key + type + status + error + required + array + format + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..aa994f14ae --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-relationship-attribute.md @@ -0,0 +1,21 @@ +mutation { + databasesUpdateRelationshipAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + onDelete: "cascade" + ) { + key + type + status + error + required + array + relatedCollection + relationType + twoWay + twoWayKey + onDelete + side + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..cc98a1a177 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-string-attribute.md @@ -0,0 +1,18 @@ +mutation { + databasesUpdateStringAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "<DEFAULT>" + ) { + key + type + status + error + required + array + size + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..e94723efe1 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update-url-attribute.md @@ -0,0 +1,18 @@ +mutation { + databasesUpdateUrlAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "https://example.com" + ) { + key + type + status + error + required + array + format + default + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update.md b/docs/examples/1.6.x/server-graphql/examples/databases/update.md new file mode 100644 index 0000000000..88d286dc8a --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/databases/update.md @@ -0,0 +1,13 @@ +mutation { + databasesUpdate( + databaseId: "<DATABASE_ID>", + name: "<NAME>", + enabled: false + ) { + _id + name + _createdAt + _updatedAt + enabled + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/create-build.md b/docs/examples/1.6.x/server-graphql/examples/functions/create-build.md new file mode 100644 index 0000000000..b9b711eac0 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/create-build.md @@ -0,0 +1,9 @@ +mutation { + functionsCreateBuild( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>", + buildId: "<BUILD_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-graphql/examples/functions/create-deployment.md new file mode 100644 index 0000000000..a6a01aae53 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/create-deployment.md @@ -0,0 +1,24 @@ +POST /v1/functions/{functionId}/deployments HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> +Content-Length: *Length of your entity body in bytes* + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="operations" + +{ "query": "mutation { functionsCreateDeployment(functionId: $functionId, code: $code, activate: $activate, entrypoint: $entrypoint, commands: $commands) { id }" }, "variables": { "functionId": "<FUNCTION_ID>", "code": null, "activate": false, "entrypoint": "<ENTRYPOINT>", "commands": "<COMMANDS>" } } + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="map" + +{ "0": ["variables.code"], } + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="0"; filename="code.ext" + +File contents + +--cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/create-execution.md b/docs/examples/1.6.x/server-graphql/examples/functions/create-execution.md new file mode 100644 index 0000000000..be459ee5ab --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/create-execution.md @@ -0,0 +1,34 @@ +mutation { + functionsCreateExecution( + functionId: "<FUNCTION_ID>", + body: "<BODY>", + async: false, + path: "<PATH>", + method: "GET", + headers: "{}", + scheduledAt: "" + ) { + _id + _createdAt + _updatedAt + _permissions + functionId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/create-variable.md b/docs/examples/1.6.x/server-graphql/examples/functions/create-variable.md new file mode 100644 index 0000000000..9f67458e7b --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/create-variable.md @@ -0,0 +1,15 @@ +mutation { + functionsCreateVariable( + functionId: "<FUNCTION_ID>", + key: "<KEY>", + value: "<VALUE>" + ) { + _id + _createdAt + _updatedAt + key + value + resourceType + resourceId + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/create.md b/docs/examples/1.6.x/server-graphql/examples/functions/create.md new file mode 100644 index 0000000000..9cc14dacda --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/create.md @@ -0,0 +1,57 @@ +mutation { + functionsCreate( + functionId: "<FUNCTION_ID>", + name: "<NAME>", + runtime: "node-14.5", + execute: ["any"], + events: [], + schedule: "", + timeout: 1, + enabled: false, + logging: false, + entrypoint: "<ENTRYPOINT>", + commands: "<COMMANDS>", + scopes: [], + installationId: "<INSTALLATION_ID>", + providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", + providerBranch: "<PROVIDER_BRANCH>", + providerSilentMode: false, + providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", + templateRepository: "<TEMPLATE_REPOSITORY>", + templateOwner: "<TEMPLATE_OWNER>", + templateRootDirectory: "<TEMPLATE_ROOT_DIRECTORY>", + templateBranch: "<TEMPLATE_BRANCH>" + ) { + _id + _createdAt + _updatedAt + execute + name + enabled + live + logging + runtime + deployment + scopes + vars { + _id + _createdAt + _updatedAt + key + value + resourceType + resourceId + } + events + schedule + timeout + entrypoint + commands + version + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-graphql/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..8d83f28d4f --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/delete-deployment.md @@ -0,0 +1,8 @@ +mutation { + functionsDeleteDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-graphql/examples/functions/delete-execution.md new file mode 100644 index 0000000000..c6e950afc9 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/delete-execution.md @@ -0,0 +1,8 @@ +mutation { + functionsDeleteExecution( + functionId: "<FUNCTION_ID>", + executionId: "<EXECUTION_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-graphql/examples/functions/delete-variable.md new file mode 100644 index 0000000000..9bc2d9b6e6 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/delete-variable.md @@ -0,0 +1,8 @@ +mutation { + functionsDeleteVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/delete.md b/docs/examples/1.6.x/server-graphql/examples/functions/delete.md new file mode 100644 index 0000000000..db019bf376 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/delete.md @@ -0,0 +1,7 @@ +mutation { + functionsDelete( + functionId: "<FUNCTION_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-graphql/examples/functions/download-deployment.md new file mode 100644 index 0000000000..f791338765 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/download-deployment.md @@ -0,0 +1,8 @@ +query { + functionsDownloadDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-graphql/examples/functions/get-deployment.md new file mode 100644 index 0000000000..1e1e7208a3 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/get-deployment.md @@ -0,0 +1,30 @@ +query { + functionsGetDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + size + buildId + activate + status + buildLogs + buildTime + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerBranch + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranchUrl + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/get-execution.md b/docs/examples/1.6.x/server-graphql/examples/functions/get-execution.md new file mode 100644 index 0000000000..f9f8ef0552 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/get-execution.md @@ -0,0 +1,29 @@ +query { + functionsGetExecution( + functionId: "<FUNCTION_ID>", + executionId: "<EXECUTION_ID>" + ) { + _id + _createdAt + _updatedAt + _permissions + functionId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/get-variable.md b/docs/examples/1.6.x/server-graphql/examples/functions/get-variable.md new file mode 100644 index 0000000000..cd683f0dbd --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/get-variable.md @@ -0,0 +1,14 @@ +query { + functionsGetVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>" + ) { + _id + _createdAt + _updatedAt + key + value + resourceType + resourceId + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/get.md b/docs/examples/1.6.x/server-graphql/examples/functions/get.md new file mode 100644 index 0000000000..8d38535c55 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/get.md @@ -0,0 +1,37 @@ +query { + functionsGet( + functionId: "<FUNCTION_ID>" + ) { + _id + _createdAt + _updatedAt + execute + name + enabled + live + logging + runtime + deployment + scopes + vars { + _id + _createdAt + _updatedAt + key + value + resourceType + resourceId + } + events + schedule + timeout + entrypoint + commands + version + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-graphql/examples/functions/list-deployments.md new file mode 100644 index 0000000000..b736744384 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/list-deployments.md @@ -0,0 +1,34 @@ +query { + functionsListDeployments( + functionId: "<FUNCTION_ID>", + queries: [], + search: "<SEARCH>" + ) { + total + deployments { + _id + _createdAt + _updatedAt + type + resourceId + resourceType + entrypoint + size + buildId + activate + status + buildLogs + buildTime + providerRepositoryName + providerRepositoryOwner + providerRepositoryUrl + providerBranch + providerCommitHash + providerCommitAuthorUrl + providerCommitAuthor + providerCommitMessage + providerCommitUrl + providerBranchUrl + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/list-executions.md b/docs/examples/1.6.x/server-graphql/examples/functions/list-executions.md new file mode 100644 index 0000000000..745ec32377 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/list-executions.md @@ -0,0 +1,33 @@ +query { + functionsListExecutions( + functionId: "<FUNCTION_ID>", + queries: [], + search: "<SEARCH>" + ) { + total + executions { + _id + _createdAt + _updatedAt + _permissions + functionId + trigger + status + requestMethod + requestPath + requestHeaders { + name + value + } + responseStatusCode + responseBody + responseHeaders { + name + value + } + logs + errors + duration + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-graphql/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..2c2b207e60 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/list-runtimes.md @@ -0,0 +1,14 @@ +query { + functionsListRuntimes { + total + runtimes { + _id + name + version + base + image + logo + supports + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/list-variables.md b/docs/examples/1.6.x/server-graphql/examples/functions/list-variables.md new file mode 100644 index 0000000000..583107bd2e --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/list-variables.md @@ -0,0 +1,16 @@ +query { + functionsListVariables( + functionId: "<FUNCTION_ID>" + ) { + total + variables { + _id + _createdAt + _updatedAt + key + value + resourceType + resourceId + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/list.md b/docs/examples/1.6.x/server-graphql/examples/functions/list.md new file mode 100644 index 0000000000..0b022dda6d --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/list.md @@ -0,0 +1,41 @@ +query { + functionsList( + queries: [], + search: "<SEARCH>" + ) { + total + functions { + _id + _createdAt + _updatedAt + execute + name + enabled + live + logging + runtime + deployment + scopes + vars { + _id + _createdAt + _updatedAt + key + value + resourceType + resourceId + } + events + schedule + timeout + entrypoint + commands + version + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..484d4b39ce --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment-build.md @@ -0,0 +1,16 @@ +mutation { + functionsUpdateDeploymentBuild( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + _id + deploymentId + status + stdout + stderr + startTime + endTime + duration + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment.md new file mode 100644 index 0000000000..580a503f03 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment.md @@ -0,0 +1,38 @@ +mutation { + functionsUpdateDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" + ) { + _id + _createdAt + _updatedAt + execute + name + enabled + live + logging + runtime + deployment + scopes + vars { + _id + _createdAt + _updatedAt + key + value + resourceType + resourceId + } + events + schedule + timeout + entrypoint + commands + version + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/update-variable.md b/docs/examples/1.6.x/server-graphql/examples/functions/update-variable.md new file mode 100644 index 0000000000..7f7fe4aab7 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/update-variable.md @@ -0,0 +1,16 @@ +mutation { + functionsUpdateVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>", + key: "<KEY>", + value: "<VALUE>" + ) { + _id + _createdAt + _updatedAt + key + value + resourceType + resourceId + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/update.md b/docs/examples/1.6.x/server-graphql/examples/functions/update.md new file mode 100644 index 0000000000..cd2caec0b1 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/functions/update.md @@ -0,0 +1,53 @@ +mutation { + functionsUpdate( + functionId: "<FUNCTION_ID>", + name: "<NAME>", + runtime: "node-14.5", + execute: ["any"], + events: [], + schedule: "", + timeout: 1, + enabled: false, + logging: false, + entrypoint: "<ENTRYPOINT>", + commands: "<COMMANDS>", + scopes: [], + installationId: "<INSTALLATION_ID>", + providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", + providerBranch: "<PROVIDER_BRANCH>", + providerSilentMode: false, + providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>" + ) { + _id + _createdAt + _updatedAt + execute + name + enabled + live + logging + runtime + deployment + scopes + vars { + _id + _createdAt + _updatedAt + key + value + resourceType + resourceId + } + events + schedule + timeout + entrypoint + commands + version + installationId + providerRepositoryId + providerBranch + providerRootDirectory + providerSilentMode + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-graphql/examples/health/get-antivirus.md new file mode 100644 index 0000000000..3634dc11c1 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-antivirus.md @@ -0,0 +1,6 @@ +query { + healthGetAntivirus { + version + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-cache.md b/docs/examples/1.6.x/server-graphql/examples/health/get-cache.md new file mode 100644 index 0000000000..3db4076257 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-cache.md @@ -0,0 +1,7 @@ +query { + healthGetCache { + name + ping + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-certificate.md b/docs/examples/1.6.x/server-graphql/examples/health/get-certificate.md new file mode 100644 index 0000000000..91356f8512 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-certificate.md @@ -0,0 +1,12 @@ +query { + healthGetCertificate( + domain: "" + ) { + name + subjectSN + issuerOrganisation + validFrom + validTo + signatureTypeSN + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-d-b.md b/docs/examples/1.6.x/server-graphql/examples/health/get-d-b.md new file mode 100644 index 0000000000..16e67c674e --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-d-b.md @@ -0,0 +1,7 @@ +query { + healthGetDB { + name + ping + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-graphql/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..ca17166a89 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-failed-jobs.md @@ -0,0 +1,8 @@ +query { + healthGetFailedJobs( + name: "v1-database", + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-graphql/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..cec6469b31 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-pub-sub.md @@ -0,0 +1,7 @@ +query { + healthGetPubSub { + name + ping + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..26fb7f89fa --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-builds.md @@ -0,0 +1,7 @@ +query { + healthGetQueueBuilds( + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..8073528cc6 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-certificates.md @@ -0,0 +1,7 @@ +query { + healthGetQueueCertificates( + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..3e77623903 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-databases.md @@ -0,0 +1,8 @@ +query { + healthGetQueueDatabases( + name: "<NAME>", + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..8e7dedcf54 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-deletes.md @@ -0,0 +1,7 @@ +query { + healthGetQueueDeletes( + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..a827c9a143 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-functions.md @@ -0,0 +1,7 @@ +query { + healthGetQueueFunctions( + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..96c93304bd --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-logs.md @@ -0,0 +1,7 @@ +query { + healthGetQueueLogs( + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..a30747567b --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-mails.md @@ -0,0 +1,7 @@ +query { + healthGetQueueMails( + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..9209550b11 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-messaging.md @@ -0,0 +1,7 @@ +query { + healthGetQueueMessaging( + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..99fd99134d --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-migrations.md @@ -0,0 +1,7 @@ +query { + healthGetQueueMigrations( + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..0c8d1dcd42 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage-dump.md @@ -0,0 +1,7 @@ +query { + healthGetQueueUsageDump( + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..2d9f7cb14b --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage.md @@ -0,0 +1,7 @@ +query { + healthGetQueueUsage( + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..3e95e2fc0d --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-webhooks.md @@ -0,0 +1,7 @@ +query { + healthGetQueueWebhooks( + threshold: 0 + ) { + size + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue.md new file mode 100644 index 0000000000..721501e4bb --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-queue.md @@ -0,0 +1,7 @@ +query { + healthGetQueue { + name + ping + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-graphql/examples/health/get-storage-local.md new file mode 100644 index 0000000000..953af346ae --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-storage-local.md @@ -0,0 +1,7 @@ +query { + healthGetStorageLocal { + name + ping + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-storage.md b/docs/examples/1.6.x/server-graphql/examples/health/get-storage.md new file mode 100644 index 0000000000..d7161df205 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-storage.md @@ -0,0 +1,7 @@ +query { + healthGetStorage { + name + ping + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-time.md b/docs/examples/1.6.x/server-graphql/examples/health/get-time.md new file mode 100644 index 0000000000..0def76b9ad --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get-time.md @@ -0,0 +1,7 @@ +query { + healthGetTime { + remoteTime + localTime + diff + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get.md b/docs/examples/1.6.x/server-graphql/examples/health/get.md new file mode 100644 index 0000000000..8481d3625a --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/health/get.md @@ -0,0 +1,7 @@ +query { + healthGet { + name + ping + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/get.md b/docs/examples/1.6.x/server-graphql/examples/locale/get.md new file mode 100644 index 0000000000..2b2bbcc1f1 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/locale/get.md @@ -0,0 +1,11 @@ +query { + localeGet { + ip + countryCode + country + continentCode + continent + eu + currency + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-codes.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-codes.md new file mode 100644 index 0000000000..0164cc3782 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/locale/list-codes.md @@ -0,0 +1,9 @@ +query { + localeListCodes { + total + localeCodes { + code + name + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-continents.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-continents.md new file mode 100644 index 0000000000..41f672c565 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/locale/list-continents.md @@ -0,0 +1,9 @@ +query { + localeListContinents { + total + continents { + name + code + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..00cd4652f9 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-e-u.md @@ -0,0 +1,9 @@ +query { + localeListCountriesEU { + total + countries { + name + code + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..33d2296850 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-phones.md @@ -0,0 +1,10 @@ +query { + localeListCountriesPhones { + total + phones { + code + countryCode + countryName + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-countries.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-countries.md new file mode 100644 index 0000000000..9312bc94b1 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/locale/list-countries.md @@ -0,0 +1,9 @@ +query { + localeListCountries { + total + countries { + name + code + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-currencies.md new file mode 100644 index 0000000000..cde3ab488a --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/locale/list-currencies.md @@ -0,0 +1,14 @@ +query { + localeListCurrencies { + total + currencies { + symbol + name + symbolNative + decimalDigits + rounding + code + namePlural + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-languages.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-languages.md new file mode 100644 index 0000000000..b0d76c522b --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/locale/list-languages.md @@ -0,0 +1,10 @@ +query { + localeListLanguages { + total + languages { + name + code + nativeName + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..425b3bb8dc --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-apns-provider.md @@ -0,0 +1,22 @@ +mutation { + messagingCreateApnsProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + authKey: "<AUTH_KEY>", + authKeyId: "<AUTH_KEY_ID>", + teamId: "<TEAM_ID>", + bundleId: "<BUNDLE_ID>", + sandbox: false, + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-email.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-email.md new file mode 100644 index 0000000000..a1e35aad19 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-email.md @@ -0,0 +1,30 @@ +mutation { + messagingCreateEmail( + messageId: "<MESSAGE_ID>", + subject: "<SUBJECT>", + content: "<CONTENT>", + topics: [], + users: [], + targets: [], + cc: [], + bcc: [], + attachments: [], + draft: false, + html: false, + scheduledAt: "" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..0aa48a9e2f --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-fcm-provider.md @@ -0,0 +1,18 @@ +mutation { + messagingCreateFcmProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + serviceAccountJSON: "{}", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..9da1e23847 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,24 @@ +mutation { + messagingCreateMailgunProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + apiKey: "<API_KEY>", + domain: "<DOMAIN>", + isEuRegion: false, + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "email@example.com", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..ddaf2d4c2b --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-msg91provider.md @@ -0,0 +1,20 @@ +mutation { + messagingCreateMsg91Provider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + templateId: "<TEMPLATE_ID>", + senderId: "<SENDER_ID>", + authKey: "<AUTH_KEY>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-push.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-push.md new file mode 100644 index 0000000000..3084c97635 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-push.md @@ -0,0 +1,34 @@ +mutation { + messagingCreatePush( + messageId: "<MESSAGE_ID>", + title: "<TITLE>", + body: "<BODY>", + topics: [], + users: [], + targets: [], + data: "{}", + action: "<ACTION>", + image: "[ID1:ID2]", + icon: "<ICON>", + sound: "<SOUND>", + color: "<COLOR>", + tag: "<TAG>", + badge: "<BADGE>", + draft: false, + scheduledAt: "" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..cda0652d67 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,22 @@ +mutation { + messagingCreateSendgridProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + apiKey: "<API_KEY>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "email@example.com", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-sms.md new file mode 100644 index 0000000000..99af83b154 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-sms.md @@ -0,0 +1,25 @@ +mutation { + messagingCreateSms( + messageId: "<MESSAGE_ID>", + content: "<CONTENT>", + topics: [], + users: [], + targets: [], + draft: false, + scheduledAt: "" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..b7b24bc1a5 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-smtp-provider.md @@ -0,0 +1,28 @@ +mutation { + messagingCreateSmtpProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + host: "<HOST>", + port: 1, + username: "<USERNAME>", + password: "<PASSWORD>", + encryption: "none", + autoTLS: false, + mailer: "<MAILER>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "email@example.com", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..b2712ebb48 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-subscriber.md @@ -0,0 +1,26 @@ +mutation { + messagingCreateSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>", + targetId: "<TARGET_ID>" + ) { + _id + _createdAt + _updatedAt + targetId + target { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + userId + userName + topicId + providerType + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..7960a8427f --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-telesign-provider.md @@ -0,0 +1,20 @@ +mutation { + messagingCreateTelesignProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", + customerId: "<CUSTOMER_ID>", + apiKey: "<API_KEY>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..e082097b70 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,20 @@ +mutation { + messagingCreateTextmagicProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", + username: "<USERNAME>", + apiKey: "<API_KEY>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-topic.md new file mode 100644 index 0000000000..6216c4cda5 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-topic.md @@ -0,0 +1,16 @@ +mutation { + messagingCreateTopic( + topicId: "<TOPIC_ID>", + name: "<NAME>", + subscribe: ["any"] + ) { + _id + _createdAt + _updatedAt + name + emailTotal + smsTotal + pushTotal + subscribe + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..ac14d1d32b --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-twilio-provider.md @@ -0,0 +1,20 @@ +mutation { + messagingCreateTwilioProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", + accountSid: "<ACCOUNT_SID>", + authToken: "<AUTH_TOKEN>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..ca7a710896 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/create-vonage-provider.md @@ -0,0 +1,20 @@ +mutation { + messagingCreateVonageProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", + apiKey: "<API_KEY>", + apiSecret: "<API_SECRET>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..8d9ac35953 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/delete-provider.md @@ -0,0 +1,7 @@ +mutation { + messagingDeleteProvider( + providerId: "<PROVIDER_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-graphql/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..ededffcaac --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/delete-subscriber.md @@ -0,0 +1,8 @@ +mutation { + messagingDeleteSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-graphql/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..e49cd1ed91 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/delete-topic.md @@ -0,0 +1,7 @@ +mutation { + messagingDeleteTopic( + topicId: "<TOPIC_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/delete.md b/docs/examples/1.6.x/server-graphql/examples/messaging/delete.md new file mode 100644 index 0000000000..495557ef18 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/delete.md @@ -0,0 +1,7 @@ +mutation { + messagingDelete( + messageId: "<MESSAGE_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/get-message.md b/docs/examples/1.6.x/server-graphql/examples/messaging/get-message.md new file mode 100644 index 0000000000..a6824cd911 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/get-message.md @@ -0,0 +1,19 @@ +query { + messagingGetMessage( + messageId: "<MESSAGE_ID>" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/get-provider.md new file mode 100644 index 0000000000..03fb039be2 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/get-provider.md @@ -0,0 +1,15 @@ +query { + messagingGetProvider( + providerId: "<PROVIDER_ID>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-graphql/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..54096dd70a --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/get-subscriber.md @@ -0,0 +1,25 @@ +query { + messagingGetSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>" + ) { + _id + _createdAt + _updatedAt + targetId + target { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + userId + userName + topicId + providerType + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-graphql/examples/messaging/get-topic.md new file mode 100644 index 0000000000..7f0dd01ee6 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/get-topic.md @@ -0,0 +1,14 @@ +query { + messagingGetTopic( + topicId: "<TOPIC_ID>" + ) { + _id + _createdAt + _updatedAt + name + emailTotal + smsTotal + pushTotal + subscribe + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..b1e32d8e99 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/list-message-logs.md @@ -0,0 +1,31 @@ +query { + messagingListMessageLogs( + messageId: "<MESSAGE_ID>", + queries: [] + ) { + total + logs { + event + userId + userEmail + userName + mode + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-messages.md new file mode 100644 index 0000000000..7cdf05c7d8 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/list-messages.md @@ -0,0 +1,23 @@ +query { + messagingListMessages( + queries: [], + search: "<SEARCH>" + ) { + total + messages { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..69df6fa06d --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/list-provider-logs.md @@ -0,0 +1,31 @@ +query { + messagingListProviderLogs( + providerId: "<PROVIDER_ID>", + queries: [] + ) { + total + logs { + event + userId + userEmail + userName + mode + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-providers.md new file mode 100644 index 0000000000..d7ae7b16ba --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/list-providers.md @@ -0,0 +1,19 @@ +query { + messagingListProviders( + queries: [], + search: "<SEARCH>" + ) { + total + providers { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..23e117a07d --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,31 @@ +query { + messagingListSubscriberLogs( + subscriberId: "<SUBSCRIBER_ID>", + queries: [] + ) { + total + logs { + event + userId + userEmail + userName + mode + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..5c48ae34bb --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscribers.md @@ -0,0 +1,29 @@ +query { + messagingListSubscribers( + topicId: "<TOPIC_ID>", + queries: [], + search: "<SEARCH>" + ) { + total + subscribers { + _id + _createdAt + _updatedAt + targetId + target { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + userId + userName + topicId + providerType + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-targets.md new file mode 100644 index 0000000000..8e356dce5f --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/list-targets.md @@ -0,0 +1,18 @@ +query { + messagingListTargets( + messageId: "<MESSAGE_ID>", + queries: [] + ) { + total + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..0b0a5f9a4b --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/list-topic-logs.md @@ -0,0 +1,31 @@ +query { + messagingListTopicLogs( + topicId: "<TOPIC_ID>", + queries: [] + ) { + total + logs { + event + userId + userEmail + userName + mode + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-topics.md new file mode 100644 index 0000000000..4b36c92511 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/list-topics.md @@ -0,0 +1,18 @@ +query { + messagingListTopics( + queries: [], + search: "<SEARCH>" + ) { + total + topics { + _id + _createdAt + _updatedAt + name + emailTotal + smsTotal + pushTotal + subscribe + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..b3d6e8745e --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-apns-provider.md @@ -0,0 +1,22 @@ +mutation { + messagingUpdateApnsProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + authKey: "<AUTH_KEY>", + authKeyId: "<AUTH_KEY_ID>", + teamId: "<TEAM_ID>", + bundleId: "<BUNDLE_ID>", + sandbox: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-email.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-email.md new file mode 100644 index 0000000000..1d1302efc4 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-email.md @@ -0,0 +1,30 @@ +mutation { + messagingUpdateEmail( + messageId: "<MESSAGE_ID>", + topics: [], + users: [], + targets: [], + subject: "<SUBJECT>", + content: "<CONTENT>", + draft: false, + html: false, + cc: [], + bcc: [], + scheduledAt: "", + attachments: [] + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..a0b3f9e3da --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-fcm-provider.md @@ -0,0 +1,18 @@ +mutation { + messagingUpdateFcmProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + serviceAccountJSON: "{}" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..6c26d52ff2 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,24 @@ +mutation { + messagingUpdateMailgunProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + apiKey: "<API_KEY>", + domain: "<DOMAIN>", + isEuRegion: false, + enabled: false, + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "<REPLY_TO_EMAIL>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..a6552a4734 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-msg91provider.md @@ -0,0 +1,20 @@ +mutation { + messagingUpdateMsg91Provider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + templateId: "<TEMPLATE_ID>", + senderId: "<SENDER_ID>", + authKey: "<AUTH_KEY>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-push.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-push.md new file mode 100644 index 0000000000..9039792573 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-push.md @@ -0,0 +1,34 @@ +mutation { + messagingUpdatePush( + messageId: "<MESSAGE_ID>", + topics: [], + users: [], + targets: [], + title: "<TITLE>", + body: "<BODY>", + data: "{}", + action: "<ACTION>", + image: "[ID1:ID2]", + icon: "<ICON>", + sound: "<SOUND>", + color: "<COLOR>", + tag: "<TAG>", + badge: 0, + draft: false, + scheduledAt: "" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..319dcea461 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,22 @@ +mutation { + messagingUpdateSendgridProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + apiKey: "<API_KEY>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "<REPLY_TO_EMAIL>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-sms.md new file mode 100644 index 0000000000..7b45f09abc --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-sms.md @@ -0,0 +1,25 @@ +mutation { + messagingUpdateSms( + messageId: "<MESSAGE_ID>", + topics: [], + users: [], + targets: [], + content: "<CONTENT>", + draft: false, + scheduledAt: "" + ) { + _id + _createdAt + _updatedAt + providerType + topics + users + targets + scheduledAt + deliveredAt + deliveryErrors + deliveredTotal + data + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..a091685655 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-smtp-provider.md @@ -0,0 +1,28 @@ +mutation { + messagingUpdateSmtpProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + host: "<HOST>", + port: 1, + username: "<USERNAME>", + password: "<PASSWORD>", + encryption: "none", + autoTLS: false, + mailer: "<MAILER>", + fromName: "<FROM_NAME>", + fromEmail: "email@example.com", + replyToName: "<REPLY_TO_NAME>", + replyToEmail: "<REPLY_TO_EMAIL>", + enabled: false + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..c9c96c0d5d --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-telesign-provider.md @@ -0,0 +1,20 @@ +mutation { + messagingUpdateTelesignProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + customerId: "<CUSTOMER_ID>", + apiKey: "<API_KEY>", + from: "<FROM>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..3fd68ed8e9 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,20 @@ +mutation { + messagingUpdateTextmagicProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + username: "<USERNAME>", + apiKey: "<API_KEY>", + from: "<FROM>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-topic.md new file mode 100644 index 0000000000..8d3dc84c72 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-topic.md @@ -0,0 +1,16 @@ +mutation { + messagingUpdateTopic( + topicId: "<TOPIC_ID>", + name: "<NAME>", + subscribe: ["any"] + ) { + _id + _createdAt + _updatedAt + name + emailTotal + smsTotal + pushTotal + subscribe + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..6f10839567 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-twilio-provider.md @@ -0,0 +1,20 @@ +mutation { + messagingUpdateTwilioProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + accountSid: "<ACCOUNT_SID>", + authToken: "<AUTH_TOKEN>", + from: "<FROM>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..f42670a428 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/messaging/update-vonage-provider.md @@ -0,0 +1,20 @@ +mutation { + messagingUpdateVonageProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + enabled: false, + apiKey: "<API_KEY>", + apiSecret: "<API_SECRET>", + from: "<FROM>" + ) { + _id + _createdAt + _updatedAt + name + provider + enabled + type + credentials + options + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-graphql/examples/storage/create-bucket.md new file mode 100644 index 0000000000..45d03802d2 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/create-bucket.md @@ -0,0 +1,27 @@ +mutation { + storageCreateBucket( + bucketId: "<BUCKET_ID>", + name: "<NAME>", + permissions: ["read("any")"], + fileSecurity: false, + enabled: false, + maximumFileSize: 1, + allowedFileExtensions: [], + compression: "none", + encryption: false, + antivirus: false + ) { + _id + _createdAt + _updatedAt + _permissions + fileSecurity + name + enabled + maximumFileSize + allowedFileExtensions + compression + encryption + antivirus + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/create-file.md b/docs/examples/1.6.x/server-graphql/examples/storage/create-file.md new file mode 100644 index 0000000000..f77747cd79 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/create-file.md @@ -0,0 +1,26 @@ +POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> +Content-Length: *Length of your entity body in bytes* + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="operations" + +{ "query": "mutation { storageCreateFile(bucketId: $bucketId, fileId: $fileId, file: $file, permissions: $permissions) { id }" }, "variables": { "bucketId": "<BUCKET_ID>", "fileId": "<FILE_ID>", "file": null, "permissions": ["read("any")"] } } + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="map" + +{ "0": ["variables.file"], } + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="0"; filename="file.ext" + +File contents + +--cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-graphql/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..3dadd1f072 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/delete-bucket.md @@ -0,0 +1,7 @@ +mutation { + storageDeleteBucket( + bucketId: "<BUCKET_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/delete-file.md b/docs/examples/1.6.x/server-graphql/examples/storage/delete-file.md new file mode 100644 index 0000000000..17ec89931a --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/delete-file.md @@ -0,0 +1,8 @@ +mutation { + storageDeleteFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-graphql/examples/storage/get-bucket.md new file mode 100644 index 0000000000..4ce0f626ab --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/get-bucket.md @@ -0,0 +1,18 @@ +query { + storageGetBucket( + bucketId: "<BUCKET_ID>" + ) { + _id + _createdAt + _updatedAt + _permissions + fileSecurity + name + enabled + maximumFileSize + allowedFileExtensions + compression + encryption + antivirus + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-graphql/examples/storage/get-file-download.md new file mode 100644 index 0000000000..8325e8a230 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/get-file-download.md @@ -0,0 +1,8 @@ +query { + storageGetFileDownload( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-graphql/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..df32e88350 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/get-file-preview.md @@ -0,0 +1,19 @@ +query { + storageGetFilePreview( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + width: 0, + height: 0, + gravity: "center", + quality: 0, + borderWidth: 0, + borderColor: "", + borderRadius: 0, + opacity: 0, + rotation: -360, + background: "", + output: "jpg" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-graphql/examples/storage/get-file-view.md new file mode 100644 index 0000000000..434328a1ec --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/get-file-view.md @@ -0,0 +1,8 @@ +query { + storageGetFileView( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/get-file.md b/docs/examples/1.6.x/server-graphql/examples/storage/get-file.md new file mode 100644 index 0000000000..60886b0f6f --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/get-file.md @@ -0,0 +1,18 @@ +query { + storageGetFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" + ) { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + chunksTotal + chunksUploaded + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-graphql/examples/storage/list-buckets.md new file mode 100644 index 0000000000..e4d636ccde --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/list-buckets.md @@ -0,0 +1,22 @@ +query { + storageListBuckets( + queries: [], + search: "<SEARCH>" + ) { + total + buckets { + _id + _createdAt + _updatedAt + _permissions + fileSecurity + name + enabled + maximumFileSize + allowedFileExtensions + compression + encryption + antivirus + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/list-files.md b/docs/examples/1.6.x/server-graphql/examples/storage/list-files.md new file mode 100644 index 0000000000..774cc51b97 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/list-files.md @@ -0,0 +1,22 @@ +query { + storageListFiles( + bucketId: "<BUCKET_ID>", + queries: [], + search: "<SEARCH>" + ) { + total + files { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + chunksTotal + chunksUploaded + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-graphql/examples/storage/update-bucket.md new file mode 100644 index 0000000000..8265a15a58 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/update-bucket.md @@ -0,0 +1,27 @@ +mutation { + storageUpdateBucket( + bucketId: "<BUCKET_ID>", + name: "<NAME>", + permissions: ["read("any")"], + fileSecurity: false, + enabled: false, + maximumFileSize: 1, + allowedFileExtensions: [], + compression: "none", + encryption: false, + antivirus: false + ) { + _id + _createdAt + _updatedAt + _permissions + fileSecurity + name + enabled + maximumFileSize + allowedFileExtensions + compression + encryption + antivirus + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/update-file.md b/docs/examples/1.6.x/server-graphql/examples/storage/update-file.md new file mode 100644 index 0000000000..b7832048c7 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/storage/update-file.md @@ -0,0 +1,20 @@ +mutation { + storageUpdateFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + name: "<NAME>", + permissions: ["read("any")"] + ) { + _id + bucketId + _createdAt + _updatedAt + _permissions + name + signature + mimeType + sizeOriginal + chunksTotal + chunksUploaded + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/create-membership.md b/docs/examples/1.6.x/server-graphql/examples/teams/create-membership.md new file mode 100644 index 0000000000..fe741f080d --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/create-membership.md @@ -0,0 +1,25 @@ +mutation { + teamsCreateMembership( + teamId: "<TEAM_ID>", + roles: [], + email: "email@example.com", + userId: "<USER_ID>", + phone: "+12065550100", + url: "https://example.com", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + teamId + teamName + invited + joined + confirm + mfa + roles + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/create.md b/docs/examples/1.6.x/server-graphql/examples/teams/create.md new file mode 100644 index 0000000000..1f2a7ab3f2 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/create.md @@ -0,0 +1,16 @@ +mutation { + teamsCreate( + teamId: "<TEAM_ID>", + name: "<NAME>", + roles: [] + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-graphql/examples/teams/delete-membership.md new file mode 100644 index 0000000000..e391b6f6fa --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/delete-membership.md @@ -0,0 +1,8 @@ +mutation { + teamsDeleteMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/delete.md b/docs/examples/1.6.x/server-graphql/examples/teams/delete.md new file mode 100644 index 0000000000..df0d36c5b5 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/delete.md @@ -0,0 +1,7 @@ +mutation { + teamsDelete( + teamId: "<TEAM_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/get-membership.md b/docs/examples/1.6.x/server-graphql/examples/teams/get-membership.md new file mode 100644 index 0000000000..c33528609e --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/get-membership.md @@ -0,0 +1,20 @@ +query { + teamsGetMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + teamId + teamName + invited + joined + confirm + mfa + roles + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-graphql/examples/teams/get-prefs.md new file mode 100644 index 0000000000..fe498079cf --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/get-prefs.md @@ -0,0 +1,7 @@ +query { + teamsGetPrefs( + teamId: "<TEAM_ID>" + ) { + data + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/get.md b/docs/examples/1.6.x/server-graphql/examples/teams/get.md new file mode 100644 index 0000000000..a3fbb491e0 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/get.md @@ -0,0 +1,14 @@ +query { + teamsGet( + teamId: "<TEAM_ID>" + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-graphql/examples/teams/list-memberships.md new file mode 100644 index 0000000000..bf7f0d1eed --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/list-memberships.md @@ -0,0 +1,24 @@ +query { + teamsListMemberships( + teamId: "<TEAM_ID>", + queries: [], + search: "<SEARCH>" + ) { + total + memberships { + _id + _createdAt + _updatedAt + userId + userName + userEmail + teamId + teamName + invited + joined + confirm + mfa + roles + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/list.md b/docs/examples/1.6.x/server-graphql/examples/teams/list.md new file mode 100644 index 0000000000..e7005b5326 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/list.md @@ -0,0 +1,18 @@ +query { + teamsList( + queries: [], + search: "<SEARCH>" + ) { + total + teams { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-graphql/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..9b24450a86 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/update-membership-status.md @@ -0,0 +1,22 @@ +mutation { + teamsUpdateMembershipStatus( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + userId: "<USER_ID>", + secret: "<SECRET>" + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + teamId + teamName + invited + joined + confirm + mfa + roles + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/update-membership.md b/docs/examples/1.6.x/server-graphql/examples/teams/update-membership.md new file mode 100644 index 0000000000..1c6a04f078 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/update-membership.md @@ -0,0 +1,21 @@ +mutation { + teamsUpdateMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + roles: [] + ) { + _id + _createdAt + _updatedAt + userId + userName + userEmail + teamId + teamName + invited + joined + confirm + mfa + roles + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/update-name.md b/docs/examples/1.6.x/server-graphql/examples/teams/update-name.md new file mode 100644 index 0000000000..c40543b5cd --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/update-name.md @@ -0,0 +1,15 @@ +mutation { + teamsUpdateName( + teamId: "<TEAM_ID>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + total + prefs { + data + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-graphql/examples/teams/update-prefs.md new file mode 100644 index 0000000000..95737e33f9 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/teams/update-prefs.md @@ -0,0 +1,8 @@ +mutation { + teamsUpdatePrefs( + teamId: "<TEAM_ID>", + prefs: "{}" + ) { + data + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-argon2user.md new file mode 100644 index 0000000000..464dc754c9 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-argon2user.md @@ -0,0 +1,39 @@ +mutation { + usersCreateArgon2User( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..4d4bb09194 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-bcrypt-user.md @@ -0,0 +1,39 @@ +mutation { + usersCreateBcryptUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-graphql/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..bf0b1bd638 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-j-w-t.md @@ -0,0 +1,9 @@ +mutation { + usersCreateJWT( + userId: "<USER_ID>", + sessionId: "<SESSION_ID>", + duration: 0 + ) { + jwt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..e8e833e6de --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-m-d5user.md @@ -0,0 +1,39 @@ +mutation { + usersCreateMD5User( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..7c4f1c5575 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,7 @@ +mutation { + usersCreateMfaRecoveryCodes( + userId: "<USER_ID>" + ) { + recoveryCodes + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..53960e7890 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-p-h-pass-user.md @@ -0,0 +1,39 @@ +mutation { + usersCreatePHPassUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..17e287f8b3 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-s-h-a-user.md @@ -0,0 +1,40 @@ +mutation { + usersCreateSHAUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordVersion: "sha1", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..6d51fb29ba --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,42 @@ +mutation { + usersCreateScryptModifiedUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordSalt: "<PASSWORD_SALT>", + passwordSaltSeparator: "<PASSWORD_SALT_SEPARATOR>", + passwordSignerKey: "<PASSWORD_SIGNER_KEY>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..0d4bac1db8 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-user.md @@ -0,0 +1,44 @@ +mutation { + usersCreateScryptUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordSalt: "<PASSWORD_SALT>", + passwordCpu: 0, + passwordMemory: 0, + passwordParallel: 0, + passwordLength: 0, + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-session.md b/docs/examples/1.6.x/server-graphql/examples/users/create-session.md new file mode 100644 index 0000000000..701ddf501f --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-session.md @@ -0,0 +1,35 @@ +mutation { + usersCreateSession( + userId: "<USER_ID>" + ) { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-target.md b/docs/examples/1.6.x/server-graphql/examples/users/create-target.md new file mode 100644 index 0000000000..a3a0696dec --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-target.md @@ -0,0 +1,19 @@ +mutation { + usersCreateTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>", + providerType: "email", + identifier: "<IDENTIFIER>", + providerId: "<PROVIDER_ID>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-token.md b/docs/examples/1.6.x/server-graphql/examples/users/create-token.md new file mode 100644 index 0000000000..78255f7676 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create-token.md @@ -0,0 +1,14 @@ +mutation { + usersCreateToken( + userId: "<USER_ID>", + length: 4, + expire: 60 + ) { + _id + _createdAt + userId + secret + expire + phrase + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create.md b/docs/examples/1.6.x/server-graphql/examples/users/create.md new file mode 100644 index 0000000000..826a5168ef --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/create.md @@ -0,0 +1,40 @@ +mutation { + usersCreate( + userId: "<USER_ID>", + email: "email@example.com", + phone: "+12065550100", + password: "", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete-identity.md b/docs/examples/1.6.x/server-graphql/examples/users/delete-identity.md new file mode 100644 index 0000000000..1ea0d990b1 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/delete-identity.md @@ -0,0 +1,7 @@ +mutation { + usersDeleteIdentity( + identityId: "<IDENTITY_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-graphql/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..227c340c68 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,37 @@ +mutation { + usersDeleteMfaAuthenticator( + userId: "<USER_ID>", + type: "totp" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete-session.md b/docs/examples/1.6.x/server-graphql/examples/users/delete-session.md new file mode 100644 index 0000000000..7e6538b34a --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/delete-session.md @@ -0,0 +1,8 @@ +mutation { + usersDeleteSession( + userId: "<USER_ID>", + sessionId: "<SESSION_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-graphql/examples/users/delete-sessions.md new file mode 100644 index 0000000000..d1ccaa26f4 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/delete-sessions.md @@ -0,0 +1,7 @@ +mutation { + usersDeleteSessions( + userId: "<USER_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete-target.md b/docs/examples/1.6.x/server-graphql/examples/users/delete-target.md new file mode 100644 index 0000000000..92d0a16ac5 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/delete-target.md @@ -0,0 +1,8 @@ +mutation { + usersDeleteTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete.md b/docs/examples/1.6.x/server-graphql/examples/users/delete.md new file mode 100644 index 0000000000..2cf392b7f1 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/delete.md @@ -0,0 +1,7 @@ +mutation { + usersDelete( + userId: "<USER_ID>" + ) { + status + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..c4ca9f79b4 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,7 @@ +query { + usersGetMfaRecoveryCodes( + userId: "<USER_ID>" + ) { + recoveryCodes + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/get-prefs.md b/docs/examples/1.6.x/server-graphql/examples/users/get-prefs.md new file mode 100644 index 0000000000..fe08758d99 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/get-prefs.md @@ -0,0 +1,7 @@ +query { + usersGetPrefs( + userId: "<USER_ID>" + ) { + data + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/get-target.md b/docs/examples/1.6.x/server-graphql/examples/users/get-target.md new file mode 100644 index 0000000000..e4ba1a04a1 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/get-target.md @@ -0,0 +1,15 @@ +query { + usersGetTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>" + ) { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/get.md b/docs/examples/1.6.x/server-graphql/examples/users/get.md new file mode 100644 index 0000000000..f94a5818ed --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/get.md @@ -0,0 +1,36 @@ +query { + usersGet( + userId: "<USER_ID>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-identities.md b/docs/examples/1.6.x/server-graphql/examples/users/list-identities.md new file mode 100644 index 0000000000..38ab302f38 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/list-identities.md @@ -0,0 +1,20 @@ +query { + usersListIdentities( + queries: [], + search: "<SEARCH>" + ) { + total + identities { + _id + _createdAt + _updatedAt + userId + provider + providerUid + providerEmail + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-logs.md b/docs/examples/1.6.x/server-graphql/examples/users/list-logs.md new file mode 100644 index 0000000000..8594e87b22 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/list-logs.md @@ -0,0 +1,31 @@ +query { + usersListLogs( + userId: "<USER_ID>", + queries: [] + ) { + total + logs { + event + userId + userEmail + userName + mode + ip + time + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-memberships.md b/docs/examples/1.6.x/server-graphql/examples/users/list-memberships.md new file mode 100644 index 0000000000..cf64f61f10 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/list-memberships.md @@ -0,0 +1,22 @@ +query { + usersListMemberships( + userId: "<USER_ID>" + ) { + total + memberships { + _id + _createdAt + _updatedAt + userId + userName + userEmail + teamId + teamName + invited + joined + confirm + mfa + roles + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-graphql/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..12c910835a --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/list-mfa-factors.md @@ -0,0 +1,10 @@ +query { + usersListMfaFactors( + userId: "<USER_ID>" + ) { + totp + phone + email + recoveryCode + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-sessions.md b/docs/examples/1.6.x/server-graphql/examples/users/list-sessions.md new file mode 100644 index 0000000000..1a09c9ffe0 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/list-sessions.md @@ -0,0 +1,38 @@ +query { + usersListSessions( + userId: "<USER_ID>" + ) { + total + sessions { + _id + _createdAt + _updatedAt + userId + expire + provider + providerUid + providerAccessToken + providerAccessTokenExpiry + providerRefreshToken + ip + osCode + osName + osVersion + clientType + clientCode + clientName + clientVersion + clientEngine + clientEngineVersion + deviceName + deviceBrand + deviceModel + countryCode + countryName + current + factors + secret + mfaUpdatedAt + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-targets.md b/docs/examples/1.6.x/server-graphql/examples/users/list-targets.md new file mode 100644 index 0000000000..05e796f167 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/list-targets.md @@ -0,0 +1,18 @@ +query { + usersListTargets( + userId: "<USER_ID>", + queries: [] + ) { + total + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list.md b/docs/examples/1.6.x/server-graphql/examples/users/list.md new file mode 100644 index 0000000000..e2326dd1a2 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/list.md @@ -0,0 +1,40 @@ +query { + usersList( + queries: [], + search: "<SEARCH>" + ) { + total + users { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-graphql/examples/users/update-email-verification.md new file mode 100644 index 0000000000..6bb2781854 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-email-verification.md @@ -0,0 +1,37 @@ +mutation { + usersUpdateEmailVerification( + userId: "<USER_ID>", + emailVerification: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-email.md b/docs/examples/1.6.x/server-graphql/examples/users/update-email.md new file mode 100644 index 0000000000..046937ac04 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-email.md @@ -0,0 +1,37 @@ +mutation { + usersUpdateEmail( + userId: "<USER_ID>", + email: "email@example.com" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-labels.md b/docs/examples/1.6.x/server-graphql/examples/users/update-labels.md new file mode 100644 index 0000000000..93da33d805 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-labels.md @@ -0,0 +1,37 @@ +mutation { + usersUpdateLabels( + userId: "<USER_ID>", + labels: [] + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..dbef2bd345 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,7 @@ +mutation { + usersUpdateMfaRecoveryCodes( + userId: "<USER_ID>" + ) { + recoveryCodes + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-mfa.md b/docs/examples/1.6.x/server-graphql/examples/users/update-mfa.md new file mode 100644 index 0000000000..9219aa1aea --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-mfa.md @@ -0,0 +1,37 @@ +mutation { + usersUpdateMfa( + userId: "<USER_ID>", + mfa: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-name.md b/docs/examples/1.6.x/server-graphql/examples/users/update-name.md new file mode 100644 index 0000000000..01a53ce479 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-name.md @@ -0,0 +1,37 @@ +mutation { + usersUpdateName( + userId: "<USER_ID>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-password.md b/docs/examples/1.6.x/server-graphql/examples/users/update-password.md new file mode 100644 index 0000000000..c95637c4ce --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-password.md @@ -0,0 +1,37 @@ +mutation { + usersUpdatePassword( + userId: "<USER_ID>", + password: "" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-graphql/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..58343ae365 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-phone-verification.md @@ -0,0 +1,37 @@ +mutation { + usersUpdatePhoneVerification( + userId: "<USER_ID>", + phoneVerification: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-phone.md b/docs/examples/1.6.x/server-graphql/examples/users/update-phone.md new file mode 100644 index 0000000000..dbcb076c65 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-phone.md @@ -0,0 +1,37 @@ +mutation { + usersUpdatePhone( + userId: "<USER_ID>", + number: "+12065550100" + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-prefs.md b/docs/examples/1.6.x/server-graphql/examples/users/update-prefs.md new file mode 100644 index 0000000000..431664c2a1 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-prefs.md @@ -0,0 +1,8 @@ +mutation { + usersUpdatePrefs( + userId: "<USER_ID>", + prefs: "{}" + ) { + data + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-status.md b/docs/examples/1.6.x/server-graphql/examples/users/update-status.md new file mode 100644 index 0000000000..ad05bc75ff --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-status.md @@ -0,0 +1,37 @@ +mutation { + usersUpdateStatus( + userId: "<USER_ID>", + status: false + ) { + _id + _createdAt + _updatedAt + name + password + hash + hashOptions + registration + status + labels + passwordUpdate + email + phone + emailVerification + phoneVerification + mfa + prefs { + data + } + targets { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } + accessedAt + } +} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-target.md b/docs/examples/1.6.x/server-graphql/examples/users/update-target.md new file mode 100644 index 0000000000..fe3444ede7 --- /dev/null +++ b/docs/examples/1.6.x/server-graphql/examples/users/update-target.md @@ -0,0 +1,18 @@ +mutation { + usersUpdateTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>", + identifier: "<IDENTIFIER>", + providerId: "<PROVIDER_ID>", + name: "<NAME>" + ) { + _id + _createdAt + _updatedAt + name + userId + providerId + providerType + identifier + } +} diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-anonymous-session.md b/docs/examples/1.6.x/server-kotlin/java/account/create-anonymous-session.md new file mode 100644 index 0000000000..afb56be804 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-anonymous-session.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createAnonymousSession(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-email-password-session.md b/docs/examples/1.6.x/server-kotlin/java/account/create-email-password-session.md new file mode 100644 index 0000000000..88fd5a70ff --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-email-password-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createEmailPasswordSession( + "email@example.com", // email + "password", // password + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-email-token.md b/docs/examples/1.6.x/server-kotlin/java/account/create-email-token.md new file mode 100644 index 0000000000..460f62954f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-email-token.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createEmailToken( + "<USER_ID>", // userId + "email@example.com", // email + false, // phrase (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-j-w-t.md b/docs/examples/1.6.x/server-kotlin/java/account/create-j-w-t.md new file mode 100644 index 0000000000..f22573630b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-j-w-t.md @@ -0,0 +1,18 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createJWT(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-kotlin/java/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..1f54eb392b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-magic-u-r-l-token.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createMagicURLToken( + "<USER_ID>", // userId + "email@example.com", // email + "https://example.com", // url (optional) + false, // phrase (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..717d8dc06f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-authenticator.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; +import io.appwrite.enums.AuthenticatorType; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.createMfaAuthenticator( + AuthenticatorType.TOTP, // type + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-challenge.md new file mode 100644 index 0000000000..6539f6aef8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-challenge.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; +import io.appwrite.enums.AuthenticationFactor; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createMfaChallenge( + AuthenticationFactor.EMAIL, // factor + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..80320549ff --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-recovery-codes.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.createMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-o-auth2token.md b/docs/examples/1.6.x/server-kotlin/java/account/create-o-auth2token.md new file mode 100644 index 0000000000..49831ab0d7 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-o-auth2token.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; +import io.appwrite.enums.OAuthProvider; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createOAuth2Token( + OAuthProvider.AMAZON, // provider + "https://example.com", // success (optional) + "https://example.com", // failure (optional) + listOf(), // scopes (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-phone-token.md b/docs/examples/1.6.x/server-kotlin/java/account/create-phone-token.md new file mode 100644 index 0000000000..1c10fdced0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-phone-token.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createPhoneToken( + "<USER_ID>", // userId + "+12065550100", // phone + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-phone-verification.md b/docs/examples/1.6.x/server-kotlin/java/account/create-phone-verification.md new file mode 100644 index 0000000000..1210764b23 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-phone-verification.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.createPhoneVerification(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-recovery.md b/docs/examples/1.6.x/server-kotlin/java/account/create-recovery.md new file mode 100644 index 0000000000..b7378759e9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-recovery.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.createRecovery( + "email@example.com", // email + "https://example.com", // url + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-session.md b/docs/examples/1.6.x/server-kotlin/java/account/create-session.md new file mode 100644 index 0000000000..d94a033e25 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.createSession( + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-verification.md b/docs/examples/1.6.x/server-kotlin/java/account/create-verification.md new file mode 100644 index 0000000000..cace2e21c2 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create-verification.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.createVerification( + "https://example.com", // url + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create.md b/docs/examples/1.6.x/server-kotlin/java/account/create.md new file mode 100644 index 0000000000..4993399fbf --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/create.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.create( + "<USER_ID>", // userId + "email@example.com", // email + "", // password + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/delete-identity.md b/docs/examples/1.6.x/server-kotlin/java/account/delete-identity.md new file mode 100644 index 0000000000..e79ec7ca31 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/delete-identity.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.deleteIdentity( + "<IDENTITY_ID>", // identityId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/java/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..caec63e106 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/delete-mfa-authenticator.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; +import io.appwrite.enums.AuthenticatorType; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.deleteMfaAuthenticator( + AuthenticatorType.TOTP, // type + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/delete-session.md b/docs/examples/1.6.x/server-kotlin/java/account/delete-session.md new file mode 100644 index 0000000000..31ef4a09bc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/delete-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.deleteSession( + "<SESSION_ID>", // sessionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/delete-sessions.md b/docs/examples/1.6.x/server-kotlin/java/account/delete-sessions.md new file mode 100644 index 0000000000..1243f07336 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/delete-sessions.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.deleteSessions(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..bea98a8709 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/get-mfa-recovery-codes.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.getMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/get-prefs.md b/docs/examples/1.6.x/server-kotlin/java/account/get-prefs.md new file mode 100644 index 0000000000..66278dde9b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/get-prefs.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.getPrefs(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/get-session.md b/docs/examples/1.6.x/server-kotlin/java/account/get-session.md new file mode 100644 index 0000000000..3cdc9bae29 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/get-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.getSession( + "<SESSION_ID>", // sessionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/get.md b/docs/examples/1.6.x/server-kotlin/java/account/get.md new file mode 100644 index 0000000000..bcb05ae9b2 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/get.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.get(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/list-identities.md b/docs/examples/1.6.x/server-kotlin/java/account/list-identities.md new file mode 100644 index 0000000000..ca25eaab38 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/list-identities.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.listIdentities( + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/list-logs.md b/docs/examples/1.6.x/server-kotlin/java/account/list-logs.md new file mode 100644 index 0000000000..cee5a3fbf9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/list-logs.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.listLogs( + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/list-mfa-factors.md b/docs/examples/1.6.x/server-kotlin/java/account/list-mfa-factors.md new file mode 100644 index 0000000000..4cee6beb3c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/list-mfa-factors.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.listMfaFactors(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/list-sessions.md b/docs/examples/1.6.x/server-kotlin/java/account/list-sessions.md new file mode 100644 index 0000000000..0a39b9ffc3 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/list-sessions.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.listSessions(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-email.md b/docs/examples/1.6.x/server-kotlin/java/account/update-email.md new file mode 100644 index 0000000000..ad141ec783 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-email.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updateEmail( + "email@example.com", // email + "password", // password + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-m-f-a.md b/docs/examples/1.6.x/server-kotlin/java/account/update-m-f-a.md new file mode 100644 index 0000000000..c7570cf35a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-m-f-a.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updateMFA( + false, // mfa + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-kotlin/java/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..386d73ce44 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-magic-u-r-l-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updateMagicURLSession( + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..397e02b49f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-authenticator.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; +import io.appwrite.enums.AuthenticatorType; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updateMfaAuthenticator( + AuthenticatorType.TOTP, // type + "<OTP>", // otp + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-challenge.md new file mode 100644 index 0000000000..6ff8166b27 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-challenge.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updateMfaChallenge( + "<CHALLENGE_ID>", // challengeId + "<OTP>", // otp + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..f3f653a8d4 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-recovery-codes.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updateMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-name.md b/docs/examples/1.6.x/server-kotlin/java/account/update-name.md new file mode 100644 index 0000000000..bf366fa6d7 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-name.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updateName( + "<NAME>", // name + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-password.md b/docs/examples/1.6.x/server-kotlin/java/account/update-password.md new file mode 100644 index 0000000000..b896c85778 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-password.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updatePassword( + "", // password + "password", // oldPassword (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-phone-session.md b/docs/examples/1.6.x/server-kotlin/java/account/update-phone-session.md new file mode 100644 index 0000000000..6a8ba10995 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-phone-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>"); // Your project ID + +Account account = new Account(client); + +account.updatePhoneSession( + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-phone-verification.md b/docs/examples/1.6.x/server-kotlin/java/account/update-phone-verification.md new file mode 100644 index 0000000000..0fe5bcb4c8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-phone-verification.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updatePhoneVerification( + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-phone.md b/docs/examples/1.6.x/server-kotlin/java/account/update-phone.md new file mode 100644 index 0000000000..06217d293e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-phone.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updatePhone( + "+12065550100", // phone + "password", // password + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-prefs.md b/docs/examples/1.6.x/server-kotlin/java/account/update-prefs.md new file mode 100644 index 0000000000..aa063a48a1 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-prefs.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updatePrefs( + mapOf( "a" to "b" ), // prefs + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-recovery.md b/docs/examples/1.6.x/server-kotlin/java/account/update-recovery.md new file mode 100644 index 0000000000..e510c8e68b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-recovery.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updateRecovery( + "<USER_ID>", // userId + "<SECRET>", // secret + "", // password + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-session.md b/docs/examples/1.6.x/server-kotlin/java/account/update-session.md new file mode 100644 index 0000000000..a98b4c7f32 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updateSession( + "<SESSION_ID>", // sessionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-status.md b/docs/examples/1.6.x/server-kotlin/java/account/update-status.md new file mode 100644 index 0000000000..3db7321168 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-status.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updateStatus(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-verification.md b/docs/examples/1.6.x/server-kotlin/java/account/update-verification.md new file mode 100644 index 0000000000..6f977a849f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/account/update-verification.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Account; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Account account = new Account(client); + +account.updateVerification( + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-browser.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-browser.md new file mode 100644 index 0000000000..472b13997a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/avatars/get-browser.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; +import io.appwrite.enums.Browser; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +avatars.getBrowser( + Browser.AVANT_BROWSER, // code + 0, // width (optional) + 0, // height (optional) + 0, // quality (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-credit-card.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-credit-card.md new file mode 100644 index 0000000000..078baa931a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/avatars/get-credit-card.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; +import io.appwrite.enums.CreditCard; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +avatars.getCreditCard( + CreditCard.AMERICAN_EXPRESS, // code + 0, // width (optional) + 0, // height (optional) + 0, // quality (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-favicon.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-favicon.md new file mode 100644 index 0000000000..ce323b88dc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/avatars/get-favicon.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +avatars.getFavicon( + "https://example.com", // url + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-flag.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-flag.md new file mode 100644 index 0000000000..26ae93997e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/avatars/get-flag.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; +import io.appwrite.enums.Flag; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +avatars.getFlag( + Flag.AFGHANISTAN, // code + 0, // width (optional) + 0, // height (optional) + 0, // quality (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-image.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-image.md new file mode 100644 index 0000000000..1523a225fc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/avatars/get-image.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +avatars.getImage( + "https://example.com", // url + 0, // width (optional) + 0, // height (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-initials.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-initials.md new file mode 100644 index 0000000000..54ff820c73 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/avatars/get-initials.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +avatars.getInitials( + "<NAME>", // name (optional) + 0, // width (optional) + 0, // height (optional) + "", // background (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-q-r.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-q-r.md new file mode 100644 index 0000000000..479f3de2e2 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/avatars/get-q-r.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Avatars; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Avatars avatars = new Avatars(client); + +avatars.getQR( + "<TEXT>", // text + 1, // size (optional) + 0, // margin (optional) + false, // download (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..d53bc5ce70 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-boolean-attribute.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createBooleanAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + false, // default (optional) + false, // array (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-collection.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-collection.md new file mode 100644 index 0000000000..4e5d750039 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-collection.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createCollection( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "<NAME>", // name + listOf("read("any")"), // permissions (optional) + false, // documentSecurity (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..d68ec098b4 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-datetime-attribute.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createDatetimeAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + "", // default (optional) + false, // array (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-document.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-document.md new file mode 100644 index 0000000000..d97c95b701 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-document.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Databases databases = new Databases(client); + +databases.createDocument( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "<DOCUMENT_ID>", // documentId + mapOf( "a" to "b" ), // data + listOf("read("any")"), // permissions (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-email-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-email-attribute.md new file mode 100644 index 0000000000..bb15a80759 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-email-attribute.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createEmailAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + "email@example.com", // default (optional) + false, // array (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-enum-attribute.md new file mode 100644 index 0000000000..4abe265ef0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-enum-attribute.md @@ -0,0 +1,29 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createEnumAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + listOf(), // elements + false, // required + "<DEFAULT>", // default (optional) + false, // array (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-float-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-float-attribute.md new file mode 100644 index 0000000000..8d915e1aec --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-float-attribute.md @@ -0,0 +1,30 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createFloatAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + 0, // min (optional) + 0, // max (optional) + 0, // default (optional) + false, // array (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-index.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-index.md new file mode 100644 index 0000000000..409c341c5d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-index.md @@ -0,0 +1,29 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; +import io.appwrite.enums.IndexType; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createIndex( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + IndexType.KEY, // type + listOf(), // attributes + listOf(), // orders (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-integer-attribute.md new file mode 100644 index 0000000000..b2eb37aff8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-integer-attribute.md @@ -0,0 +1,30 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createIntegerAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + 0, // min (optional) + 0, // max (optional) + 0, // default (optional) + false, // array (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-ip-attribute.md new file mode 100644 index 0000000000..66492bbd61 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-ip-attribute.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createIpAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + "", // default (optional) + false, // array (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..4e76489755 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-relationship-attribute.md @@ -0,0 +1,31 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; +import io.appwrite.enums.RelationshipType; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createRelationshipAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "<RELATED_COLLECTION_ID>", // relatedCollectionId + RelationshipType.ONETOONE, // type + false, // twoWay (optional) + "", // key (optional) + "", // twoWayKey (optional) + RelationMutate.CASCADE, // onDelete (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-string-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-string-attribute.md new file mode 100644 index 0000000000..64c3f60da2 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-string-attribute.md @@ -0,0 +1,30 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createStringAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + 1, // size + false, // required + "<DEFAULT>", // default (optional) + false, // array (optional) + false, // encrypt (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-url-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-url-attribute.md new file mode 100644 index 0000000000..1c68dc7a0d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create-url-attribute.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.createUrlAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + "https://example.com", // default (optional) + false, // array (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create.md b/docs/examples/1.6.x/server-kotlin/java/databases/create.md new file mode 100644 index 0000000000..a9a13a9573 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/create.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.create( + "<DATABASE_ID>", // databaseId + "<NAME>", // name + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/delete-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/delete-attribute.md new file mode 100644 index 0000000000..48daa6ba8b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/delete-attribute.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.deleteAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/delete-collection.md b/docs/examples/1.6.x/server-kotlin/java/databases/delete-collection.md new file mode 100644 index 0000000000..dfe3c7a787 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/delete-collection.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.deleteCollection( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/delete-document.md b/docs/examples/1.6.x/server-kotlin/java/databases/delete-document.md new file mode 100644 index 0000000000..4d4f552335 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/delete-document.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Databases databases = new Databases(client); + +databases.deleteDocument( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "<DOCUMENT_ID>", // documentId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/delete-index.md b/docs/examples/1.6.x/server-kotlin/java/databases/delete-index.md new file mode 100644 index 0000000000..aa21f3bab2 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/delete-index.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.deleteIndex( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/delete.md b/docs/examples/1.6.x/server-kotlin/java/databases/delete.md new file mode 100644 index 0000000000..137908cedb --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/delete.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.delete( + "<DATABASE_ID>", // databaseId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/get-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/get-attribute.md new file mode 100644 index 0000000000..c413490e11 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/get-attribute.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.getAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/get-collection.md b/docs/examples/1.6.x/server-kotlin/java/databases/get-collection.md new file mode 100644 index 0000000000..271e7bcae5 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/get-collection.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.getCollection( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/get-document.md b/docs/examples/1.6.x/server-kotlin/java/databases/get-document.md new file mode 100644 index 0000000000..3a371f31be --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/get-document.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Databases databases = new Databases(client); + +databases.getDocument( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "<DOCUMENT_ID>", // documentId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/get-index.md b/docs/examples/1.6.x/server-kotlin/java/databases/get-index.md new file mode 100644 index 0000000000..0e8e2114cd --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/get-index.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.getIndex( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/get.md b/docs/examples/1.6.x/server-kotlin/java/databases/get.md new file mode 100644 index 0000000000..8468ea27c9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/get.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.get( + "<DATABASE_ID>", // databaseId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/list-attributes.md b/docs/examples/1.6.x/server-kotlin/java/databases/list-attributes.md new file mode 100644 index 0000000000..198135e8c8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/list-attributes.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.listAttributes( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/list-collections.md b/docs/examples/1.6.x/server-kotlin/java/databases/list-collections.md new file mode 100644 index 0000000000..a45ec1e26b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/list-collections.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.listCollections( + "<DATABASE_ID>", // databaseId + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/list-documents.md b/docs/examples/1.6.x/server-kotlin/java/databases/list-documents.md new file mode 100644 index 0000000000..7b713310ef --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/list-documents.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Databases databases = new Databases(client); + +databases.listDocuments( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/list-indexes.md b/docs/examples/1.6.x/server-kotlin/java/databases/list-indexes.md new file mode 100644 index 0000000000..a68d32ce8f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/list-indexes.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.listIndexes( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/list.md b/docs/examples/1.6.x/server-kotlin/java/databases/list.md new file mode 100644 index 0000000000..4c32c5d710 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/list.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.list( + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..0603e65f68 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-boolean-attribute.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.updateBooleanAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + false, // default + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-collection.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-collection.md new file mode 100644 index 0000000000..635b90a5fa --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-collection.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.updateCollection( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "<NAME>", // name + listOf("read("any")"), // permissions (optional) + false, // documentSecurity (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..fc18da151f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-datetime-attribute.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.updateDatetimeAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + "", // default + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-document.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-document.md new file mode 100644 index 0000000000..640844e7a5 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-document.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Databases databases = new Databases(client); + +databases.updateDocument( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "<DOCUMENT_ID>", // documentId + mapOf( "a" to "b" ), // data (optional) + listOf("read("any")"), // permissions (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-email-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-email-attribute.md new file mode 100644 index 0000000000..bba1515d9a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-email-attribute.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.updateEmailAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + "email@example.com", // default + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-enum-attribute.md new file mode 100644 index 0000000000..c72daa53f7 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-enum-attribute.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.updateEnumAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + listOf(), // elements + false, // required + "<DEFAULT>", // default + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-float-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-float-attribute.md new file mode 100644 index 0000000000..95b53aa41e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-float-attribute.md @@ -0,0 +1,29 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.updateFloatAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + 0, // min + 0, // max + 0, // default + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-integer-attribute.md new file mode 100644 index 0000000000..dbac379835 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-integer-attribute.md @@ -0,0 +1,29 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.updateIntegerAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + 0, // min + 0, // max + 0, // default + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-ip-attribute.md new file mode 100644 index 0000000000..c9b699f37a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-ip-attribute.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.updateIpAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + "", // default + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..b84cbe7877 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-relationship-attribute.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.updateRelationshipAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + RelationMutate.CASCADE, // onDelete (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-string-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-string-attribute.md new file mode 100644 index 0000000000..f314048e86 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-string-attribute.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.updateStringAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + "<DEFAULT>", // default + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-url-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-url-attribute.md new file mode 100644 index 0000000000..6deacfb3e1 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update-url-attribute.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.updateUrlAttribute( + "<DATABASE_ID>", // databaseId + "<COLLECTION_ID>", // collectionId + "", // key + false, // required + "https://example.com", // default + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update.md b/docs/examples/1.6.x/server-kotlin/java/databases/update.md new file mode 100644 index 0000000000..f7b7ee75fb --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/databases/update.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Databases; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Databases databases = new Databases(client); + +databases.update( + "<DATABASE_ID>", // databaseId + "<NAME>", // name + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/create-build.md b/docs/examples/1.6.x/server-kotlin/java/functions/create-build.md new file mode 100644 index 0000000000..7ac366e2dd --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/create-build.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.createBuild( + "<FUNCTION_ID>", // functionId + "<DEPLOYMENT_ID>", // deploymentId + "<BUILD_ID>", // buildId (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/create-deployment.md b/docs/examples/1.6.x/server-kotlin/java/functions/create-deployment.md new file mode 100644 index 0000000000..a798515cef --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/create-deployment.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.models.InputFile; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.createDeployment( + "<FUNCTION_ID>", // functionId + InputFile.fromPath("file.png"), // code + false, // activate + "<ENTRYPOINT>", // entrypoint (optional) + "<COMMANDS>", // commands (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/create-execution.md b/docs/examples/1.6.x/server-kotlin/java/functions/create-execution.md new file mode 100644 index 0000000000..bd293011a7 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/create-execution.md @@ -0,0 +1,29 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Functions functions = new Functions(client); + +functions.createExecution( + "<FUNCTION_ID>", // functionId + "<BODY>", // body (optional) + false, // async (optional) + "<PATH>", // path (optional) + ExecutionMethod.GET, // method (optional) + mapOf( "a" to "b" ), // headers (optional) + "", // scheduledAt (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/create-variable.md b/docs/examples/1.6.x/server-kotlin/java/functions/create-variable.md new file mode 100644 index 0000000000..0190350dc1 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/create-variable.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.createVariable( + "<FUNCTION_ID>", // functionId + "<KEY>", // key + "<VALUE>", // value + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/create.md b/docs/examples/1.6.x/server-kotlin/java/functions/create.md new file mode 100644 index 0000000000..5c577d176a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/create.md @@ -0,0 +1,44 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; +import io.appwrite.enums.Runtime; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.create( + "<FUNCTION_ID>", // functionId + "<NAME>", // name + .NODE_14_5, // runtime + listOf("any"), // execute (optional) + listOf(), // events (optional) + "", // schedule (optional) + 1, // timeout (optional) + false, // enabled (optional) + false, // logging (optional) + "<ENTRYPOINT>", // entrypoint (optional) + "<COMMANDS>", // commands (optional) + listOf(), // scopes (optional) + "<INSTALLATION_ID>", // installationId (optional) + "<PROVIDER_REPOSITORY_ID>", // providerRepositoryId (optional) + "<PROVIDER_BRANCH>", // providerBranch (optional) + false, // providerSilentMode (optional) + "<PROVIDER_ROOT_DIRECTORY>", // providerRootDirectory (optional) + "<TEMPLATE_REPOSITORY>", // templateRepository (optional) + "<TEMPLATE_OWNER>", // templateOwner (optional) + "<TEMPLATE_ROOT_DIRECTORY>", // templateRootDirectory (optional) + "<TEMPLATE_BRANCH>", // templateBranch (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/delete-deployment.md b/docs/examples/1.6.x/server-kotlin/java/functions/delete-deployment.md new file mode 100644 index 0000000000..8394c022bb --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/delete-deployment.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.deleteDeployment( + "<FUNCTION_ID>", // functionId + "<DEPLOYMENT_ID>", // deploymentId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/delete-execution.md b/docs/examples/1.6.x/server-kotlin/java/functions/delete-execution.md new file mode 100644 index 0000000000..05d1146ff0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/delete-execution.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.deleteExecution( + "<FUNCTION_ID>", // functionId + "<EXECUTION_ID>", // executionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/delete-variable.md b/docs/examples/1.6.x/server-kotlin/java/functions/delete-variable.md new file mode 100644 index 0000000000..6de7a49f47 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/delete-variable.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.deleteVariable( + "<FUNCTION_ID>", // functionId + "<VARIABLE_ID>", // variableId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/delete.md b/docs/examples/1.6.x/server-kotlin/java/functions/delete.md new file mode 100644 index 0000000000..cf083dc79e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/delete.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.delete( + "<FUNCTION_ID>", // functionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/download-deployment.md b/docs/examples/1.6.x/server-kotlin/java/functions/download-deployment.md new file mode 100644 index 0000000000..7a05d1d133 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/download-deployment.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.downloadDeployment( + "<FUNCTION_ID>", // functionId + "<DEPLOYMENT_ID>", // deploymentId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/get-deployment.md b/docs/examples/1.6.x/server-kotlin/java/functions/get-deployment.md new file mode 100644 index 0000000000..1b4252fbf4 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/get-deployment.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.getDeployment( + "<FUNCTION_ID>", // functionId + "<DEPLOYMENT_ID>", // deploymentId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/get-execution.md b/docs/examples/1.6.x/server-kotlin/java/functions/get-execution.md new file mode 100644 index 0000000000..e4172cb0c3 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/get-execution.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Functions functions = new Functions(client); + +functions.getExecution( + "<FUNCTION_ID>", // functionId + "<EXECUTION_ID>", // executionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/get-variable.md b/docs/examples/1.6.x/server-kotlin/java/functions/get-variable.md new file mode 100644 index 0000000000..2ef45c0645 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/get-variable.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.getVariable( + "<FUNCTION_ID>", // functionId + "<VARIABLE_ID>", // variableId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/get.md b/docs/examples/1.6.x/server-kotlin/java/functions/get.md new file mode 100644 index 0000000000..ff467f7df4 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/get.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.get( + "<FUNCTION_ID>", // functionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/list-deployments.md b/docs/examples/1.6.x/server-kotlin/java/functions/list-deployments.md new file mode 100644 index 0000000000..c5b9f0d5da --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/list-deployments.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.listDeployments( + "<FUNCTION_ID>", // functionId + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/list-executions.md b/docs/examples/1.6.x/server-kotlin/java/functions/list-executions.md new file mode 100644 index 0000000000..8990b5fe16 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/list-executions.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Functions functions = new Functions(client); + +functions.listExecutions( + "<FUNCTION_ID>", // functionId + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/list-runtimes.md b/docs/examples/1.6.x/server-kotlin/java/functions/list-runtimes.md new file mode 100644 index 0000000000..3fff39063a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/list-runtimes.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.listRuntimes(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/list-variables.md b/docs/examples/1.6.x/server-kotlin/java/functions/list-variables.md new file mode 100644 index 0000000000..8fb1809a46 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/list-variables.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.listVariables( + "<FUNCTION_ID>", // functionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/list.md b/docs/examples/1.6.x/server-kotlin/java/functions/list.md new file mode 100644 index 0000000000..8ec39b4341 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/list.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.list( + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment-build.md b/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment-build.md new file mode 100644 index 0000000000..49aba048b4 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment-build.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.updateDeploymentBuild( + "<FUNCTION_ID>", // functionId + "<DEPLOYMENT_ID>", // deploymentId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment.md b/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment.md new file mode 100644 index 0000000000..2e3e853a73 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.updateDeployment( + "<FUNCTION_ID>", // functionId + "<DEPLOYMENT_ID>", // deploymentId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/update-variable.md b/docs/examples/1.6.x/server-kotlin/java/functions/update-variable.md new file mode 100644 index 0000000000..fb75e39bba --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/update-variable.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.updateVariable( + "<FUNCTION_ID>", // functionId + "<VARIABLE_ID>", // variableId + "<KEY>", // key + "<VALUE>", // value (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/update.md b/docs/examples/1.6.x/server-kotlin/java/functions/update.md new file mode 100644 index 0000000000..208b0b7fa3 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/functions/update.md @@ -0,0 +1,39 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Functions; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Functions functions = new Functions(client); + +functions.update( + "<FUNCTION_ID>", // functionId + "<NAME>", // name + .NODE_14_5, // runtime (optional) + listOf("any"), // execute (optional) + listOf(), // events (optional) + "", // schedule (optional) + 1, // timeout (optional) + false, // enabled (optional) + false, // logging (optional) + "<ENTRYPOINT>", // entrypoint (optional) + "<COMMANDS>", // commands (optional) + listOf(), // scopes (optional) + "<INSTALLATION_ID>", // installationId (optional) + "<PROVIDER_REPOSITORY_ID>", // providerRepositoryId (optional) + "<PROVIDER_BRANCH>", // providerBranch (optional) + false, // providerSilentMode (optional) + "<PROVIDER_ROOT_DIRECTORY>", // providerRootDirectory (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/graphql/mutation.md b/docs/examples/1.6.x/server-kotlin/java/graphql/mutation.md new file mode 100644 index 0000000000..6027a76f96 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/graphql/mutation.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Graphql; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Graphql graphql = new Graphql(client); + +graphql.mutation( + mapOf( "a" to "b" ), // query + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/graphql/query.md b/docs/examples/1.6.x/server-kotlin/java/graphql/query.md new file mode 100644 index 0000000000..00c1fb8b36 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/graphql/query.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Graphql; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Graphql graphql = new Graphql(client); + +graphql.query( + mapOf( "a" to "b" ), // query + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-antivirus.md b/docs/examples/1.6.x/server-kotlin/java/health/get-antivirus.md new file mode 100644 index 0000000000..67d5a32e1f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-antivirus.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getAntivirus(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-cache.md b/docs/examples/1.6.x/server-kotlin/java/health/get-cache.md new file mode 100644 index 0000000000..0403d593e3 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-cache.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getCache(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-certificate.md b/docs/examples/1.6.x/server-kotlin/java/health/get-certificate.md new file mode 100644 index 0000000000..60b0aa0e90 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-certificate.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getCertificate( + "", // domain (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-d-b.md b/docs/examples/1.6.x/server-kotlin/java/health/get-d-b.md new file mode 100644 index 0000000000..7f5d86b7ac --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-d-b.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getDB(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-failed-jobs.md b/docs/examples/1.6.x/server-kotlin/java/health/get-failed-jobs.md new file mode 100644 index 0000000000..e5a62b0d05 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-failed-jobs.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; +import io.appwrite.enums.Name; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getFailedJobs( + .V1_DATABASE, // name + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-pub-sub.md b/docs/examples/1.6.x/server-kotlin/java/health/get-pub-sub.md new file mode 100644 index 0000000000..a842469051 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-pub-sub.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getPubSub(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-builds.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-builds.md new file mode 100644 index 0000000000..af9d794851 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-builds.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueBuilds( + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-certificates.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-certificates.md new file mode 100644 index 0000000000..7a7b8ac65b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-certificates.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueCertificates( + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-databases.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-databases.md new file mode 100644 index 0000000000..5c76eb3778 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-databases.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueDatabases( + "<NAME>", // name (optional) + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-deletes.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-deletes.md new file mode 100644 index 0000000000..a070618884 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-deletes.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueDeletes( + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-functions.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-functions.md new file mode 100644 index 0000000000..0449422e01 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-functions.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueFunctions( + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-logs.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-logs.md new file mode 100644 index 0000000000..1f1cdaef2e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-logs.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueLogs( + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-mails.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-mails.md new file mode 100644 index 0000000000..d10e9216d5 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-mails.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueMails( + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-messaging.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-messaging.md new file mode 100644 index 0000000000..ab4f6ce286 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-messaging.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueMessaging( + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-migrations.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-migrations.md new file mode 100644 index 0000000000..ade6eba83e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-migrations.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueMigrations( + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..aad0c4501a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage-dump.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueUsageDump( + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage.md new file mode 100644 index 0000000000..3b56152288 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueUsage( + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-webhooks.md new file mode 100644 index 0000000000..5a31cc934e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-webhooks.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueueWebhooks( + 0, // threshold (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue.md new file mode 100644 index 0000000000..b4fe3d6523 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-queue.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getQueue(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-storage-local.md b/docs/examples/1.6.x/server-kotlin/java/health/get-storage-local.md new file mode 100644 index 0000000000..943189f0ce --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-storage-local.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getStorageLocal(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-storage.md b/docs/examples/1.6.x/server-kotlin/java/health/get-storage.md new file mode 100644 index 0000000000..cde88d48ce --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-storage.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getStorage(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-time.md b/docs/examples/1.6.x/server-kotlin/java/health/get-time.md new file mode 100644 index 0000000000..e82314f308 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get-time.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.getTime(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get.md b/docs/examples/1.6.x/server-kotlin/java/health/get.md new file mode 100644 index 0000000000..21c537ed87 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/health/get.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Health; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Health health = new Health(client); + +health.get(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/get.md b/docs/examples/1.6.x/server-kotlin/java/locale/get.md new file mode 100644 index 0000000000..3ae989ccd5 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/locale/get.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +locale.get(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-codes.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-codes.md new file mode 100644 index 0000000000..c6cab74b77 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/locale/list-codes.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +locale.listCodes(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-continents.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-continents.md new file mode 100644 index 0000000000..8e405df37b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/locale/list-continents.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +locale.listContinents(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-e-u.md new file mode 100644 index 0000000000..60d3dd9aaf --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-e-u.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +locale.listCountriesEU(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-phones.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-phones.md new file mode 100644 index 0000000000..170f7407a6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-phones.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +locale.listCountriesPhones(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-countries.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-countries.md new file mode 100644 index 0000000000..2ca54be387 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/locale/list-countries.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +locale.listCountries(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-currencies.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-currencies.md new file mode 100644 index 0000000000..2acd674d44 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/locale/list-currencies.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +locale.listCurrencies(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-languages.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-languages.md new file mode 100644 index 0000000000..c616511e17 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/locale/list-languages.md @@ -0,0 +1,19 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Locale; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Locale locale = new Locale(client); + +locale.listLanguages(new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); +})); diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-apns-provider.md new file mode 100644 index 0000000000..6a2d5f4898 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-apns-provider.md @@ -0,0 +1,30 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createApnsProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name + "<AUTH_KEY>", // authKey (optional) + "<AUTH_KEY_ID>", // authKeyId (optional) + "<TEAM_ID>", // teamId (optional) + "<BUNDLE_ID>", // bundleId (optional) + false, // sandbox (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-email.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-email.md new file mode 100644 index 0000000000..4efc2431df --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-email.md @@ -0,0 +1,34 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createEmail( + "<MESSAGE_ID>", // messageId + "<SUBJECT>", // subject + "<CONTENT>", // content + listOf(), // topics (optional) + listOf(), // users (optional) + listOf(), // targets (optional) + listOf(), // cc (optional) + listOf(), // bcc (optional) + listOf(), // attachments (optional) + false, // draft (optional) + false, // html (optional) + "", // scheduledAt (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..2f396d42ad --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-fcm-provider.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createFcmProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name + mapOf( "a" to "b" ), // serviceAccountJSON (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..f04fe96d83 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-mailgun-provider.md @@ -0,0 +1,32 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createMailgunProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name + "<API_KEY>", // apiKey (optional) + "<DOMAIN>", // domain (optional) + false, // isEuRegion (optional) + "<FROM_NAME>", // fromName (optional) + "email@example.com", // fromEmail (optional) + "<REPLY_TO_NAME>", // replyToName (optional) + "email@example.com", // replyToEmail (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-msg91provider.md new file mode 100644 index 0000000000..9ca7d4661b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-msg91provider.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createMsg91Provider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name + "<TEMPLATE_ID>", // templateId (optional) + "<SENDER_ID>", // senderId (optional) + "<AUTH_KEY>", // authKey (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-push.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-push.md new file mode 100644 index 0000000000..125cff194e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-push.md @@ -0,0 +1,38 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createPush( + "<MESSAGE_ID>", // messageId + "<TITLE>", // title + "<BODY>", // body + listOf(), // topics (optional) + listOf(), // users (optional) + listOf(), // targets (optional) + mapOf( "a" to "b" ), // data (optional) + "<ACTION>", // action (optional) + "[ID1:ID2]", // image (optional) + "<ICON>", // icon (optional) + "<SOUND>", // sound (optional) + "<COLOR>", // color (optional) + "<TAG>", // tag (optional) + "<BADGE>", // badge (optional) + false, // draft (optional) + "", // scheduledAt (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..d23c18a34c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-sendgrid-provider.md @@ -0,0 +1,30 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createSendgridProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name + "<API_KEY>", // apiKey (optional) + "<FROM_NAME>", // fromName (optional) + "email@example.com", // fromEmail (optional) + "<REPLY_TO_NAME>", // replyToName (optional) + "email@example.com", // replyToEmail (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-sms.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-sms.md new file mode 100644 index 0000000000..f4e79bd272 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-sms.md @@ -0,0 +1,29 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createSms( + "<MESSAGE_ID>", // messageId + "<CONTENT>", // content + listOf(), // topics (optional) + listOf(), // users (optional) + listOf(), // targets (optional) + false, // draft (optional) + "", // scheduledAt (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..e459c32cb8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-smtp-provider.md @@ -0,0 +1,36 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createSmtpProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name + "<HOST>", // host + 1, // port (optional) + "<USERNAME>", // username (optional) + "<PASSWORD>", // password (optional) + SmtpEncryption.NONE, // encryption (optional) + false, // autoTLS (optional) + "<MAILER>", // mailer (optional) + "<FROM_NAME>", // fromName (optional) + "email@example.com", // fromEmail (optional) + "<REPLY_TO_NAME>", // replyToName (optional) + "email@example.com", // replyToEmail (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-subscriber.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-subscriber.md new file mode 100644 index 0000000000..7ac08fccf2 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-subscriber.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setJWT("<YOUR_JWT>"); // Your secret JSON Web Token + +Messaging messaging = new Messaging(client); + +messaging.createSubscriber( + "<TOPIC_ID>", // topicId + "<SUBSCRIBER_ID>", // subscriberId + "<TARGET_ID>", // targetId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..1e6a0816fc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-telesign-provider.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createTelesignProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name + "+12065550100", // from (optional) + "<CUSTOMER_ID>", // customerId (optional) + "<API_KEY>", // apiKey (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..4077900ada --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-textmagic-provider.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createTextmagicProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name + "+12065550100", // from (optional) + "<USERNAME>", // username (optional) + "<API_KEY>", // apiKey (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-topic.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-topic.md new file mode 100644 index 0000000000..4f0adffd1a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-topic.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createTopic( + "<TOPIC_ID>", // topicId + "<NAME>", // name + listOf("any"), // subscribe (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..8193a70d4c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-twilio-provider.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createTwilioProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name + "+12065550100", // from (optional) + "<ACCOUNT_SID>", // accountSid (optional) + "<AUTH_TOKEN>", // authToken (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..52e58913b0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/create-vonage-provider.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.createVonageProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name + "+12065550100", // from (optional) + "<API_KEY>", // apiKey (optional) + "<API_SECRET>", // apiSecret (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/delete-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/delete-provider.md new file mode 100644 index 0000000000..9a4b0c2d6f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/delete-provider.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.deleteProvider( + "<PROVIDER_ID>", // providerId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-kotlin/java/messaging/delete-subscriber.md new file mode 100644 index 0000000000..42e46f1437 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/delete-subscriber.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setJWT("<YOUR_JWT>"); // Your secret JSON Web Token + +Messaging messaging = new Messaging(client); + +messaging.deleteSubscriber( + "<TOPIC_ID>", // topicId + "<SUBSCRIBER_ID>", // subscriberId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/delete-topic.md b/docs/examples/1.6.x/server-kotlin/java/messaging/delete-topic.md new file mode 100644 index 0000000000..755fda8308 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/delete-topic.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.deleteTopic( + "<TOPIC_ID>", // topicId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/delete.md b/docs/examples/1.6.x/server-kotlin/java/messaging/delete.md new file mode 100644 index 0000000000..d16b5d17d5 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/delete.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.delete( + "<MESSAGE_ID>", // messageId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/get-message.md b/docs/examples/1.6.x/server-kotlin/java/messaging/get-message.md new file mode 100644 index 0000000000..b591ba6f90 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/get-message.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.getMessage( + "<MESSAGE_ID>", // messageId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/get-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/get-provider.md new file mode 100644 index 0000000000..fc5869aa7c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/get-provider.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.getProvider( + "<PROVIDER_ID>", // providerId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/get-subscriber.md b/docs/examples/1.6.x/server-kotlin/java/messaging/get-subscriber.md new file mode 100644 index 0000000000..3b1efb13c4 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/get-subscriber.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.getSubscriber( + "<TOPIC_ID>", // topicId + "<SUBSCRIBER_ID>", // subscriberId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/get-topic.md b/docs/examples/1.6.x/server-kotlin/java/messaging/get-topic.md new file mode 100644 index 0000000000..103be8518d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/get-topic.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.getTopic( + "<TOPIC_ID>", // topicId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-message-logs.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-message-logs.md new file mode 100644 index 0000000000..c665b28404 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/list-message-logs.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.listMessageLogs( + "<MESSAGE_ID>", // messageId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-messages.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-messages.md new file mode 100644 index 0000000000..d337ab8c6c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/list-messages.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.listMessages( + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-provider-logs.md new file mode 100644 index 0000000000..5b6384fe5f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/list-provider-logs.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.listProviderLogs( + "<PROVIDER_ID>", // providerId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-providers.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-providers.md new file mode 100644 index 0000000000..1fe366343c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/list-providers.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.listProviders( + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..5a85cd8860 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscriber-logs.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.listSubscriberLogs( + "<SUBSCRIBER_ID>", // subscriberId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscribers.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscribers.md new file mode 100644 index 0000000000..da0903628c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscribers.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.listSubscribers( + "<TOPIC_ID>", // topicId + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-targets.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-targets.md new file mode 100644 index 0000000000..7e3a843e5a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/list-targets.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.listTargets( + "<MESSAGE_ID>", // messageId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-topic-logs.md new file mode 100644 index 0000000000..74d27a9686 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/list-topic-logs.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.listTopicLogs( + "<TOPIC_ID>", // topicId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-topics.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-topics.md new file mode 100644 index 0000000000..7fa18e3215 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/list-topics.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.listTopics( + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-apns-provider.md new file mode 100644 index 0000000000..eac01ee769 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-apns-provider.md @@ -0,0 +1,30 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateApnsProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name (optional) + false, // enabled (optional) + "<AUTH_KEY>", // authKey (optional) + "<AUTH_KEY_ID>", // authKeyId (optional) + "<TEAM_ID>", // teamId (optional) + "<BUNDLE_ID>", // bundleId (optional) + false, // sandbox (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-email.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-email.md new file mode 100644 index 0000000000..fc58dbb0a0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-email.md @@ -0,0 +1,34 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateEmail( + "<MESSAGE_ID>", // messageId + listOf(), // topics (optional) + listOf(), // users (optional) + listOf(), // targets (optional) + "<SUBJECT>", // subject (optional) + "<CONTENT>", // content (optional) + false, // draft (optional) + false, // html (optional) + listOf(), // cc (optional) + listOf(), // bcc (optional) + "", // scheduledAt (optional) + listOf(), // attachments (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..f7450b5141 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-fcm-provider.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateFcmProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name (optional) + false, // enabled (optional) + mapOf( "a" to "b" ), // serviceAccountJSON (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..7c1c0e136f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-mailgun-provider.md @@ -0,0 +1,32 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateMailgunProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name (optional) + "<API_KEY>", // apiKey (optional) + "<DOMAIN>", // domain (optional) + false, // isEuRegion (optional) + false, // enabled (optional) + "<FROM_NAME>", // fromName (optional) + "email@example.com", // fromEmail (optional) + "<REPLY_TO_NAME>", // replyToName (optional) + "<REPLY_TO_EMAIL>", // replyToEmail (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-msg91provider.md new file mode 100644 index 0000000000..4014002343 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-msg91provider.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateMsg91Provider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name (optional) + false, // enabled (optional) + "<TEMPLATE_ID>", // templateId (optional) + "<SENDER_ID>", // senderId (optional) + "<AUTH_KEY>", // authKey (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-push.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-push.md new file mode 100644 index 0000000000..5455a05773 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-push.md @@ -0,0 +1,38 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updatePush( + "<MESSAGE_ID>", // messageId + listOf(), // topics (optional) + listOf(), // users (optional) + listOf(), // targets (optional) + "<TITLE>", // title (optional) + "<BODY>", // body (optional) + mapOf( "a" to "b" ), // data (optional) + "<ACTION>", // action (optional) + "[ID1:ID2]", // image (optional) + "<ICON>", // icon (optional) + "<SOUND>", // sound (optional) + "<COLOR>", // color (optional) + "<TAG>", // tag (optional) + 0, // badge (optional) + false, // draft (optional) + "", // scheduledAt (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..9e6cd5e1a0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-sendgrid-provider.md @@ -0,0 +1,30 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateSendgridProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name (optional) + false, // enabled (optional) + "<API_KEY>", // apiKey (optional) + "<FROM_NAME>", // fromName (optional) + "email@example.com", // fromEmail (optional) + "<REPLY_TO_NAME>", // replyToName (optional) + "<REPLY_TO_EMAIL>", // replyToEmail (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-sms.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-sms.md new file mode 100644 index 0000000000..1839bb0d21 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-sms.md @@ -0,0 +1,29 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateSms( + "<MESSAGE_ID>", // messageId + listOf(), // topics (optional) + listOf(), // users (optional) + listOf(), // targets (optional) + "<CONTENT>", // content (optional) + false, // draft (optional) + "", // scheduledAt (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..0522418b86 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-smtp-provider.md @@ -0,0 +1,36 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateSmtpProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name (optional) + "<HOST>", // host (optional) + 1, // port (optional) + "<USERNAME>", // username (optional) + "<PASSWORD>", // password (optional) + SmtpEncryption.NONE, // encryption (optional) + false, // autoTLS (optional) + "<MAILER>", // mailer (optional) + "<FROM_NAME>", // fromName (optional) + "email@example.com", // fromEmail (optional) + "<REPLY_TO_NAME>", // replyToName (optional) + "<REPLY_TO_EMAIL>", // replyToEmail (optional) + false, // enabled (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..6d7701cfe7 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-telesign-provider.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateTelesignProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name (optional) + false, // enabled (optional) + "<CUSTOMER_ID>", // customerId (optional) + "<API_KEY>", // apiKey (optional) + "<FROM>", // from (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..bdd6e28c96 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-textmagic-provider.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateTextmagicProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name (optional) + false, // enabled (optional) + "<USERNAME>", // username (optional) + "<API_KEY>", // apiKey (optional) + "<FROM>", // from (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-topic.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-topic.md new file mode 100644 index 0000000000..e40b0828dd --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-topic.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateTopic( + "<TOPIC_ID>", // topicId + "<NAME>", // name (optional) + listOf("any"), // subscribe (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..ec4b143c24 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-twilio-provider.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateTwilioProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name (optional) + false, // enabled (optional) + "<ACCOUNT_SID>", // accountSid (optional) + "<AUTH_TOKEN>", // authToken (optional) + "<FROM>", // from (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..793c5cd0e2 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/messaging/update-vonage-provider.md @@ -0,0 +1,28 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Messaging; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Messaging messaging = new Messaging(client); + +messaging.updateVonageProvider( + "<PROVIDER_ID>", // providerId + "<NAME>", // name (optional) + false, // enabled (optional) + "<API_KEY>", // apiKey (optional) + "<API_SECRET>", // apiSecret (optional) + "<FROM>", // from (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/create-bucket.md b/docs/examples/1.6.x/server-kotlin/java/storage/create-bucket.md new file mode 100644 index 0000000000..e4c88e9db8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/create-bucket.md @@ -0,0 +1,32 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Storage storage = new Storage(client); + +storage.createBucket( + "<BUCKET_ID>", // bucketId + "<NAME>", // name + listOf("read("any")"), // permissions (optional) + false, // fileSecurity (optional) + false, // enabled (optional) + 1, // maximumFileSize (optional) + listOf(), // allowedFileExtensions (optional) + .NONE, // compression (optional) + false, // encryption (optional) + false, // antivirus (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/create-file.md b/docs/examples/1.6.x/server-kotlin/java/storage/create-file.md new file mode 100644 index 0000000000..16e31ffddc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/create-file.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.models.InputFile; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +storage.createFile( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + InputFile.fromPath("file.png"), // file + listOf("read("any")"), // permissions (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/delete-bucket.md b/docs/examples/1.6.x/server-kotlin/java/storage/delete-bucket.md new file mode 100644 index 0000000000..ebe69ac757 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/delete-bucket.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Storage storage = new Storage(client); + +storage.deleteBucket( + "<BUCKET_ID>", // bucketId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/delete-file.md b/docs/examples/1.6.x/server-kotlin/java/storage/delete-file.md new file mode 100644 index 0000000000..c34239d51e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/delete-file.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +storage.deleteFile( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/get-bucket.md b/docs/examples/1.6.x/server-kotlin/java/storage/get-bucket.md new file mode 100644 index 0000000000..bf30afd397 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/get-bucket.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Storage storage = new Storage(client); + +storage.getBucket( + "<BUCKET_ID>", // bucketId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/get-file-download.md b/docs/examples/1.6.x/server-kotlin/java/storage/get-file-download.md new file mode 100644 index 0000000000..6433b17e3b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/get-file-download.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +storage.getFileDownload( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/get-file-preview.md b/docs/examples/1.6.x/server-kotlin/java/storage/get-file-preview.md new file mode 100644 index 0000000000..d2e5fcb085 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/get-file-preview.md @@ -0,0 +1,35 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +storage.getFilePreview( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + 0, // width (optional) + 0, // height (optional) + ImageGravity.CENTER, // gravity (optional) + 0, // quality (optional) + 0, // borderWidth (optional) + "", // borderColor (optional) + 0, // borderRadius (optional) + 0, // opacity (optional) + -360, // rotation (optional) + "", // background (optional) + ImageFormat.JPG, // output (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/get-file-view.md b/docs/examples/1.6.x/server-kotlin/java/storage/get-file-view.md new file mode 100644 index 0000000000..ad842bb6fe --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/get-file-view.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +storage.getFileView( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/get-file.md b/docs/examples/1.6.x/server-kotlin/java/storage/get-file.md new file mode 100644 index 0000000000..84fb364f12 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/get-file.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +storage.getFile( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/list-buckets.md b/docs/examples/1.6.x/server-kotlin/java/storage/list-buckets.md new file mode 100644 index 0000000000..6b2c1a00a6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/list-buckets.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Storage storage = new Storage(client); + +storage.listBuckets( + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/list-files.md b/docs/examples/1.6.x/server-kotlin/java/storage/list-files.md new file mode 100644 index 0000000000..9483f07509 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/list-files.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +storage.listFiles( + "<BUCKET_ID>", // bucketId + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/update-bucket.md b/docs/examples/1.6.x/server-kotlin/java/storage/update-bucket.md new file mode 100644 index 0000000000..4c13f3a4d0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/update-bucket.md @@ -0,0 +1,32 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Storage storage = new Storage(client); + +storage.updateBucket( + "<BUCKET_ID>", // bucketId + "<NAME>", // name + listOf("read("any")"), // permissions (optional) + false, // fileSecurity (optional) + false, // enabled (optional) + 1, // maximumFileSize (optional) + listOf(), // allowedFileExtensions (optional) + .NONE, // compression (optional) + false, // encryption (optional) + false, // antivirus (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/update-file.md b/docs/examples/1.6.x/server-kotlin/java/storage/update-file.md new file mode 100644 index 0000000000..949d3bc1b9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/storage/update-file.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Storage; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Storage storage = new Storage(client); + +storage.updateFile( + "<BUCKET_ID>", // bucketId + "<FILE_ID>", // fileId + "<NAME>", // name (optional) + listOf("read("any")"), // permissions (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/create-membership.md b/docs/examples/1.6.x/server-kotlin/java/teams/create-membership.md new file mode 100644 index 0000000000..0f804b5555 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/create-membership.md @@ -0,0 +1,29 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.createMembership( + "<TEAM_ID>", // teamId + listOf(), // roles + "email@example.com", // email (optional) + "<USER_ID>", // userId (optional) + "+12065550100", // phone (optional) + "https://example.com", // url (optional) + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/create.md b/docs/examples/1.6.x/server-kotlin/java/teams/create.md new file mode 100644 index 0000000000..61d09c786d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/create.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.create( + "<TEAM_ID>", // teamId + "<NAME>", // name + listOf(), // roles (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/delete-membership.md b/docs/examples/1.6.x/server-kotlin/java/teams/delete-membership.md new file mode 100644 index 0000000000..07fd42a509 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/delete-membership.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.deleteMembership( + "<TEAM_ID>", // teamId + "<MEMBERSHIP_ID>", // membershipId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/delete.md b/docs/examples/1.6.x/server-kotlin/java/teams/delete.md new file mode 100644 index 0000000000..d076b11c50 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/delete.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.delete( + "<TEAM_ID>", // teamId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/get-membership.md b/docs/examples/1.6.x/server-kotlin/java/teams/get-membership.md new file mode 100644 index 0000000000..3dbea3016e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/get-membership.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.getMembership( + "<TEAM_ID>", // teamId + "<MEMBERSHIP_ID>", // membershipId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/get-prefs.md b/docs/examples/1.6.x/server-kotlin/java/teams/get-prefs.md new file mode 100644 index 0000000000..1ff7a99565 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/get-prefs.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.getPrefs( + "<TEAM_ID>", // teamId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/get.md b/docs/examples/1.6.x/server-kotlin/java/teams/get.md new file mode 100644 index 0000000000..c06c107ac2 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/get.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.get( + "<TEAM_ID>", // teamId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/list-memberships.md b/docs/examples/1.6.x/server-kotlin/java/teams/list-memberships.md new file mode 100644 index 0000000000..a44a977e40 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/list-memberships.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.listMemberships( + "<TEAM_ID>", // teamId + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/list.md b/docs/examples/1.6.x/server-kotlin/java/teams/list.md new file mode 100644 index 0000000000..9559fe0e03 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/list.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.list( + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/update-membership-status.md b/docs/examples/1.6.x/server-kotlin/java/teams/update-membership-status.md new file mode 100644 index 0000000000..a938842e57 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/update-membership-status.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.updateMembershipStatus( + "<TEAM_ID>", // teamId + "<MEMBERSHIP_ID>", // membershipId + "<USER_ID>", // userId + "<SECRET>", // secret + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/update-membership.md b/docs/examples/1.6.x/server-kotlin/java/teams/update-membership.md new file mode 100644 index 0000000000..e5d2c982d8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/update-membership.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.updateMembership( + "<TEAM_ID>", // teamId + "<MEMBERSHIP_ID>", // membershipId + listOf(), // roles + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/update-name.md b/docs/examples/1.6.x/server-kotlin/java/teams/update-name.md new file mode 100644 index 0000000000..1ef086e66c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/update-name.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.updateName( + "<TEAM_ID>", // teamId + "<NAME>", // name + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/update-prefs.md b/docs/examples/1.6.x/server-kotlin/java/teams/update-prefs.md new file mode 100644 index 0000000000..e6bc00d58e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/teams/update-prefs.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Teams; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession(""); // The user session to authenticate with + +Teams teams = new Teams(client); + +teams.updatePrefs( + "<TEAM_ID>", // teamId + mapOf( "a" to "b" ), // prefs + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-argon2user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-argon2user.md new file mode 100644 index 0000000000..057b7d740c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-argon2user.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createArgon2User( + "<USER_ID>", // userId + "email@example.com", // email + "password", // password + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-bcrypt-user.md new file mode 100644 index 0000000000..e6f2de69d0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-bcrypt-user.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createBcryptUser( + "<USER_ID>", // userId + "email@example.com", // email + "password", // password + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-j-w-t.md b/docs/examples/1.6.x/server-kotlin/java/users/create-j-w-t.md new file mode 100644 index 0000000000..376680bd31 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-j-w-t.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createJWT( + "<USER_ID>", // userId + "<SESSION_ID>", // sessionId (optional) + 0, // duration (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-m-d5user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-m-d5user.md new file mode 100644 index 0000000000..8880553b54 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-m-d5user.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createMD5User( + "<USER_ID>", // userId + "email@example.com", // email + "password", // password + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..e6b566bb2d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-mfa-recovery-codes.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createMfaRecoveryCodes( + "<USER_ID>", // userId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..d8065325ca --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-p-h-pass-user.md @@ -0,0 +1,26 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createPHPassUser( + "<USER_ID>", // userId + "email@example.com", // email + "password", // password + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-s-h-a-user.md new file mode 100644 index 0000000000..3894a2b890 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-s-h-a-user.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createSHAUser( + "<USER_ID>", // userId + "email@example.com", // email + "password", // password + PasswordHash.SHA1, // passwordVersion (optional) + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..10a020174f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-modified-user.md @@ -0,0 +1,29 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createScryptModifiedUser( + "<USER_ID>", // userId + "email@example.com", // email + "password", // password + "<PASSWORD_SALT>", // passwordSalt + "<PASSWORD_SALT_SEPARATOR>", // passwordSaltSeparator + "<PASSWORD_SIGNER_KEY>", // passwordSignerKey + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-user.md new file mode 100644 index 0000000000..fb32f0d764 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-user.md @@ -0,0 +1,31 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createScryptUser( + "<USER_ID>", // userId + "email@example.com", // email + "password", // password + "<PASSWORD_SALT>", // passwordSalt + 0, // passwordCpu + 0, // passwordMemory + 0, // passwordParallel + 0, // passwordLength + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-session.md b/docs/examples/1.6.x/server-kotlin/java/users/create-session.md new file mode 100644 index 0000000000..ca60f50f06 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-session.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createSession( + "<USER_ID>", // userId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-target.md b/docs/examples/1.6.x/server-kotlin/java/users/create-target.md new file mode 100644 index 0000000000..c5cbfa0c28 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-target.md @@ -0,0 +1,29 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; +import io.appwrite.enums.MessagingProviderType; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createTarget( + "<USER_ID>", // userId + "<TARGET_ID>", // targetId + MessagingProviderType.EMAIL, // providerType + "<IDENTIFIER>", // identifier + "<PROVIDER_ID>", // providerId (optional) + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-token.md b/docs/examples/1.6.x/server-kotlin/java/users/create-token.md new file mode 100644 index 0000000000..32a0f9772e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create-token.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.createToken( + "<USER_ID>", // userId + 4, // length (optional) + 60, // expire (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create.md b/docs/examples/1.6.x/server-kotlin/java/users/create.md new file mode 100644 index 0000000000..6ff315c0c6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/create.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.create( + "<USER_ID>", // userId + "email@example.com", // email (optional) + "+12065550100", // phone (optional) + "", // password (optional) + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete-identity.md b/docs/examples/1.6.x/server-kotlin/java/users/delete-identity.md new file mode 100644 index 0000000000..39462b1df0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/delete-identity.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.deleteIdentity( + "<IDENTITY_ID>", // identityId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/java/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..5e32ef9e18 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/delete-mfa-authenticator.md @@ -0,0 +1,25 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; +import io.appwrite.enums.AuthenticatorType; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.deleteMfaAuthenticator( + "<USER_ID>", // userId + AuthenticatorType.TOTP, // type + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete-session.md b/docs/examples/1.6.x/server-kotlin/java/users/delete-session.md new file mode 100644 index 0000000000..658d0ef879 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/delete-session.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.deleteSession( + "<USER_ID>", // userId + "<SESSION_ID>", // sessionId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete-sessions.md b/docs/examples/1.6.x/server-kotlin/java/users/delete-sessions.md new file mode 100644 index 0000000000..3e6cfeae2a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/delete-sessions.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.deleteSessions( + "<USER_ID>", // userId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete-target.md b/docs/examples/1.6.x/server-kotlin/java/users/delete-target.md new file mode 100644 index 0000000000..00f45b85d1 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/delete-target.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.deleteTarget( + "<USER_ID>", // userId + "<TARGET_ID>", // targetId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete.md b/docs/examples/1.6.x/server-kotlin/java/users/delete.md new file mode 100644 index 0000000000..9846b8be85 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/delete.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.delete( + "<USER_ID>", // userId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..583287c623 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/get-mfa-recovery-codes.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.getMfaRecoveryCodes( + "<USER_ID>", // userId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/get-prefs.md b/docs/examples/1.6.x/server-kotlin/java/users/get-prefs.md new file mode 100644 index 0000000000..5bcf7aacdf --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/get-prefs.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.getPrefs( + "<USER_ID>", // userId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/get-target.md b/docs/examples/1.6.x/server-kotlin/java/users/get-target.md new file mode 100644 index 0000000000..1b02057f84 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/get-target.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.getTarget( + "<USER_ID>", // userId + "<TARGET_ID>", // targetId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/get.md b/docs/examples/1.6.x/server-kotlin/java/users/get.md new file mode 100644 index 0000000000..c3cb953b52 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/get.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.get( + "<USER_ID>", // userId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-identities.md b/docs/examples/1.6.x/server-kotlin/java/users/list-identities.md new file mode 100644 index 0000000000..deac1c9931 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/list-identities.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.listIdentities( + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-logs.md b/docs/examples/1.6.x/server-kotlin/java/users/list-logs.md new file mode 100644 index 0000000000..d2e785dc63 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/list-logs.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.listLogs( + "<USER_ID>", // userId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-memberships.md b/docs/examples/1.6.x/server-kotlin/java/users/list-memberships.md new file mode 100644 index 0000000000..2c11c5abcd --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/list-memberships.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.listMemberships( + "<USER_ID>", // userId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-mfa-factors.md b/docs/examples/1.6.x/server-kotlin/java/users/list-mfa-factors.md new file mode 100644 index 0000000000..458b0a4679 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/list-mfa-factors.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.listMfaFactors( + "<USER_ID>", // userId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-sessions.md b/docs/examples/1.6.x/server-kotlin/java/users/list-sessions.md new file mode 100644 index 0000000000..d24f8ffdce --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/list-sessions.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.listSessions( + "<USER_ID>", // userId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-targets.md b/docs/examples/1.6.x/server-kotlin/java/users/list-targets.md new file mode 100644 index 0000000000..7e1938c015 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/list-targets.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.listTargets( + "<USER_ID>", // userId + listOf(), // queries (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list.md b/docs/examples/1.6.x/server-kotlin/java/users/list.md new file mode 100644 index 0000000000..6d289a657d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/list.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.list( + listOf(), // queries (optional) + "<SEARCH>", // search (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-email-verification.md b/docs/examples/1.6.x/server-kotlin/java/users/update-email-verification.md new file mode 100644 index 0000000000..12f33a341a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-email-verification.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updateEmailVerification( + "<USER_ID>", // userId + false, // emailVerification + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-email.md b/docs/examples/1.6.x/server-kotlin/java/users/update-email.md new file mode 100644 index 0000000000..f3855d2441 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-email.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updateEmail( + "<USER_ID>", // userId + "email@example.com", // email + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-labels.md b/docs/examples/1.6.x/server-kotlin/java/users/update-labels.md new file mode 100644 index 0000000000..26ef7152ef --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-labels.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updateLabels( + "<USER_ID>", // userId + listOf(), // labels + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..798626893e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-mfa-recovery-codes.md @@ -0,0 +1,23 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updateMfaRecoveryCodes( + "<USER_ID>", // userId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-mfa.md b/docs/examples/1.6.x/server-kotlin/java/users/update-mfa.md new file mode 100644 index 0000000000..6cb8e60a3f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-mfa.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updateMfa( + "<USER_ID>", // userId + false, // mfa + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-name.md b/docs/examples/1.6.x/server-kotlin/java/users/update-name.md new file mode 100644 index 0000000000..cc3d905e7e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-name.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updateName( + "<USER_ID>", // userId + "<NAME>", // name + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-password.md b/docs/examples/1.6.x/server-kotlin/java/users/update-password.md new file mode 100644 index 0000000000..3d98d9e1b9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-password.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updatePassword( + "<USER_ID>", // userId + "", // password + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-phone-verification.md b/docs/examples/1.6.x/server-kotlin/java/users/update-phone-verification.md new file mode 100644 index 0000000000..a2c5ffbdb0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-phone-verification.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updatePhoneVerification( + "<USER_ID>", // userId + false, // phoneVerification + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-phone.md b/docs/examples/1.6.x/server-kotlin/java/users/update-phone.md new file mode 100644 index 0000000000..4f3cb65ac2 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-phone.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updatePhone( + "<USER_ID>", // userId + "+12065550100", // number + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-prefs.md b/docs/examples/1.6.x/server-kotlin/java/users/update-prefs.md new file mode 100644 index 0000000000..25706b8e9f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-prefs.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updatePrefs( + "<USER_ID>", // userId + mapOf( "a" to "b" ), // prefs + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-status.md b/docs/examples/1.6.x/server-kotlin/java/users/update-status.md new file mode 100644 index 0000000000..718b17509c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-status.md @@ -0,0 +1,24 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updateStatus( + "<USER_ID>", // userId + false, // status + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-target.md b/docs/examples/1.6.x/server-kotlin/java/users/update-target.md new file mode 100644 index 0000000000..bed6d7287a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/java/users/update-target.md @@ -0,0 +1,27 @@ +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Users; + +Client client = new Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>"); // Your secret API key + +Users users = new Users(client); + +users.updateTarget( + "<USER_ID>", // userId + "<TARGET_ID>", // targetId + "<IDENTIFIER>", // identifier (optional) + "<PROVIDER_ID>", // providerId (optional) + "<NAME>", // name (optional) + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + + System.out.println(result); + }) +); + diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-anonymous-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-anonymous-session.md new file mode 100644 index 0000000000..20e8b7b800 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-anonymous-session.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val response = account.createAnonymousSession() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-password-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-password-session.md new file mode 100644 index 0000000000..47894a64b6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-password-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val response = account.createEmailPasswordSession( + email = "email@example.com", + password = "password" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-token.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-token.md new file mode 100644 index 0000000000..e73dff7cd4 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-token.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val response = account.createEmailToken( + userId = "<USER_ID>", + email = "email@example.com", + phrase = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-j-w-t.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-j-w-t.md new file mode 100644 index 0000000000..95568ac8ba --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-j-w-t.md @@ -0,0 +1,11 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val response = account.createJWT() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..5652b1ec42 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-magic-u-r-l-token.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val response = account.createMagicURLToken( + userId = "<USER_ID>", + email = "email@example.com", + url = "https://example.com", // optional + phrase = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..e2040cb470 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-authenticator.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account +import io.appwrite.enums.AuthenticatorType + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.createMfaAuthenticator( + type = AuthenticatorType.TOTP +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-challenge.md new file mode 100644 index 0000000000..37f0badeff --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-challenge.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account +import io.appwrite.enums.AuthenticationFactor + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val response = account.createMfaChallenge( + factor = AuthenticationFactor.EMAIL +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..f98ef042f9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.createMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-o-auth2token.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-o-auth2token.md new file mode 100644 index 0000000000..5d1e78c5e7 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-o-auth2token.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account +import io.appwrite.enums.OAuthProvider + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +account.createOAuth2Token( + provider = OAuthProvider.AMAZON, + success = "https://example.com", // optional + failure = "https://example.com", // optional + scopes = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-token.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-token.md new file mode 100644 index 0000000000..1ab4b1ae79 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-token.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val response = account.createPhoneToken( + userId = "<USER_ID>", + phone = "+12065550100" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-verification.md new file mode 100644 index 0000000000..628700ba3d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-verification.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.createPhoneVerification() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-recovery.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-recovery.md new file mode 100644 index 0000000000..98e1f6f9b8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-recovery.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.createRecovery( + email = "email@example.com", + url = "https://example.com" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-session.md new file mode 100644 index 0000000000..e9116c7f02 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val response = account.createSession( + userId = "<USER_ID>", + secret = "<SECRET>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-verification.md new file mode 100644 index 0000000000..3b0efad678 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-verification.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.createVerification( + url = "https://example.com" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create.md new file mode 100644 index 0000000000..a0abf68617 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/create.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val response = account.create( + userId = "<USER_ID>", + email = "email@example.com", + password = "", + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-identity.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-identity.md new file mode 100644 index 0000000000..5a0ed383f8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-identity.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.deleteIdentity( + identityId = "<IDENTITY_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..7078efe87e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-mfa-authenticator.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account +import io.appwrite.enums.AuthenticatorType + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.deleteMfaAuthenticator( + type = AuthenticatorType.TOTP +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-session.md new file mode 100644 index 0000000000..a56b7efd6d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.deleteSession( + sessionId = "<SESSION_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-sessions.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-sessions.md new file mode 100644 index 0000000000..65fcebe192 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-sessions.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.deleteSessions() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..cda264861a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/get-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.getMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/get-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/get-prefs.md new file mode 100644 index 0000000000..33d7ba2f4e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/get-prefs.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.getPrefs() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/get-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/get-session.md new file mode 100644 index 0000000000..d320018c89 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/get-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.getSession( + sessionId = "<SESSION_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/get.md new file mode 100644 index 0000000000..a1172e68f4 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/get.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.get() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-identities.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-identities.md new file mode 100644 index 0000000000..9b002bcc7a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-identities.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.listIdentities( + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-logs.md new file mode 100644 index 0000000000..bb347565fa --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-logs.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.listLogs( + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-mfa-factors.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-mfa-factors.md new file mode 100644 index 0000000000..3824945b26 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-mfa-factors.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.listMfaFactors() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-sessions.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-sessions.md new file mode 100644 index 0000000000..fee2a07f18 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-sessions.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.listSessions() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-email.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-email.md new file mode 100644 index 0000000000..840eb2d21e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-email.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updateEmail( + email = "email@example.com", + password = "password" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-m-f-a.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-m-f-a.md new file mode 100644 index 0000000000..34959a529e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-m-f-a.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updateMFA( + mfa = false +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..3002bbfb2c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-magic-u-r-l-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val response = account.updateMagicURLSession( + userId = "<USER_ID>", + secret = "<SECRET>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..030034ca0e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-authenticator.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account +import io.appwrite.enums.AuthenticatorType + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updateMfaAuthenticator( + type = AuthenticatorType.TOTP, + otp = "<OTP>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-challenge.md new file mode 100644 index 0000000000..2de7dc696b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-challenge.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updateMfaChallenge( + challengeId = "<CHALLENGE_ID>", + otp = "<OTP>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..cab29cdb75 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updateMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-name.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-name.md new file mode 100644 index 0000000000..31236e6d46 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-name.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updateName( + name = "<NAME>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-password.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-password.md new file mode 100644 index 0000000000..796b550d76 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-password.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updatePassword( + password = "", + oldPassword = "password" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-session.md new file mode 100644 index 0000000000..2d346b7cce --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +val account = Account(client) + +val response = account.updatePhoneSession( + userId = "<USER_ID>", + secret = "<SECRET>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-verification.md new file mode 100644 index 0000000000..9b3d125d2b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-verification.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updatePhoneVerification( + userId = "<USER_ID>", + secret = "<SECRET>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone.md new file mode 100644 index 0000000000..64f83d7b1d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updatePhone( + phone = "+12065550100", + password = "password" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-prefs.md new file mode 100644 index 0000000000..2da90008ed --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-prefs.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updatePrefs( + prefs = mapOf( "a" to "b" ) +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-recovery.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-recovery.md new file mode 100644 index 0000000000..3fb130d201 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-recovery.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updateRecovery( + userId = "<USER_ID>", + secret = "<SECRET>", + password = "" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-session.md new file mode 100644 index 0000000000..9e6182c606 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updateSession( + sessionId = "<SESSION_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-status.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-status.md new file mode 100644 index 0000000000..64e970453f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-status.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updateStatus() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-verification.md new file mode 100644 index 0000000000..e4a91fe720 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-verification.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Account + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val account = Account(client) + +val response = account.updateVerification( + userId = "<USER_ID>", + secret = "<SECRET>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-browser.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-browser.md new file mode 100644 index 0000000000..f7b31a37aa --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-browser.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars +import io.appwrite.enums.Browser + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val avatars = Avatars(client) + +val result = avatars.getBrowser( + code = Browser.AVANT_BROWSER, + width = 0, // optional + height = 0, // optional + quality = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-credit-card.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-credit-card.md new file mode 100644 index 0000000000..1bc1f5d9a4 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-credit-card.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars +import io.appwrite.enums.CreditCard + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val avatars = Avatars(client) + +val result = avatars.getCreditCard( + code = CreditCard.AMERICAN_EXPRESS, + width = 0, // optional + height = 0, // optional + quality = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-favicon.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-favicon.md new file mode 100644 index 0000000000..d11aa09ce5 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-favicon.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val avatars = Avatars(client) + +val result = avatars.getFavicon( + url = "https://example.com" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-flag.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-flag.md new file mode 100644 index 0000000000..7d51019e18 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-flag.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars +import io.appwrite.enums.Flag + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val avatars = Avatars(client) + +val result = avatars.getFlag( + code = Flag.AFGHANISTAN, + width = 0, // optional + height = 0, // optional + quality = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-image.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-image.md new file mode 100644 index 0000000000..758c503463 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-image.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val avatars = Avatars(client) + +val result = avatars.getImage( + url = "https://example.com", + width = 0, // optional + height = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-initials.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-initials.md new file mode 100644 index 0000000000..92e9d36379 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-initials.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val avatars = Avatars(client) + +val result = avatars.getInitials( + name = "<NAME>", // optional + width = 0, // optional + height = 0, // optional + background = "" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-q-r.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-q-r.md new file mode 100644 index 0000000000..66e77c52ea --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-q-r.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Avatars + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val avatars = Avatars(client) + +val result = avatars.getQR( + text = "<TEXT>", + size = 1, // optional + margin = 0, // optional + download = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..e208d01cc7 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-boolean-attribute.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createBooleanAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + default = false, // optional + array = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-collection.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-collection.md new file mode 100644 index 0000000000..c1bb200028 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-collection.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createCollection( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + name = "<NAME>", + permissions = listOf("read("any")"), // optional + documentSecurity = false, // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..25433c99aa --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-datetime-attribute.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createDatetimeAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + default = "", // optional + array = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-document.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-document.md new file mode 100644 index 0000000000..6ce280699b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-document.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val databases = Databases(client) + +val response = databases.createDocument( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + documentId = "<DOCUMENT_ID>", + data = mapOf( "a" to "b" ), + permissions = listOf("read("any")") // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-email-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-email-attribute.md new file mode 100644 index 0000000000..b3321597fd --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-email-attribute.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createEmailAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + default = "email@example.com", // optional + array = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-enum-attribute.md new file mode 100644 index 0000000000..24f5ca0d8d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-enum-attribute.md @@ -0,0 +1,20 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createEnumAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + elements = listOf(), + required = false, + default = "<DEFAULT>", // optional + array = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-float-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-float-attribute.md new file mode 100644 index 0000000000..271aeb411f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-float-attribute.md @@ -0,0 +1,21 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createFloatAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + min = 0, // optional + max = 0, // optional + default = 0, // optional + array = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-index.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-index.md new file mode 100644 index 0000000000..aac7a23cde --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-index.md @@ -0,0 +1,20 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases +import io.appwrite.enums.IndexType + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createIndex( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + type = IndexType.KEY, + attributes = listOf(), + orders = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-integer-attribute.md new file mode 100644 index 0000000000..c01bf14b18 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-integer-attribute.md @@ -0,0 +1,21 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createIntegerAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + min = 0, // optional + max = 0, // optional + default = 0, // optional + array = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-ip-attribute.md new file mode 100644 index 0000000000..823b008ba9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-ip-attribute.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createIpAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + default = "", // optional + array = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..0b15a4869e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-relationship-attribute.md @@ -0,0 +1,22 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases +import io.appwrite.enums.RelationshipType + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createRelationshipAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + relatedCollectionId = "<RELATED_COLLECTION_ID>", + type = RelationshipType.ONETOONE, + twoWay = false, // optional + key = "", // optional + twoWayKey = "", // optional + onDelete = "cascade" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-string-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-string-attribute.md new file mode 100644 index 0000000000..f532c2fcd7 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-string-attribute.md @@ -0,0 +1,21 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createStringAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + size = 1, + required = false, + default = "<DEFAULT>", // optional + array = false, // optional + encrypt = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-url-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-url-attribute.md new file mode 100644 index 0000000000..995a609c2a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-url-attribute.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.createUrlAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + default = "https://example.com", // optional + array = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create.md new file mode 100644 index 0000000000..b4f4ac2cd1 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.create( + databaseId = "<DATABASE_ID>", + name = "<NAME>", + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-attribute.md new file mode 100644 index 0000000000..c47d9529d8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-attribute.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.deleteAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-collection.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-collection.md new file mode 100644 index 0000000000..d60857128c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-collection.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.deleteCollection( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-document.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-document.md new file mode 100644 index 0000000000..309a268cc6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-document.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val databases = Databases(client) + +val response = databases.deleteDocument( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + documentId = "<DOCUMENT_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-index.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-index.md new file mode 100644 index 0000000000..0ac1f63642 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-index.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.deleteIndex( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete.md new file mode 100644 index 0000000000..8219ac4148 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.delete( + databaseId = "<DATABASE_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-attribute.md new file mode 100644 index 0000000000..3f4d9e8afa --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-attribute.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.getAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-collection.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-collection.md new file mode 100644 index 0000000000..52ccd5e775 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-collection.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.getCollection( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-document.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-document.md new file mode 100644 index 0000000000..3e116f6524 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-document.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val databases = Databases(client) + +val response = databases.getDocument( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + documentId = "<DOCUMENT_ID>", + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-index.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-index.md new file mode 100644 index 0000000000..dfde04d064 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-index.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.getIndex( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get.md new file mode 100644 index 0000000000..f7b465048c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.get( + databaseId = "<DATABASE_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-attributes.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-attributes.md new file mode 100644 index 0000000000..d33f24ac76 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-attributes.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.listAttributes( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-collections.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-collections.md new file mode 100644 index 0000000000..e09e8b3905 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-collections.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.listCollections( + databaseId = "<DATABASE_ID>", + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-documents.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-documents.md new file mode 100644 index 0000000000..a3e351d363 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-documents.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val databases = Databases(client) + +val response = databases.listDocuments( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-indexes.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-indexes.md new file mode 100644 index 0000000000..a4c0c3c02f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-indexes.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.listIndexes( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list.md new file mode 100644 index 0000000000..0013f869db --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.list( + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..2152df5163 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-boolean-attribute.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.updateBooleanAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + default = false +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-collection.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-collection.md new file mode 100644 index 0000000000..99d1d3a07a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-collection.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.updateCollection( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + name = "<NAME>", + permissions = listOf("read("any")"), // optional + documentSecurity = false, // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..2aeab56dc5 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-datetime-attribute.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.updateDatetimeAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + default = "" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-document.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-document.md new file mode 100644 index 0000000000..a55502ec3b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-document.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val databases = Databases(client) + +val response = databases.updateDocument( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + documentId = "<DOCUMENT_ID>", + data = mapOf( "a" to "b" ), // optional + permissions = listOf("read("any")") // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-email-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-email-attribute.md new file mode 100644 index 0000000000..a6439eb8b6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-email-attribute.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.updateEmailAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + default = "email@example.com" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-enum-attribute.md new file mode 100644 index 0000000000..63375bf256 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-enum-attribute.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.updateEnumAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + elements = listOf(), + required = false, + default = "<DEFAULT>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-float-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-float-attribute.md new file mode 100644 index 0000000000..10011cb740 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-float-attribute.md @@ -0,0 +1,20 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.updateFloatAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + min = 0, + max = 0, + default = 0 +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-integer-attribute.md new file mode 100644 index 0000000000..2c1388d986 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-integer-attribute.md @@ -0,0 +1,20 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.updateIntegerAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + min = 0, + max = 0, + default = 0 +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-ip-attribute.md new file mode 100644 index 0000000000..07fda267b6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-ip-attribute.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.updateIpAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + default = "" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..ee83dca539 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-relationship-attribute.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.updateRelationshipAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + onDelete = "cascade" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-string-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-string-attribute.md new file mode 100644 index 0000000000..e5c54e9a73 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-string-attribute.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.updateStringAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + default = "<DEFAULT>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-url-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-url-attribute.md new file mode 100644 index 0000000000..3b4c538579 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-url-attribute.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.updateUrlAttribute( + databaseId = "<DATABASE_ID>", + collectionId = "<COLLECTION_ID>", + key = "", + required = false, + default = "https://example.com" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update.md new file mode 100644 index 0000000000..608c71fbb9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Databases + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val databases = Databases(client) + +val response = databases.update( + databaseId = "<DATABASE_ID>", + name = "<NAME>", + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-build.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-build.md new file mode 100644 index 0000000000..4d6c1ced1c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-build.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.createBuild( + functionId = "<FUNCTION_ID>", + deploymentId = "<DEPLOYMENT_ID>", + buildId = "<BUILD_ID>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-deployment.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-deployment.md new file mode 100644 index 0000000000..3999f99f98 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-deployment.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.models.InputFile +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.createDeployment( + functionId = "<FUNCTION_ID>", + code = InputFile.fromPath("file.png"), + activate = false, + entrypoint = "<ENTRYPOINT>", // optional + commands = "<COMMANDS>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-execution.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-execution.md new file mode 100644 index 0000000000..43bc5eb96e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-execution.md @@ -0,0 +1,20 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val functions = Functions(client) + +val response = functions.createExecution( + functionId = "<FUNCTION_ID>", + body = "<BODY>", // optional + async = false, // optional + path = "<PATH>", // optional + method = "GET", // optional + headers = mapOf( "a" to "b" ), // optional + scheduledAt = "" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-variable.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-variable.md new file mode 100644 index 0000000000..3748a98dcc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-variable.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.createVariable( + functionId = "<FUNCTION_ID>", + key = "<KEY>", + value = "<VALUE>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create.md new file mode 100644 index 0000000000..b771633e55 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create.md @@ -0,0 +1,35 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions +import io.appwrite.enums.Runtime + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.create( + functionId = "<FUNCTION_ID>", + name = "<NAME>", + runtime = .NODE_14_5, + execute = listOf("any"), // optional + events = listOf(), // optional + schedule = "", // optional + timeout = 1, // optional + enabled = false, // optional + logging = false, // optional + entrypoint = "<ENTRYPOINT>", // optional + commands = "<COMMANDS>", // optional + scopes = listOf(), // optional + installationId = "<INSTALLATION_ID>", // optional + providerRepositoryId = "<PROVIDER_REPOSITORY_ID>", // optional + providerBranch = "<PROVIDER_BRANCH>", // optional + providerSilentMode = false, // optional + providerRootDirectory = "<PROVIDER_ROOT_DIRECTORY>", // optional + templateRepository = "<TEMPLATE_REPOSITORY>", // optional + templateOwner = "<TEMPLATE_OWNER>", // optional + templateRootDirectory = "<TEMPLATE_ROOT_DIRECTORY>", // optional + templateBranch = "<TEMPLATE_BRANCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-deployment.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-deployment.md new file mode 100644 index 0000000000..6c68a27d3c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-deployment.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.deleteDeployment( + functionId = "<FUNCTION_ID>", + deploymentId = "<DEPLOYMENT_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-execution.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-execution.md new file mode 100644 index 0000000000..182438ae89 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-execution.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.deleteExecution( + functionId = "<FUNCTION_ID>", + executionId = "<EXECUTION_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-variable.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-variable.md new file mode 100644 index 0000000000..e87652f774 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-variable.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.deleteVariable( + functionId = "<FUNCTION_ID>", + variableId = "<VARIABLE_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete.md new file mode 100644 index 0000000000..45f442b29b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.delete( + functionId = "<FUNCTION_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/download-deployment.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/download-deployment.md new file mode 100644 index 0000000000..29f6a198ee --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/download-deployment.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val result = functions.downloadDeployment( + functionId = "<FUNCTION_ID>", + deploymentId = "<DEPLOYMENT_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-deployment.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-deployment.md new file mode 100644 index 0000000000..81eb317e8f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-deployment.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.getDeployment( + functionId = "<FUNCTION_ID>", + deploymentId = "<DEPLOYMENT_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-execution.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-execution.md new file mode 100644 index 0000000000..f498daf4cc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-execution.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val functions = Functions(client) + +val response = functions.getExecution( + functionId = "<FUNCTION_ID>", + executionId = "<EXECUTION_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-variable.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-variable.md new file mode 100644 index 0000000000..73f2c3a2fa --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-variable.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.getVariable( + functionId = "<FUNCTION_ID>", + variableId = "<VARIABLE_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get.md new file mode 100644 index 0000000000..899a6c1bfc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.get( + functionId = "<FUNCTION_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-deployments.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-deployments.md new file mode 100644 index 0000000000..48dc03e427 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-deployments.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.listDeployments( + functionId = "<FUNCTION_ID>", + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-executions.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-executions.md new file mode 100644 index 0000000000..625a048d7f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-executions.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val functions = Functions(client) + +val response = functions.listExecutions( + functionId = "<FUNCTION_ID>", + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-runtimes.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-runtimes.md new file mode 100644 index 0000000000..0f0d2962e3 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-runtimes.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.listRuntimes() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-variables.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-variables.md new file mode 100644 index 0000000000..e6b1742652 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-variables.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.listVariables( + functionId = "<FUNCTION_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list.md new file mode 100644 index 0000000000..df9cb7e00e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.list( + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment-build.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment-build.md new file mode 100644 index 0000000000..8abb613992 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment-build.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.updateDeploymentBuild( + functionId = "<FUNCTION_ID>", + deploymentId = "<DEPLOYMENT_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment.md new file mode 100644 index 0000000000..d86934d440 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.updateDeployment( + functionId = "<FUNCTION_ID>", + deploymentId = "<DEPLOYMENT_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-variable.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-variable.md new file mode 100644 index 0000000000..6890928a38 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-variable.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.updateVariable( + functionId = "<FUNCTION_ID>", + variableId = "<VARIABLE_ID>", + key = "<KEY>", + value = "<VALUE>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update.md new file mode 100644 index 0000000000..616f17259c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update.md @@ -0,0 +1,30 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Functions + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val functions = Functions(client) + +val response = functions.update( + functionId = "<FUNCTION_ID>", + name = "<NAME>", + runtime = "node-14.5", // optional + execute = listOf("any"), // optional + events = listOf(), // optional + schedule = "", // optional + timeout = 1, // optional + enabled = false, // optional + logging = false, // optional + entrypoint = "<ENTRYPOINT>", // optional + commands = "<COMMANDS>", // optional + scopes = listOf(), // optional + installationId = "<INSTALLATION_ID>", // optional + providerRepositoryId = "<PROVIDER_REPOSITORY_ID>", // optional + providerBranch = "<PROVIDER_BRANCH>", // optional + providerSilentMode = false, // optional + providerRootDirectory = "<PROVIDER_ROOT_DIRECTORY>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/graphql/mutation.md b/docs/examples/1.6.x/server-kotlin/kotlin/graphql/mutation.md new file mode 100644 index 0000000000..fa0f9e3c0f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/graphql/mutation.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Graphql + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val graphql = Graphql(client) + +val response = graphql.mutation( + query = mapOf( "a" to "b" ) +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/graphql/query.md b/docs/examples/1.6.x/server-kotlin/kotlin/graphql/query.md new file mode 100644 index 0000000000..e6786fa116 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/graphql/query.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Graphql + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val graphql = Graphql(client) + +val response = graphql.query( + query = mapOf( "a" to "b" ) +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-antivirus.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-antivirus.md new file mode 100644 index 0000000000..3f3773aa48 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-antivirus.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getAntivirus() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-cache.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-cache.md new file mode 100644 index 0000000000..5c1fbe0389 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-cache.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getCache() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-certificate.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-certificate.md new file mode 100644 index 0000000000..5324bcb0fa --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-certificate.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getCertificate( + domain = "" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-d-b.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-d-b.md new file mode 100644 index 0000000000..0eeeb078c8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-d-b.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getDB() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-failed-jobs.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-failed-jobs.md new file mode 100644 index 0000000000..397fbe668d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-failed-jobs.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health +import io.appwrite.enums.Name + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getFailedJobs( + name = .V1_DATABASE, + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-pub-sub.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-pub-sub.md new file mode 100644 index 0000000000..ae4bc40552 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-pub-sub.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getPubSub() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-builds.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-builds.md new file mode 100644 index 0000000000..0014a7b561 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-builds.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueBuilds( + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-certificates.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-certificates.md new file mode 100644 index 0000000000..f69b1f956d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-certificates.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueCertificates( + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-databases.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-databases.md new file mode 100644 index 0000000000..7871ba3a06 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-databases.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueDatabases( + name = "<NAME>", // optional + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-deletes.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-deletes.md new file mode 100644 index 0000000000..280b7b8c3f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-deletes.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueDeletes( + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-functions.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-functions.md new file mode 100644 index 0000000000..3cdfbd56d2 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-functions.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueFunctions( + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-logs.md new file mode 100644 index 0000000000..2625fea201 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-logs.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueLogs( + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-mails.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-mails.md new file mode 100644 index 0000000000..9686737394 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-mails.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueMails( + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-messaging.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-messaging.md new file mode 100644 index 0000000000..57ade69c00 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-messaging.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueMessaging( + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-migrations.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-migrations.md new file mode 100644 index 0000000000..1aa093f84c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-migrations.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueMigrations( + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..a91d7100ca --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage-dump.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueUsageDump( + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage.md new file mode 100644 index 0000000000..1ca045f352 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueUsage( + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-webhooks.md new file mode 100644 index 0000000000..078eb86fa9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-webhooks.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueueWebhooks( + threshold = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue.md new file mode 100644 index 0000000000..6832b3aabd --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getQueue() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage-local.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage-local.md new file mode 100644 index 0000000000..10e00e5424 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage-local.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getStorageLocal() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage.md new file mode 100644 index 0000000000..3e4aa8cc43 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getStorage() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-time.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-time.md new file mode 100644 index 0000000000..88bca6f873 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-time.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.getTime() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get.md new file mode 100644 index 0000000000..cb0f776d08 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/health/get.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Health + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val health = Health(client) + +val response = health.get() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/get.md new file mode 100644 index 0000000000..c514a06c53 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/locale/get.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val locale = Locale(client) + +val response = locale.get() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-codes.md new file mode 100644 index 0000000000..b4baa8d6e6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-codes.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val locale = Locale(client) + +val response = locale.listCodes() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-continents.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-continents.md new file mode 100644 index 0000000000..e77f129770 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-continents.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val locale = Locale(client) + +val response = locale.listContinents() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-e-u.md new file mode 100644 index 0000000000..71cd28e92b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-e-u.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val locale = Locale(client) + +val response = locale.listCountriesEU() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-phones.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-phones.md new file mode 100644 index 0000000000..b0222161ed --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-phones.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val locale = Locale(client) + +val response = locale.listCountriesPhones() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries.md new file mode 100644 index 0000000000..44c8ecaa4d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val locale = Locale(client) + +val response = locale.listCountries() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-currencies.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-currencies.md new file mode 100644 index 0000000000..be9fc87888 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-currencies.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val locale = Locale(client) + +val response = locale.listCurrencies() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-languages.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-languages.md new file mode 100644 index 0000000000..cfaa22afc0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-languages.md @@ -0,0 +1,12 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Locale + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val locale = Locale(client) + +val response = locale.listLanguages() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-apns-provider.md new file mode 100644 index 0000000000..e4812bf421 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-apns-provider.md @@ -0,0 +1,21 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createApnsProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", + authKey = "<AUTH_KEY>", // optional + authKeyId = "<AUTH_KEY_ID>", // optional + teamId = "<TEAM_ID>", // optional + bundleId = "<BUNDLE_ID>", // optional + sandbox = false, // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-email.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-email.md new file mode 100644 index 0000000000..bdac6c268a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-email.md @@ -0,0 +1,25 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createEmail( + messageId = "<MESSAGE_ID>", + subject = "<SUBJECT>", + content = "<CONTENT>", + topics = listOf(), // optional + users = listOf(), // optional + targets = listOf(), // optional + cc = listOf(), // optional + bcc = listOf(), // optional + attachments = listOf(), // optional + draft = false, // optional + html = false, // optional + scheduledAt = "" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..a4fbeef049 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-fcm-provider.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createFcmProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", + serviceAccountJSON = mapOf( "a" to "b" ), // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..12aefde8ab --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-mailgun-provider.md @@ -0,0 +1,23 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createMailgunProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", + apiKey = "<API_KEY>", // optional + domain = "<DOMAIN>", // optional + isEuRegion = false, // optional + fromName = "<FROM_NAME>", // optional + fromEmail = "email@example.com", // optional + replyToName = "<REPLY_TO_NAME>", // optional + replyToEmail = "email@example.com", // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-msg91provider.md new file mode 100644 index 0000000000..e07f8473e5 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-msg91provider.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createMsg91Provider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", + templateId = "<TEMPLATE_ID>", // optional + senderId = "<SENDER_ID>", // optional + authKey = "<AUTH_KEY>", // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-push.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-push.md new file mode 100644 index 0000000000..ba5ef3ed7d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-push.md @@ -0,0 +1,29 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createPush( + messageId = "<MESSAGE_ID>", + title = "<TITLE>", + body = "<BODY>", + topics = listOf(), // optional + users = listOf(), // optional + targets = listOf(), // optional + data = mapOf( "a" to "b" ), // optional + action = "<ACTION>", // optional + image = "[ID1:ID2]", // optional + icon = "<ICON>", // optional + sound = "<SOUND>", // optional + color = "<COLOR>", // optional + tag = "<TAG>", // optional + badge = "<BADGE>", // optional + draft = false, // optional + scheduledAt = "" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..984d9370c6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sendgrid-provider.md @@ -0,0 +1,21 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createSendgridProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", + apiKey = "<API_KEY>", // optional + fromName = "<FROM_NAME>", // optional + fromEmail = "email@example.com", // optional + replyToName = "<REPLY_TO_NAME>", // optional + replyToEmail = "email@example.com", // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sms.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sms.md new file mode 100644 index 0000000000..7a6c14e554 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sms.md @@ -0,0 +1,20 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createSms( + messageId = "<MESSAGE_ID>", + content = "<CONTENT>", + topics = listOf(), // optional + users = listOf(), // optional + targets = listOf(), // optional + draft = false, // optional + scheduledAt = "" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..abcdc67f5e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-smtp-provider.md @@ -0,0 +1,27 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createSmtpProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", + host = "<HOST>", + port = 1, // optional + username = "<USERNAME>", // optional + password = "<PASSWORD>", // optional + encryption = "none", // optional + autoTLS = false, // optional + mailer = "<MAILER>", // optional + fromName = "<FROM_NAME>", // optional + fromEmail = "email@example.com", // optional + replyToName = "<REPLY_TO_NAME>", // optional + replyToEmail = "email@example.com", // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-subscriber.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-subscriber.md new file mode 100644 index 0000000000..81eca3168f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-subscriber.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setJWT("<YOUR_JWT>") // Your secret JSON Web Token + +val messaging = Messaging(client) + +val response = messaging.createSubscriber( + topicId = "<TOPIC_ID>", + subscriberId = "<SUBSCRIBER_ID>", + targetId = "<TARGET_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..017e502472 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-telesign-provider.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createTelesignProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", + from = "+12065550100", // optional + customerId = "<CUSTOMER_ID>", // optional + apiKey = "<API_KEY>", // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..4a2fe9a6c6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-textmagic-provider.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createTextmagicProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", + from = "+12065550100", // optional + username = "<USERNAME>", // optional + apiKey = "<API_KEY>", // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-topic.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-topic.md new file mode 100644 index 0000000000..7ef9a4cb88 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-topic.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createTopic( + topicId = "<TOPIC_ID>", + name = "<NAME>", + subscribe = listOf("any") // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..aa4b542d2c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-twilio-provider.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createTwilioProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", + from = "+12065550100", // optional + accountSid = "<ACCOUNT_SID>", // optional + authToken = "<AUTH_TOKEN>", // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..00f995f0ba --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-vonage-provider.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.createVonageProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", + from = "+12065550100", // optional + apiKey = "<API_KEY>", // optional + apiSecret = "<API_SECRET>", // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-provider.md new file mode 100644 index 0000000000..e46388d75b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-provider.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.deleteProvider( + providerId = "<PROVIDER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-subscriber.md new file mode 100644 index 0000000000..c9348cc8c0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-subscriber.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setJWT("<YOUR_JWT>") // Your secret JSON Web Token + +val messaging = Messaging(client) + +val response = messaging.deleteSubscriber( + topicId = "<TOPIC_ID>", + subscriberId = "<SUBSCRIBER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-topic.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-topic.md new file mode 100644 index 0000000000..723e412c76 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-topic.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.deleteTopic( + topicId = "<TOPIC_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete.md new file mode 100644 index 0000000000..9bb8dfeca8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.delete( + messageId = "<MESSAGE_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-message.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-message.md new file mode 100644 index 0000000000..a283c833a9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-message.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.getMessage( + messageId = "<MESSAGE_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-provider.md new file mode 100644 index 0000000000..d921b1620d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-provider.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.getProvider( + providerId = "<PROVIDER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-subscriber.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-subscriber.md new file mode 100644 index 0000000000..083a5368db --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-subscriber.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.getSubscriber( + topicId = "<TOPIC_ID>", + subscriberId = "<SUBSCRIBER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-topic.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-topic.md new file mode 100644 index 0000000000..00da358a75 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-topic.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.getTopic( + topicId = "<TOPIC_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-message-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-message-logs.md new file mode 100644 index 0000000000..5205806667 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-message-logs.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.listMessageLogs( + messageId = "<MESSAGE_ID>", + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-messages.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-messages.md new file mode 100644 index 0000000000..e73613dcdd --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-messages.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.listMessages( + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-provider-logs.md new file mode 100644 index 0000000000..784c7cef1b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-provider-logs.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.listProviderLogs( + providerId = "<PROVIDER_ID>", + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-providers.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-providers.md new file mode 100644 index 0000000000..52f166a60c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-providers.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.listProviders( + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..3a70e6c285 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscriber-logs.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.listSubscriberLogs( + subscriberId = "<SUBSCRIBER_ID>", + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscribers.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscribers.md new file mode 100644 index 0000000000..6a123a9a53 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscribers.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.listSubscribers( + topicId = "<TOPIC_ID>", + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-targets.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-targets.md new file mode 100644 index 0000000000..400e492ecc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-targets.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.listTargets( + messageId = "<MESSAGE_ID>", + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topic-logs.md new file mode 100644 index 0000000000..07caf1e936 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topic-logs.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.listTopicLogs( + topicId = "<TOPIC_ID>", + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topics.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topics.md new file mode 100644 index 0000000000..ce5b113b4e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topics.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.listTopics( + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-apns-provider.md new file mode 100644 index 0000000000..fada594ec8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-apns-provider.md @@ -0,0 +1,21 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateApnsProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", // optional + enabled = false, // optional + authKey = "<AUTH_KEY>", // optional + authKeyId = "<AUTH_KEY_ID>", // optional + teamId = "<TEAM_ID>", // optional + bundleId = "<BUNDLE_ID>", // optional + sandbox = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-email.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-email.md new file mode 100644 index 0000000000..c4e18d1862 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-email.md @@ -0,0 +1,25 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateEmail( + messageId = "<MESSAGE_ID>", + topics = listOf(), // optional + users = listOf(), // optional + targets = listOf(), // optional + subject = "<SUBJECT>", // optional + content = "<CONTENT>", // optional + draft = false, // optional + html = false, // optional + cc = listOf(), // optional + bcc = listOf(), // optional + scheduledAt = "", // optional + attachments = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..6f3658a9d9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-fcm-provider.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateFcmProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", // optional + enabled = false, // optional + serviceAccountJSON = mapOf( "a" to "b" ) // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..82796ca5fc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-mailgun-provider.md @@ -0,0 +1,23 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateMailgunProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", // optional + apiKey = "<API_KEY>", // optional + domain = "<DOMAIN>", // optional + isEuRegion = false, // optional + enabled = false, // optional + fromName = "<FROM_NAME>", // optional + fromEmail = "email@example.com", // optional + replyToName = "<REPLY_TO_NAME>", // optional + replyToEmail = "<REPLY_TO_EMAIL>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-msg91provider.md new file mode 100644 index 0000000000..ee8255e6f6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-msg91provider.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateMsg91Provider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", // optional + enabled = false, // optional + templateId = "<TEMPLATE_ID>", // optional + senderId = "<SENDER_ID>", // optional + authKey = "<AUTH_KEY>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-push.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-push.md new file mode 100644 index 0000000000..80e337a1ec --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-push.md @@ -0,0 +1,29 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updatePush( + messageId = "<MESSAGE_ID>", + topics = listOf(), // optional + users = listOf(), // optional + targets = listOf(), // optional + title = "<TITLE>", // optional + body = "<BODY>", // optional + data = mapOf( "a" to "b" ), // optional + action = "<ACTION>", // optional + image = "[ID1:ID2]", // optional + icon = "<ICON>", // optional + sound = "<SOUND>", // optional + color = "<COLOR>", // optional + tag = "<TAG>", // optional + badge = 0, // optional + draft = false, // optional + scheduledAt = "" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..29f7ad35e8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sendgrid-provider.md @@ -0,0 +1,21 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateSendgridProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", // optional + enabled = false, // optional + apiKey = "<API_KEY>", // optional + fromName = "<FROM_NAME>", // optional + fromEmail = "email@example.com", // optional + replyToName = "<REPLY_TO_NAME>", // optional + replyToEmail = "<REPLY_TO_EMAIL>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sms.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sms.md new file mode 100644 index 0000000000..4b38ced83e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sms.md @@ -0,0 +1,20 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateSms( + messageId = "<MESSAGE_ID>", + topics = listOf(), // optional + users = listOf(), // optional + targets = listOf(), // optional + content = "<CONTENT>", // optional + draft = false, // optional + scheduledAt = "" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..fb51b71018 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-smtp-provider.md @@ -0,0 +1,27 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateSmtpProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", // optional + host = "<HOST>", // optional + port = 1, // optional + username = "<USERNAME>", // optional + password = "<PASSWORD>", // optional + encryption = "none", // optional + autoTLS = false, // optional + mailer = "<MAILER>", // optional + fromName = "<FROM_NAME>", // optional + fromEmail = "email@example.com", // optional + replyToName = "<REPLY_TO_NAME>", // optional + replyToEmail = "<REPLY_TO_EMAIL>", // optional + enabled = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..6fa9399ff8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-telesign-provider.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateTelesignProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", // optional + enabled = false, // optional + customerId = "<CUSTOMER_ID>", // optional + apiKey = "<API_KEY>", // optional + from = "<FROM>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..a94c566bc7 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-textmagic-provider.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateTextmagicProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", // optional + enabled = false, // optional + username = "<USERNAME>", // optional + apiKey = "<API_KEY>", // optional + from = "<FROM>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-topic.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-topic.md new file mode 100644 index 0000000000..36b294a153 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-topic.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateTopic( + topicId = "<TOPIC_ID>", + name = "<NAME>", // optional + subscribe = listOf("any") // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..c02d364219 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-twilio-provider.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateTwilioProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", // optional + enabled = false, // optional + accountSid = "<ACCOUNT_SID>", // optional + authToken = "<AUTH_TOKEN>", // optional + from = "<FROM>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..7ef04e7eb6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-vonage-provider.md @@ -0,0 +1,19 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Messaging + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val messaging = Messaging(client) + +val response = messaging.updateVonageProvider( + providerId = "<PROVIDER_ID>", + name = "<NAME>", // optional + enabled = false, // optional + apiKey = "<API_KEY>", // optional + apiSecret = "<API_SECRET>", // optional + from = "<FROM>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-bucket.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-bucket.md new file mode 100644 index 0000000000..f2a58c80c5 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-bucket.md @@ -0,0 +1,23 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val storage = Storage(client) + +val response = storage.createBucket( + bucketId = "<BUCKET_ID>", + name = "<NAME>", + permissions = listOf("read("any")"), // optional + fileSecurity = false, // optional + enabled = false, // optional + maximumFileSize = 1, // optional + allowedFileExtensions = listOf(), // optional + compression = "none", // optional + encryption = false, // optional + antivirus = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-file.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-file.md new file mode 100644 index 0000000000..4a9aceaa51 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-file.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.models.InputFile +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val storage = Storage(client) + +val response = storage.createFile( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>", + file = InputFile.fromPath("file.png"), + permissions = listOf("read("any")") // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-bucket.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-bucket.md new file mode 100644 index 0000000000..0476b65067 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-bucket.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val storage = Storage(client) + +val response = storage.deleteBucket( + bucketId = "<BUCKET_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-file.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-file.md new file mode 100644 index 0000000000..0ee4bd9e83 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-file.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val storage = Storage(client) + +val response = storage.deleteFile( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-bucket.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-bucket.md new file mode 100644 index 0000000000..048a5b8da4 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-bucket.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val storage = Storage(client) + +val response = storage.getBucket( + bucketId = "<BUCKET_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-download.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-download.md new file mode 100644 index 0000000000..2ad38a15e5 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-download.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val storage = Storage(client) + +val result = storage.getFileDownload( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-preview.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-preview.md new file mode 100644 index 0000000000..3a72c6e392 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-preview.md @@ -0,0 +1,26 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val storage = Storage(client) + +val result = storage.getFilePreview( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>", + width = 0, // optional + height = 0, // optional + gravity = "center", // optional + quality = 0, // optional + borderWidth = 0, // optional + borderColor = "", // optional + borderRadius = 0, // optional + opacity = 0, // optional + rotation = -360, // optional + background = "", // optional + output = "jpg" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-view.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-view.md new file mode 100644 index 0000000000..f5ff5f72df --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-view.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val storage = Storage(client) + +val result = storage.getFileView( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file.md new file mode 100644 index 0000000000..f2df8caf46 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val storage = Storage(client) + +val response = storage.getFile( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-buckets.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-buckets.md new file mode 100644 index 0000000000..2d2b6ffdd6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-buckets.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val storage = Storage(client) + +val response = storage.listBuckets( + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-files.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-files.md new file mode 100644 index 0000000000..125d057df0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-files.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val storage = Storage(client) + +val response = storage.listFiles( + bucketId = "<BUCKET_ID>", + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-bucket.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-bucket.md new file mode 100644 index 0000000000..fcdbb45ba3 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-bucket.md @@ -0,0 +1,23 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val storage = Storage(client) + +val response = storage.updateBucket( + bucketId = "<BUCKET_ID>", + name = "<NAME>", + permissions = listOf("read("any")"), // optional + fileSecurity = false, // optional + enabled = false, // optional + maximumFileSize = 1, // optional + allowedFileExtensions = listOf(), // optional + compression = "none", // optional + encryption = false, // optional + antivirus = false // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-file.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-file.md new file mode 100644 index 0000000000..1bb8ea0578 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-file.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Storage + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val storage = Storage(client) + +val response = storage.updateFile( + bucketId = "<BUCKET_ID>", + fileId = "<FILE_ID>", + name = "<NAME>", // optional + permissions = listOf("read("any")") // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/create-membership.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/create-membership.md new file mode 100644 index 0000000000..f91082bdca --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/create-membership.md @@ -0,0 +1,20 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.createMembership( + teamId = "<TEAM_ID>", + roles = listOf(), + email = "email@example.com", // optional + userId = "<USER_ID>", // optional + phone = "+12065550100", // optional + url = "https://example.com", // optional + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/create.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/create.md new file mode 100644 index 0000000000..8ecf098856 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/create.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.create( + teamId = "<TEAM_ID>", + name = "<NAME>", + roles = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete-membership.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete-membership.md new file mode 100644 index 0000000000..02de6860b9 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete-membership.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.deleteMembership( + teamId = "<TEAM_ID>", + membershipId = "<MEMBERSHIP_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete.md new file mode 100644 index 0000000000..be0c611ac4 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.delete( + teamId = "<TEAM_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-membership.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-membership.md new file mode 100644 index 0000000000..604dfc7f66 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-membership.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.getMembership( + teamId = "<TEAM_ID>", + membershipId = "<MEMBERSHIP_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-prefs.md new file mode 100644 index 0000000000..67b0d4bb75 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-prefs.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.getPrefs( + teamId = "<TEAM_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/get.md new file mode 100644 index 0000000000..e2f86b784a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/get.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.get( + teamId = "<TEAM_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/list-memberships.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/list-memberships.md new file mode 100644 index 0000000000..d647b8046d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/list-memberships.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.listMemberships( + teamId = "<TEAM_ID>", + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/list.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/list.md new file mode 100644 index 0000000000..c71199b82c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/list.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.list( + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership-status.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership-status.md new file mode 100644 index 0000000000..26a2a9029e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership-status.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.updateMembershipStatus( + teamId = "<TEAM_ID>", + membershipId = "<MEMBERSHIP_ID>", + userId = "<USER_ID>", + secret = "<SECRET>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership.md new file mode 100644 index 0000000000..bfdbafccbc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.updateMembership( + teamId = "<TEAM_ID>", + membershipId = "<MEMBERSHIP_ID>", + roles = listOf() +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-name.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-name.md new file mode 100644 index 0000000000..a3b64bf4f3 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-name.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.updateName( + teamId = "<TEAM_ID>", + name = "<NAME>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-prefs.md new file mode 100644 index 0000000000..bc8358a86e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-prefs.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Teams + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +val teams = Teams(client) + +val response = teams.updatePrefs( + teamId = "<TEAM_ID>", + prefs = mapOf( "a" to "b" ) +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-argon2user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-argon2user.md new file mode 100644 index 0000000000..fe396f3d40 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-argon2user.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createArgon2User( + userId = "<USER_ID>", + email = "email@example.com", + password = "password", + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-bcrypt-user.md new file mode 100644 index 0000000000..97cb9fbb35 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-bcrypt-user.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createBcryptUser( + userId = "<USER_ID>", + email = "email@example.com", + password = "password", + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-j-w-t.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-j-w-t.md new file mode 100644 index 0000000000..7a4a285449 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-j-w-t.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createJWT( + userId = "<USER_ID>", + sessionId = "<SESSION_ID>", // optional + duration = 0 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-m-d5user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-m-d5user.md new file mode 100644 index 0000000000..9e841fe30a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-m-d5user.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createMD5User( + userId = "<USER_ID>", + email = "email@example.com", + password = "password", + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..6c40473842 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-mfa-recovery-codes.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createMfaRecoveryCodes( + userId = "<USER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..d750bbe613 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-p-h-pass-user.md @@ -0,0 +1,17 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createPHPassUser( + userId = "<USER_ID>", + email = "email@example.com", + password = "password", + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-s-h-a-user.md new file mode 100644 index 0000000000..ca387cf846 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-s-h-a-user.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createSHAUser( + userId = "<USER_ID>", + email = "email@example.com", + password = "password", + passwordVersion = "sha1", // optional + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..51f0b6c430 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-modified-user.md @@ -0,0 +1,20 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createScryptModifiedUser( + userId = "<USER_ID>", + email = "email@example.com", + password = "password", + passwordSalt = "<PASSWORD_SALT>", + passwordSaltSeparator = "<PASSWORD_SALT_SEPARATOR>", + passwordSignerKey = "<PASSWORD_SIGNER_KEY>", + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-user.md new file mode 100644 index 0000000000..4081f625c3 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-user.md @@ -0,0 +1,22 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createScryptUser( + userId = "<USER_ID>", + email = "email@example.com", + password = "password", + passwordSalt = "<PASSWORD_SALT>", + passwordCpu = 0, + passwordMemory = 0, + passwordParallel = 0, + passwordLength = 0, + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-session.md new file mode 100644 index 0000000000..41842441e0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-session.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createSession( + userId = "<USER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-target.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-target.md new file mode 100644 index 0000000000..9fa3a74b72 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-target.md @@ -0,0 +1,20 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users +import io.appwrite.enums.MessagingProviderType + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createTarget( + userId = "<USER_ID>", + targetId = "<TARGET_ID>", + providerType = MessagingProviderType.EMAIL, + identifier = "<IDENTIFIER>", + providerId = "<PROVIDER_ID>", // optional + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-token.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-token.md new file mode 100644 index 0000000000..0687d3a2a6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-token.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.createToken( + userId = "<USER_ID>", + length = 4, // optional + expire = 60 // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create.md new file mode 100644 index 0000000000..21362593c6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/create.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.create( + userId = "<USER_ID>", + email = "email@example.com", // optional + phone = "+12065550100", // optional + password = "", // optional + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-identity.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-identity.md new file mode 100644 index 0000000000..0574f4dbdd --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-identity.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.deleteIdentity( + identityId = "<IDENTITY_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..8ec1613314 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-mfa-authenticator.md @@ -0,0 +1,16 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users +import io.appwrite.enums.AuthenticatorType + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.deleteMfaAuthenticator( + userId = "<USER_ID>", + type = AuthenticatorType.TOTP +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-session.md new file mode 100644 index 0000000000..15abe3a13b --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-session.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.deleteSession( + userId = "<USER_ID>", + sessionId = "<SESSION_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-sessions.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-sessions.md new file mode 100644 index 0000000000..1028c9e2e5 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-sessions.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.deleteSessions( + userId = "<USER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-target.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-target.md new file mode 100644 index 0000000000..ccde9049cc --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-target.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.deleteTarget( + userId = "<USER_ID>", + targetId = "<TARGET_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete.md new file mode 100644 index 0000000000..7273c67136 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.delete( + userId = "<USER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..b748003d6f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/get-mfa-recovery-codes.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.getMfaRecoveryCodes( + userId = "<USER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/get-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/get-prefs.md new file mode 100644 index 0000000000..2282c8d00c --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/get-prefs.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.getPrefs( + userId = "<USER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/get-target.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/get-target.md new file mode 100644 index 0000000000..db016f3088 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/get-target.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.getTarget( + userId = "<USER_ID>", + targetId = "<TARGET_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/get.md new file mode 100644 index 0000000000..7effbb9921 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/get.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.get( + userId = "<USER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-identities.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-identities.md new file mode 100644 index 0000000000..0bc111e80a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-identities.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.listIdentities( + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-logs.md new file mode 100644 index 0000000000..8b140e57e7 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-logs.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.listLogs( + userId = "<USER_ID>", + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-memberships.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-memberships.md new file mode 100644 index 0000000000..6e2f1122a0 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-memberships.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.listMemberships( + userId = "<USER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-mfa-factors.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-mfa-factors.md new file mode 100644 index 0000000000..7fb799183d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-mfa-factors.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.listMfaFactors( + userId = "<USER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-sessions.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-sessions.md new file mode 100644 index 0000000000..4922d7364a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-sessions.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.listSessions( + userId = "<USER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-targets.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-targets.md new file mode 100644 index 0000000000..4ea9a09c88 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-targets.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.listTargets( + userId = "<USER_ID>", + queries = listOf() // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list.md new file mode 100644 index 0000000000..4360ae632e --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/list.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.list( + queries = listOf(), // optional + search = "<SEARCH>" // optional +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email-verification.md new file mode 100644 index 0000000000..37a69dbee6 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email-verification.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updateEmailVerification( + userId = "<USER_ID>", + emailVerification = false +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email.md new file mode 100644 index 0000000000..0a6a7c7e16 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updateEmail( + userId = "<USER_ID>", + email = "email@example.com" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-labels.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-labels.md new file mode 100644 index 0000000000..c54255392a --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-labels.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updateLabels( + userId = "<USER_ID>", + labels = listOf() +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..e251ce195f --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa-recovery-codes.md @@ -0,0 +1,14 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updateMfaRecoveryCodes( + userId = "<USER_ID>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa.md new file mode 100644 index 0000000000..c31642c6b8 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updateMfa( + userId = "<USER_ID>", + mfa = false +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-name.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-name.md new file mode 100644 index 0000000000..21102d3ad2 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-name.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updateName( + userId = "<USER_ID>", + name = "<NAME>" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-password.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-password.md new file mode 100644 index 0000000000..3104810f01 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-password.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updatePassword( + userId = "<USER_ID>", + password = "" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone-verification.md new file mode 100644 index 0000000000..516484ccf3 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone-verification.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updatePhoneVerification( + userId = "<USER_ID>", + phoneVerification = false +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone.md new file mode 100644 index 0000000000..47126c7c4d --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updatePhone( + userId = "<USER_ID>", + number = "+12065550100" +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-prefs.md new file mode 100644 index 0000000000..03abe5ad02 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-prefs.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updatePrefs( + userId = "<USER_ID>", + prefs = mapOf( "a" to "b" ) +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-status.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-status.md new file mode 100644 index 0000000000..fec039e599 --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-status.md @@ -0,0 +1,15 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updateStatus( + userId = "<USER_ID>", + status = false +) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-target.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-target.md new file mode 100644 index 0000000000..26aaa793de --- /dev/null +++ b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-target.md @@ -0,0 +1,18 @@ +import io.appwrite.Client +import io.appwrite.coroutines.CoroutineCallback +import io.appwrite.services.Users + +val client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +val users = Users(client) + +val response = users.updateTarget( + userId = "<USER_ID>", + targetId = "<TARGET_ID>", + identifier = "<IDENTIFIER>", // optional + providerId = "<PROVIDER_ID>", // optional + name = "<NAME>" // optional +) diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..bf28589e24 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-anonymous-session.md @@ -0,0 +1,9 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.createAnonymousSession(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..9652c900a1 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-email-password-session.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.createEmailPasswordSession( + 'email@example.com', // email + 'password' // password +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-email-token.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-email-token.md new file mode 100644 index 0000000000..92b614f400 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-email-token.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.createEmailToken( + '<USER_ID>', // userId + 'email@example.com', // email + false // phrase (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..e29b7c1f87 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-j-w-t.md @@ -0,0 +1,9 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.createJWT(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..d73906d5b6 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.createMagicURLToken( + '<USER_ID>', // userId + 'email@example.com', // email + 'https://example.com', // url (optional) + false // phrase (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..3227834f64 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-authenticator.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.createMfaAuthenticator( + sdk.AuthenticatorType.Totp // type +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..223e8f3645 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-challenge.md @@ -0,0 +1,11 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.createMfaChallenge( + sdk.AuthenticationFactor.Email // factor +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..7c311ba75c --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.createMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..133006b034 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-o-auth2token.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.createOAuth2Token( + sdk.OAuthProvider.Amazon, // provider + 'https://example.com', // success (optional) + 'https://example.com', // failure (optional) + [] // scopes (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-token.md new file mode 100644 index 0000000000..4c10068947 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-token.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.createPhoneToken( + '<USER_ID>', // userId + '+12065550100' // phone +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..ec297d6c8d --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-verification.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.createPhoneVerification(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-recovery.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-recovery.md new file mode 100644 index 0000000000..b347ef8b37 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-recovery.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.createRecovery( + 'email@example.com', // email + 'https://example.com' // url +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-session.md new file mode 100644 index 0000000000..8ff9b399fd --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-session.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.createSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-verification.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-verification.md new file mode 100644 index 0000000000..584eefb19e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create-verification.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.createVerification( + 'https://example.com' // url +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create.md b/docs/examples/1.6.x/server-nodejs/examples/account/create.md new file mode 100644 index 0000000000..c3b80c0970 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/create.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.create( + '<USER_ID>', // userId + 'email@example.com', // email + '', // password + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/delete-identity.md b/docs/examples/1.6.x/server-nodejs/examples/account/delete-identity.md new file mode 100644 index 0000000000..9413e9fe48 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/delete-identity.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.deleteIdentity( + '<IDENTITY_ID>' // identityId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-nodejs/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..173c663daa --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.deleteMfaAuthenticator( + sdk.AuthenticatorType.Totp // type +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/delete-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/delete-session.md new file mode 100644 index 0000000000..cd6b29498c --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/delete-session.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.deleteSession( + '<SESSION_ID>' // sessionId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-nodejs/examples/account/delete-sessions.md new file mode 100644 index 0000000000..a64365f5f4 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/delete-sessions.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.deleteSessions(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..5a7942eb12 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.getMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/get-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/account/get-prefs.md new file mode 100644 index 0000000000..5a2091f57e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/get-prefs.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.getPrefs(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/get-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/get-session.md new file mode 100644 index 0000000000..622a209ea2 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/get-session.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.getSession( + '<SESSION_ID>' // sessionId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/get.md b/docs/examples/1.6.x/server-nodejs/examples/account/get.md new file mode 100644 index 0000000000..2280d354d9 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/get.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.get(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/list-identities.md b/docs/examples/1.6.x/server-nodejs/examples/account/list-identities.md new file mode 100644 index 0000000000..f8fcf27f23 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/list-identities.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.listIdentities( + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/list-logs.md b/docs/examples/1.6.x/server-nodejs/examples/account/list-logs.md new file mode 100644 index 0000000000..0df7bb8133 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/list-logs.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.listLogs( + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-nodejs/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..b70505dd19 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/list-mfa-factors.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.listMfaFactors(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/list-sessions.md b/docs/examples/1.6.x/server-nodejs/examples/account/list-sessions.md new file mode 100644 index 0000000000..209434905a --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/list-sessions.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.listSessions(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-email.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-email.md new file mode 100644 index 0000000000..d165475e27 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-email.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updateEmail( + 'email@example.com', // email + 'password' // password +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..fcfc9ff4c1 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-m-f-a.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updateMFA( + false // mfa +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..5cd0228f3e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.updateMagicURLSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..9ea19d19c4 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-authenticator.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updateMfaAuthenticator( + sdk.AuthenticatorType.Totp, // type + '<OTP>' // otp +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..d66f7e6cf6 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-challenge.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updateMfaChallenge( + '<CHALLENGE_ID>', // challengeId + '<OTP>' // otp +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..c5f4fce70b --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-name.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-name.md new file mode 100644 index 0000000000..e57bd12562 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-name.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updateName( + '<NAME>' // name +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-password.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-password.md new file mode 100644 index 0000000000..8ddbef43ee --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-password.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updatePassword( + '', // password + 'password' // oldPassword (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-session.md new file mode 100644 index 0000000000..17fddbc1da --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-session.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>'); // Your project ID + +const account = new sdk.Account(client); + +const result = await account.updatePhoneSession( + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..5e7c0bdecc --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-verification.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updatePhoneVerification( + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-phone.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-phone.md new file mode 100644 index 0000000000..3f6a85361b --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-phone.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updatePhone( + '+12065550100', // phone + 'password' // password +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-prefs.md new file mode 100644 index 0000000000..f4889bc14d --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-prefs.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updatePrefs( + {} // prefs +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-recovery.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-recovery.md new file mode 100644 index 0000000000..bdc50fb5a7 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-recovery.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updateRecovery( + '<USER_ID>', // userId + '<SECRET>', // secret + '' // password +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-session.md new file mode 100644 index 0000000000..40c572b388 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-session.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updateSession( + '<SESSION_ID>' // sessionId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-status.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-status.md new file mode 100644 index 0000000000..769d6695df --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-status.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updateStatus(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-verification.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-verification.md new file mode 100644 index 0000000000..631d01a8ac --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/account/update-verification.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const account = new sdk.Account(client); + +const result = await account.updateVerification( + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-browser.md new file mode 100644 index 0000000000..c9973c40f5 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-browser.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new sdk.Avatars(client); + +const result = await avatars.getBrowser( + sdk.Browser.AvantBrowser, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..51a20239ef --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-credit-card.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new sdk.Avatars(client); + +const result = await avatars.getCreditCard( + sdk.CreditCard.AmericanExpress, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..af44e4e49e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-favicon.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new sdk.Avatars(client); + +const result = await avatars.getFavicon( + 'https://example.com' // url +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-flag.md new file mode 100644 index 0000000000..a755070e7b --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-flag.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new sdk.Avatars(client); + +const result = await avatars.getFlag( + sdk.Flag.Afghanistan, // code + 0, // width (optional) + 0, // height (optional) + 0 // quality (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-image.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-image.md new file mode 100644 index 0000000000..f9b820faf5 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-image.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new sdk.Avatars(client); + +const result = await avatars.getImage( + 'https://example.com', // url + 0, // width (optional) + 0 // height (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-initials.md new file mode 100644 index 0000000000..4ad89bbf11 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-initials.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new sdk.Avatars(client); + +const result = await avatars.getInitials( + '<NAME>', // name (optional) + 0, // width (optional) + 0, // height (optional) + '' // background (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..8ca6e1fec3 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-q-r.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const avatars = new sdk.Avatars(client); + +const result = await avatars.getQR( + '<TEXT>', // text + 1, // size (optional) + 0, // margin (optional) + false // download (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..e0d9c4e938 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-boolean-attribute.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createBooleanAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + false, // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-collection.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-collection.md new file mode 100644 index 0000000000..f2a7ee1b86 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-collection.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // documentSecurity (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..4849649f9b --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-datetime-attribute.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createDatetimeAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '', // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-document.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-document.md new file mode 100644 index 0000000000..c5f44c0c14 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-document.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const databases = new sdk.Databases(client); + +const result = await databases.createDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + {}, // data + ["read("any")"] // permissions (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..f629ace193 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-email-attribute.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createEmailAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'email@example.com', // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..2aa0a03842 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-enum-attribute.md @@ -0,0 +1,18 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createEnumAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + [], // elements + false, // required + '<DEFAULT>', // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..7b0b4ddcc6 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-float-attribute.md @@ -0,0 +1,19 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createFloatAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min (optional) + null, // max (optional) + null, // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-index.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-index.md new file mode 100644 index 0000000000..172b6231f4 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-index.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createIndex( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + sdk.IndexType.Key, // type + [], // attributes + [] // orders (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..b9cb5d3d7f --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-integer-attribute.md @@ -0,0 +1,19 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createIntegerAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min (optional) + null, // max (optional) + null, // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..ac468c5b52 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-ip-attribute.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createIpAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '', // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..8b0d199e70 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-relationship-attribute.md @@ -0,0 +1,19 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createRelationshipAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<RELATED_COLLECTION_ID>', // relatedCollectionId + sdk.RelationshipType.OneToOne, // type + false, // twoWay (optional) + '', // key (optional) + '', // twoWayKey (optional) + sdk.RelationMutate.Cascade // onDelete (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..c9702e2df0 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-string-attribute.md @@ -0,0 +1,19 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createStringAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + 1, // size + false, // required + '<DEFAULT>', // default (optional) + false, // array (optional) + false // encrypt (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..0707dfa9ab --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create-url-attribute.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.createUrlAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'https://example.com', // default (optional) + false // array (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create.md new file mode 100644 index 0000000000..6427a45506 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/create.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.create( + '<DATABASE_ID>', // databaseId + '<NAME>', // name + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..e467b01a15 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-attribute.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.deleteAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-collection.md new file mode 100644 index 0000000000..0735ea830c --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-collection.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.deleteCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>' // collectionId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-document.md b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-document.md new file mode 100644 index 0000000000..94b52a13ca --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-document.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const databases = new sdk.Databases(client); + +const result = await databases.deleteDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>' // documentId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-index.md b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-index.md new file mode 100644 index 0000000000..0b62c30a17 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-index.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.deleteIndex( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/delete.md b/docs/examples/1.6.x/server-nodejs/examples/databases/delete.md new file mode 100644 index 0000000000..192649cbca --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/delete.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.delete( + '<DATABASE_ID>' // databaseId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/get-attribute.md new file mode 100644 index 0000000000..915f269b02 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/get-attribute.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.getAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/get-collection.md b/docs/examples/1.6.x/server-nodejs/examples/databases/get-collection.md new file mode 100644 index 0000000000..51d6acbe84 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/get-collection.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.getCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>' // collectionId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/get-document.md b/docs/examples/1.6.x/server-nodejs/examples/databases/get-document.md new file mode 100644 index 0000000000..16d91ce408 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/get-document.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const databases = new sdk.Databases(client); + +const result = await databases.getDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/get-index.md b/docs/examples/1.6.x/server-nodejs/examples/databases/get-index.md new file mode 100644 index 0000000000..78e93f8889 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/get-index.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.getIndex( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '' // key +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/get.md b/docs/examples/1.6.x/server-nodejs/examples/databases/get.md new file mode 100644 index 0000000000..04b28c9f78 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/get.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.get( + '<DATABASE_ID>' // databaseId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-nodejs/examples/databases/list-attributes.md new file mode 100644 index 0000000000..fb670ac2b8 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/list-attributes.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.listAttributes( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/list-collections.md b/docs/examples/1.6.x/server-nodejs/examples/databases/list-collections.md new file mode 100644 index 0000000000..d57396e0d7 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/list-collections.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.listCollections( + '<DATABASE_ID>', // databaseId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/list-documents.md b/docs/examples/1.6.x/server-nodejs/examples/databases/list-documents.md new file mode 100644 index 0000000000..35bc853c93 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/list-documents.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const databases = new sdk.Databases(client); + +const result = await databases.listDocuments( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-nodejs/examples/databases/list-indexes.md new file mode 100644 index 0000000000..f600cef479 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/list-indexes.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.listIndexes( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/list.md b/docs/examples/1.6.x/server-nodejs/examples/databases/list.md new file mode 100644 index 0000000000..6108fdb8a4 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/list.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..c036e185f4 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-boolean-attribute.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.updateBooleanAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + false // default +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-collection.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-collection.md new file mode 100644 index 0000000000..a8f0297a78 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-collection.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.updateCollection( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // documentSecurity (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..c82b0c4bf3 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-datetime-attribute.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.updateDatetimeAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '' // default +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-document.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-document.md new file mode 100644 index 0000000000..be1e7c3496 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-document.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const databases = new sdk.Databases(client); + +const result = await databases.updateDocument( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '<DOCUMENT_ID>', // documentId + {}, // data (optional) + ["read("any")"] // permissions (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..60771fbc90 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-email-attribute.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.updateEmailAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'email@example.com' // default +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..f7e06de814 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-enum-attribute.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.updateEnumAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + [], // elements + false, // required + '<DEFAULT>' // default +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..911bc832a4 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-float-attribute.md @@ -0,0 +1,18 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.updateFloatAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min + null, // max + null // default +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..17fd591c69 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-integer-attribute.md @@ -0,0 +1,18 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.updateIntegerAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + null, // min + null, // max + null // default +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..abbee0bbc8 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-ip-attribute.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.updateIpAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '' // default +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..122c4e9715 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-relationship-attribute.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.updateRelationshipAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + sdk.RelationMutate.Cascade // onDelete (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..8f9d0a8ed5 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-string-attribute.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.updateStringAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + '<DEFAULT>' // default +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..851a082e57 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update-url-attribute.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.updateUrlAttribute( + '<DATABASE_ID>', // databaseId + '<COLLECTION_ID>', // collectionId + '', // key + false, // required + 'https://example.com' // default +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update.md new file mode 100644 index 0000000000..cd3a479595 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/databases/update.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const databases = new sdk.Databases(client); + +const result = await databases.update( + '<DATABASE_ID>', // databaseId + '<NAME>', // name + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/create-build.md b/docs/examples/1.6.x/server-nodejs/examples/functions/create-build.md new file mode 100644 index 0000000000..447d4dc994 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/create-build.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.createBuild( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>', // deploymentId + '<BUILD_ID>' // buildId (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-nodejs/examples/functions/create-deployment.md new file mode 100644 index 0000000000..b897e27380 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/create-deployment.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); +const fs = require('fs'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.createDeployment( + '<FUNCTION_ID>', // functionId + InputFile.fromPath('/path/to/file', 'filename'), // code + false, // activate + '<ENTRYPOINT>', // entrypoint (optional) + '<COMMANDS>' // commands (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/create-execution.md b/docs/examples/1.6.x/server-nodejs/examples/functions/create-execution.md new file mode 100644 index 0000000000..1b5e09b094 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/create-execution.md @@ -0,0 +1,18 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const functions = new sdk.Functions(client); + +const result = await functions.createExecution( + '<FUNCTION_ID>', // functionId + '<BODY>', // body (optional) + false, // async (optional) + '<PATH>', // path (optional) + sdk.ExecutionMethod.GET, // method (optional) + {}, // headers (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/create-variable.md b/docs/examples/1.6.x/server-nodejs/examples/functions/create-variable.md new file mode 100644 index 0000000000..ae8b162800 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/create-variable.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.createVariable( + '<FUNCTION_ID>', // functionId + '<KEY>', // key + '<VALUE>' // value +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/create.md b/docs/examples/1.6.x/server-nodejs/examples/functions/create.md new file mode 100644 index 0000000000..0ba39858b2 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/create.md @@ -0,0 +1,32 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.create( + '<FUNCTION_ID>', // functionId + '<NAME>', // name + sdk..Node145, // runtime + ["any"], // execute (optional) + [], // events (optional) + '', // schedule (optional) + 1, // timeout (optional) + false, // enabled (optional) + false, // logging (optional) + '<ENTRYPOINT>', // entrypoint (optional) + '<COMMANDS>', // commands (optional) + [], // scopes (optional) + '<INSTALLATION_ID>', // installationId (optional) + '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) + '<PROVIDER_BRANCH>', // providerBranch (optional) + false, // providerSilentMode (optional) + '<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional) + '<TEMPLATE_REPOSITORY>', // templateRepository (optional) + '<TEMPLATE_OWNER>', // templateOwner (optional) + '<TEMPLATE_ROOT_DIRECTORY>', // templateRootDirectory (optional) + '<TEMPLATE_BRANCH>' // templateBranch (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-nodejs/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..d55121c59d --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/delete-deployment.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.deleteDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-nodejs/examples/functions/delete-execution.md new file mode 100644 index 0000000000..36e6db1a20 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/delete-execution.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.deleteExecution( + '<FUNCTION_ID>', // functionId + '<EXECUTION_ID>' // executionId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-nodejs/examples/functions/delete-variable.md new file mode 100644 index 0000000000..a311b11ce4 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/delete-variable.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.deleteVariable( + '<FUNCTION_ID>', // functionId + '<VARIABLE_ID>' // variableId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/delete.md b/docs/examples/1.6.x/server-nodejs/examples/functions/delete.md new file mode 100644 index 0000000000..52bdecc8df --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/delete.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.delete( + '<FUNCTION_ID>' // functionId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-nodejs/examples/functions/download-deployment.md new file mode 100644 index 0000000000..cae51c976e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/download-deployment.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.downloadDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-nodejs/examples/functions/get-deployment.md new file mode 100644 index 0000000000..315b4925bc --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/get-deployment.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.getDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/get-execution.md b/docs/examples/1.6.x/server-nodejs/examples/functions/get-execution.md new file mode 100644 index 0000000000..2945cd351a --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/get-execution.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const functions = new sdk.Functions(client); + +const result = await functions.getExecution( + '<FUNCTION_ID>', // functionId + '<EXECUTION_ID>' // executionId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/get-variable.md b/docs/examples/1.6.x/server-nodejs/examples/functions/get-variable.md new file mode 100644 index 0000000000..8917a88c85 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/get-variable.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.getVariable( + '<FUNCTION_ID>', // functionId + '<VARIABLE_ID>' // variableId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/get.md b/docs/examples/1.6.x/server-nodejs/examples/functions/get.md new file mode 100644 index 0000000000..2df1739c5e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/get.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.get( + '<FUNCTION_ID>' // functionId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-nodejs/examples/functions/list-deployments.md new file mode 100644 index 0000000000..f8642fa0fa --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/list-deployments.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.listDeployments( + '<FUNCTION_ID>', // functionId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/list-executions.md b/docs/examples/1.6.x/server-nodejs/examples/functions/list-executions.md new file mode 100644 index 0000000000..53f2833c3e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/list-executions.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const functions = new sdk.Functions(client); + +const result = await functions.listExecutions( + '<FUNCTION_ID>', // functionId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-nodejs/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..0b4442b948 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/list-runtimes.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.listRuntimes(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/list-variables.md b/docs/examples/1.6.x/server-nodejs/examples/functions/list-variables.md new file mode 100644 index 0000000000..2aa6124133 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/list-variables.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.listVariables( + '<FUNCTION_ID>' // functionId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/list.md b/docs/examples/1.6.x/server-nodejs/examples/functions/list.md new file mode 100644 index 0000000000..32a8316a3a --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/list.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..897a76a6b1 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment-build.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.updateDeploymentBuild( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment.md new file mode 100644 index 0000000000..4e7cc30bfc --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.updateDeployment( + '<FUNCTION_ID>', // functionId + '<DEPLOYMENT_ID>' // deploymentId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/update-variable.md b/docs/examples/1.6.x/server-nodejs/examples/functions/update-variable.md new file mode 100644 index 0000000000..e59bc005f4 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/update-variable.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.updateVariable( + '<FUNCTION_ID>', // functionId + '<VARIABLE_ID>', // variableId + '<KEY>', // key + '<VALUE>' // value (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/update.md b/docs/examples/1.6.x/server-nodejs/examples/functions/update.md new file mode 100644 index 0000000000..c437704516 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/functions/update.md @@ -0,0 +1,28 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const functions = new sdk.Functions(client); + +const result = await functions.update( + '<FUNCTION_ID>', // functionId + '<NAME>', // name + sdk..Node145, // runtime (optional) + ["any"], // execute (optional) + [], // events (optional) + '', // schedule (optional) + 1, // timeout (optional) + false, // enabled (optional) + false, // logging (optional) + '<ENTRYPOINT>', // entrypoint (optional) + '<COMMANDS>', // commands (optional) + [], // scopes (optional) + '<INSTALLATION_ID>', // installationId (optional) + '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) + '<PROVIDER_BRANCH>', // providerBranch (optional) + false, // providerSilentMode (optional) + '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/graphql/mutation.md b/docs/examples/1.6.x/server-nodejs/examples/graphql/mutation.md new file mode 100644 index 0000000000..26db8d424a --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/graphql/mutation.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const graphql = new sdk.Graphql(client); + +const result = await graphql.mutation( + {} // query +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/graphql/query.md b/docs/examples/1.6.x/server-nodejs/examples/graphql/query.md new file mode 100644 index 0000000000..dadf2ea059 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/graphql/query.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const graphql = new sdk.Graphql(client); + +const result = await graphql.query( + {} // query +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-antivirus.md new file mode 100644 index 0000000000..998d5ba640 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-antivirus.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getAntivirus(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-cache.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-cache.md new file mode 100644 index 0000000000..82b5417d18 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-cache.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getCache(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-certificate.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-certificate.md new file mode 100644 index 0000000000..8e4b0cd221 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-certificate.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getCertificate( + '' // domain (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-d-b.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-d-b.md new file mode 100644 index 0000000000..767b489c7d --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-d-b.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getDB(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..3494a1e863 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-failed-jobs.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getFailedJobs( + sdk..V1Database, // name + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..ca4d073e46 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-pub-sub.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getPubSub(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..4f20de3087 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-builds.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueBuilds( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..4cffb81043 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-certificates.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueCertificates( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..2bbc9d0f1e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-databases.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueDatabases( + '<NAME>', // name (optional) + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..abe5bd3967 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-deletes.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueDeletes( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..e27619c956 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-functions.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueFunctions( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..862f40bc70 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-logs.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueLogs( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..125f5884cd --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-mails.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueMails( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..22a2e4ea70 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-messaging.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueMessaging( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..643b9bf3fc --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-migrations.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueMigrations( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..7d3b36f697 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage-dump.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueUsageDump( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..3b3939475b --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueUsage( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..a42cbb6eb2 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-webhooks.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueueWebhooks( + null // threshold (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue.md new file mode 100644 index 0000000000..8dbd8a8b58 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getQueue(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-storage-local.md new file mode 100644 index 0000000000..c5a1f2d10a --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-storage-local.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getStorageLocal(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-storage.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-storage.md new file mode 100644 index 0000000000..d2f8ce1215 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-storage.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getStorage(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-time.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-time.md new file mode 100644 index 0000000000..6f03f315c1 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get-time.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.getTime(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get.md b/docs/examples/1.6.x/server-nodejs/examples/health/get.md new file mode 100644 index 0000000000..d6c27f7870 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/health/get.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const health = new sdk.Health(client); + +const result = await health.get(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/get.md b/docs/examples/1.6.x/server-nodejs/examples/locale/get.md new file mode 100644 index 0000000000..eebf0690de --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/locale/get.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new sdk.Locale(client); + +const result = await locale.get(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-codes.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-codes.md new file mode 100644 index 0000000000..32e3869ce9 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/locale/list-codes.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new sdk.Locale(client); + +const result = await locale.listCodes(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-continents.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-continents.md new file mode 100644 index 0000000000..964297480a --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/locale/list-continents.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new sdk.Locale(client); + +const result = await locale.listContinents(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..c7191127d9 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-e-u.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new sdk.Locale(client); + +const result = await locale.listCountriesEU(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..9a05844b4a --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-phones.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new sdk.Locale(client); + +const result = await locale.listCountriesPhones(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries.md new file mode 100644 index 0000000000..8fcca76562 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new sdk.Locale(client); + +const result = await locale.listCountries(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-currencies.md new file mode 100644 index 0000000000..4bcbd33619 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/locale/list-currencies.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new sdk.Locale(client); + +const result = await locale.listCurrencies(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-languages.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-languages.md new file mode 100644 index 0000000000..d1ce2c2199 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/locale/list-languages.md @@ -0,0 +1,10 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const locale = new sdk.Locale(client); + +const result = await locale.listLanguages(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..9f5e9f97aa --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-apns-provider.md @@ -0,0 +1,19 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createApnsProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<AUTH_KEY>', // authKey (optional) + '<AUTH_KEY_ID>', // authKeyId (optional) + '<TEAM_ID>', // teamId (optional) + '<BUNDLE_ID>', // bundleId (optional) + false, // sandbox (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-email.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-email.md new file mode 100644 index 0000000000..5df81b0a5d --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-email.md @@ -0,0 +1,23 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createEmail( + '<MESSAGE_ID>', // messageId + '<SUBJECT>', // subject + '<CONTENT>', // content + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + [], // cc (optional) + [], // bcc (optional) + [], // attachments (optional) + false, // draft (optional) + false, // html (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..e6f0e27534 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-fcm-provider.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createFcmProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + {}, // serviceAccountJSON (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..726c0b5dab --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,21 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createMailgunProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<API_KEY>', // apiKey (optional) + '<DOMAIN>', // domain (optional) + false, // isEuRegion (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + 'email@example.com', // replyToEmail (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..591f56b696 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-msg91provider.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createMsg91Provider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<TEMPLATE_ID>', // templateId (optional) + '<SENDER_ID>', // senderId (optional) + '<AUTH_KEY>', // authKey (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-push.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-push.md new file mode 100644 index 0000000000..bdf14f2c3a --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-push.md @@ -0,0 +1,27 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createPush( + '<MESSAGE_ID>', // messageId + '<TITLE>', // title + '<BODY>', // body + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + {}, // data (optional) + '<ACTION>', // action (optional) + '[ID1:ID2]', // image (optional) + '<ICON>', // icon (optional) + '<SOUND>', // sound (optional) + '<COLOR>', // color (optional) + '<TAG>', // tag (optional) + '<BADGE>', // badge (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..48b8a0a686 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,19 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createSendgridProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<API_KEY>', // apiKey (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + 'email@example.com', // replyToEmail (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sms.md new file mode 100644 index 0000000000..8116a3400a --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sms.md @@ -0,0 +1,18 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createSms( + '<MESSAGE_ID>', // messageId + '<CONTENT>', // content + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..2569fe72dd --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-smtp-provider.md @@ -0,0 +1,25 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createSmtpProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<HOST>', // host + 1, // port (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) + sdk.SmtpEncryption.None, // encryption (optional) + false, // autoTLS (optional) + '<MAILER>', // mailer (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + 'email@example.com', // replyToEmail (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..81d30a043c --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-subscriber.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>', // subscriberId + '<TARGET_ID>' // targetId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..65df58803e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-telesign-provider.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createTelesignProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<CUSTOMER_ID>', // customerId (optional) + '<API_KEY>', // apiKey (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..0ebc6913bc --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createTextmagicProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<USERNAME>', // username (optional) + '<API_KEY>', // apiKey (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-topic.md new file mode 100644 index 0000000000..875b14b583 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-topic.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createTopic( + '<TOPIC_ID>', // topicId + '<NAME>', // name + ["any"] // subscribe (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..dc65042ee9 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-twilio-provider.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createTwilioProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<ACCOUNT_SID>', // accountSid (optional) + '<AUTH_TOKEN>', // authToken (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..7376e42143 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-vonage-provider.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.createVonageProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '+12065550100', // from (optional) + '<API_KEY>', // apiKey (optional) + '<API_SECRET>', // apiSecret (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..907320670d --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-provider.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.deleteProvider( + '<PROVIDER_ID>' // providerId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..ba59c6856c --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-subscriber.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token + +const messaging = new sdk.Messaging(client); + +const result = await messaging.deleteSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>' // subscriberId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..32c387f170 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-topic.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.deleteTopic( + '<TOPIC_ID>' // topicId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete.md new file mode 100644 index 0000000000..b2de2d4bbb --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.delete( + '<MESSAGE_ID>' // messageId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-message.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-message.md new file mode 100644 index 0000000000..54a2f6edc5 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-message.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.getMessage( + '<MESSAGE_ID>' // messageId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-provider.md new file mode 100644 index 0000000000..687c500fa6 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-provider.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.getProvider( + '<PROVIDER_ID>' // providerId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..daa147f5f4 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-subscriber.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.getSubscriber( + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>' // subscriberId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-topic.md new file mode 100644 index 0000000000..539591c357 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-topic.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.getTopic( + '<TOPIC_ID>' // topicId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..86b03fbac6 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-message-logs.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.listMessageLogs( + '<MESSAGE_ID>', // messageId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-messages.md new file mode 100644 index 0000000000..ec5928665f --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-messages.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.listMessages( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..8523a9d34b --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-provider-logs.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.listProviderLogs( + '<PROVIDER_ID>', // providerId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-providers.md new file mode 100644 index 0000000000..bfd5c0375e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-providers.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.listProviders( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..0e9e311eb5 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.listSubscriberLogs( + '<SUBSCRIBER_ID>', // subscriberId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..f01917de61 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscribers.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.listSubscribers( + '<TOPIC_ID>', // topicId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-targets.md new file mode 100644 index 0000000000..15e405285d --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-targets.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.listTargets( + '<MESSAGE_ID>', // messageId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..7c4260b4de --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topic-logs.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.listTopicLogs( + '<TOPIC_ID>', // topicId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topics.md new file mode 100644 index 0000000000..c535502aa5 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topics.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.listTopics( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..85bf310392 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-apns-provider.md @@ -0,0 +1,19 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateApnsProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<AUTH_KEY>', // authKey (optional) + '<AUTH_KEY_ID>', // authKeyId (optional) + '<TEAM_ID>', // teamId (optional) + '<BUNDLE_ID>', // bundleId (optional) + false // sandbox (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-email.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-email.md new file mode 100644 index 0000000000..490f827686 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-email.md @@ -0,0 +1,23 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateEmail( + '<MESSAGE_ID>', // messageId + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + '<SUBJECT>', // subject (optional) + '<CONTENT>', // content (optional) + false, // draft (optional) + false, // html (optional) + [], // cc (optional) + [], // bcc (optional) + '', // scheduledAt (optional) + [] // attachments (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..ecbedda40e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-fcm-provider.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateFcmProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + {} // serviceAccountJSON (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..cabd5a1525 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,21 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateMailgunProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + '<API_KEY>', // apiKey (optional) + '<DOMAIN>', // domain (optional) + false, // isEuRegion (optional) + false, // enabled (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>' // replyToEmail (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..76b4410494 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-msg91provider.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateMsg91Provider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<TEMPLATE_ID>', // templateId (optional) + '<SENDER_ID>', // senderId (optional) + '<AUTH_KEY>' // authKey (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-push.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-push.md new file mode 100644 index 0000000000..6a0dde5a98 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-push.md @@ -0,0 +1,27 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updatePush( + '<MESSAGE_ID>', // messageId + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + '<TITLE>', // title (optional) + '<BODY>', // body (optional) + {}, // data (optional) + '<ACTION>', // action (optional) + '[ID1:ID2]', // image (optional) + '<ICON>', // icon (optional) + '<SOUND>', // sound (optional) + '<COLOR>', // color (optional) + '<TAG>', // tag (optional) + null, // badge (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..7aefbbbd15 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,19 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateSendgridProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<API_KEY>', // apiKey (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>' // replyToEmail (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sms.md new file mode 100644 index 0000000000..90e2709a7e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sms.md @@ -0,0 +1,18 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateSms( + '<MESSAGE_ID>', // messageId + [], // topics (optional) + [], // users (optional) + [], // targets (optional) + '<CONTENT>', // content (optional) + false, // draft (optional) + '' // scheduledAt (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..7b4286dd15 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-smtp-provider.md @@ -0,0 +1,25 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateSmtpProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + '<HOST>', // host (optional) + 1, // port (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) + sdk.SmtpEncryption.None, // encryption (optional) + false, // autoTLS (optional) + '<MAILER>', // mailer (optional) + '<FROM_NAME>', // fromName (optional) + 'email@example.com', // fromEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>', // replyToEmail (optional) + false // enabled (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..3cfc777033 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-telesign-provider.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateTelesignProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<CUSTOMER_ID>', // customerId (optional) + '<API_KEY>', // apiKey (optional) + '<FROM>' // from (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..603b6251a9 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateTextmagicProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<USERNAME>', // username (optional) + '<API_KEY>', // apiKey (optional) + '<FROM>' // from (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-topic.md new file mode 100644 index 0000000000..be2b54b1b0 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-topic.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateTopic( + '<TOPIC_ID>', // topicId + '<NAME>', // name (optional) + ["any"] // subscribe (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..6ae2d1005c --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-twilio-provider.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateTwilioProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<ACCOUNT_SID>', // accountSid (optional) + '<AUTH_TOKEN>', // authToken (optional) + '<FROM>' // from (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..f3b2ec514c --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-vonage-provider.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const messaging = new sdk.Messaging(client); + +const result = await messaging.updateVonageProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<API_KEY>', // apiKey (optional) + '<API_SECRET>', // apiSecret (optional) + '<FROM>' // from (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-nodejs/examples/storage/create-bucket.md new file mode 100644 index 0000000000..fac4246cfc --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/create-bucket.md @@ -0,0 +1,21 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const storage = new sdk.Storage(client); + +const result = await storage.createBucket( + '<BUCKET_ID>', // bucketId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // fileSecurity (optional) + false, // enabled (optional) + 1, // maximumFileSize (optional) + [], // allowedFileExtensions (optional) + sdk..None, // compression (optional) + false, // encryption (optional) + false // antivirus (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/create-file.md b/docs/examples/1.6.x/server-nodejs/examples/storage/create-file.md new file mode 100644 index 0000000000..216ec061eb --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/create-file.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); +const fs = require('fs'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new sdk.Storage(client); + +const result = await storage.createFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + InputFile.fromPath('/path/to/file', 'filename'), // file + ["read("any")"] // permissions (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-nodejs/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..8205316902 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/delete-bucket.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const storage = new sdk.Storage(client); + +const result = await storage.deleteBucket( + '<BUCKET_ID>' // bucketId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/delete-file.md b/docs/examples/1.6.x/server-nodejs/examples/storage/delete-file.md new file mode 100644 index 0000000000..72528cc2ef --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/delete-file.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new sdk.Storage(client); + +const result = await storage.deleteFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-nodejs/examples/storage/get-bucket.md new file mode 100644 index 0000000000..ee518bd223 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/get-bucket.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const storage = new sdk.Storage(client); + +const result = await storage.getBucket( + '<BUCKET_ID>' // bucketId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-download.md new file mode 100644 index 0000000000..d485cbcddc --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-download.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new sdk.Storage(client); + +const result = await storage.getFileDownload( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..d74fa17fc3 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-preview.md @@ -0,0 +1,24 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new sdk.Storage(client); + +const result = await storage.getFilePreview( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + 0, // width (optional) + 0, // height (optional) + sdk.ImageGravity.Center, // gravity (optional) + 0, // quality (optional) + 0, // borderWidth (optional) + '', // borderColor (optional) + 0, // borderRadius (optional) + 0, // opacity (optional) + -360, // rotation (optional) + '', // background (optional) + sdk.ImageFormat.Jpg // output (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-view.md new file mode 100644 index 0000000000..e9544c9d56 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-view.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new sdk.Storage(client); + +const result = await storage.getFileView( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file.md b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file.md new file mode 100644 index 0000000000..4f6829a854 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new sdk.Storage(client); + +const result = await storage.getFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-nodejs/examples/storage/list-buckets.md new file mode 100644 index 0000000000..0ae449ae8d --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/list-buckets.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const storage = new sdk.Storage(client); + +const result = await storage.listBuckets( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/list-files.md b/docs/examples/1.6.x/server-nodejs/examples/storage/list-files.md new file mode 100644 index 0000000000..5bcaaa1b86 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/list-files.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new sdk.Storage(client); + +const result = await storage.listFiles( + '<BUCKET_ID>', // bucketId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-nodejs/examples/storage/update-bucket.md new file mode 100644 index 0000000000..20c13f57b6 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/update-bucket.md @@ -0,0 +1,21 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const storage = new sdk.Storage(client); + +const result = await storage.updateBucket( + '<BUCKET_ID>', // bucketId + '<NAME>', // name + ["read("any")"], // permissions (optional) + false, // fileSecurity (optional) + false, // enabled (optional) + 1, // maximumFileSize (optional) + [], // allowedFileExtensions (optional) + sdk..None, // compression (optional) + false, // encryption (optional) + false // antivirus (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/update-file.md b/docs/examples/1.6.x/server-nodejs/examples/storage/update-file.md new file mode 100644 index 0000000000..d7cffd0ce6 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/storage/update-file.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const storage = new sdk.Storage(client); + +const result = await storage.updateFile( + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + '<NAME>', // name (optional) + ["read("any")"] // permissions (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/create-membership.md b/docs/examples/1.6.x/server-nodejs/examples/teams/create-membership.md new file mode 100644 index 0000000000..727dfed068 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/create-membership.md @@ -0,0 +1,18 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.createMembership( + '<TEAM_ID>', // teamId + [], // roles + 'email@example.com', // email (optional) + '<USER_ID>', // userId (optional) + '+12065550100', // phone (optional) + 'https://example.com', // url (optional) + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/create.md b/docs/examples/1.6.x/server-nodejs/examples/teams/create.md new file mode 100644 index 0000000000..0ebc5b88ed --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/create.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.create( + '<TEAM_ID>', // teamId + '<NAME>', // name + [] // roles (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-nodejs/examples/teams/delete-membership.md new file mode 100644 index 0000000000..45eeb6f62c --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/delete-membership.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.deleteMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/delete.md b/docs/examples/1.6.x/server-nodejs/examples/teams/delete.md new file mode 100644 index 0000000000..955d9db9e7 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/delete.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.delete( + '<TEAM_ID>' // teamId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/get-membership.md b/docs/examples/1.6.x/server-nodejs/examples/teams/get-membership.md new file mode 100644 index 0000000000..b3926ff6c1 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/get-membership.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.getMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/teams/get-prefs.md new file mode 100644 index 0000000000..3ba7de08d1 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/get-prefs.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.getPrefs( + '<TEAM_ID>' // teamId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/get.md b/docs/examples/1.6.x/server-nodejs/examples/teams/get.md new file mode 100644 index 0000000000..eb37554f73 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/get.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.get( + '<TEAM_ID>' // teamId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-nodejs/examples/teams/list-memberships.md new file mode 100644 index 0000000000..adb72ea318 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/list-memberships.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.listMemberships( + '<TEAM_ID>', // teamId + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/list.md b/docs/examples/1.6.x/server-nodejs/examples/teams/list.md new file mode 100644 index 0000000000..61d59eb517 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/list.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..dbcd2a1b6d --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership-status.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.updateMembershipStatus( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId + '<USER_ID>', // userId + '<SECRET>' // secret +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership.md b/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership.md new file mode 100644 index 0000000000..37b87d2c0e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.updateMembership( + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId + [] // roles +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/update-name.md b/docs/examples/1.6.x/server-nodejs/examples/teams/update-name.md new file mode 100644 index 0000000000..215953b077 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/update-name.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.updateName( + '<TEAM_ID>', // teamId + '<NAME>' // name +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/teams/update-prefs.md new file mode 100644 index 0000000000..a226c64d16 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/teams/update-prefs.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setSession(''); // The user session to authenticate with + +const teams = new sdk.Teams(client); + +const result = await teams.updatePrefs( + '<TEAM_ID>', // teamId + {} // prefs +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-argon2user.md new file mode 100644 index 0000000000..19ca547d1b --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-argon2user.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createArgon2User( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..b09f120572 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-bcrypt-user.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createBcryptUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..e8176955f0 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-j-w-t.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createJWT( + '<USER_ID>', // userId + '<SESSION_ID>', // sessionId (optional) + 0 // duration (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..6bc48cb6c1 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-m-d5user.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createMD5User( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..27e70f77fe --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createMfaRecoveryCodes( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..722257c809 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-p-h-pass-user.md @@ -0,0 +1,15 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createPHPassUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..e401a4eba5 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-s-h-a-user.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createSHAUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + sdk.PasswordHash.Sha1, // passwordVersion (optional) + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..bfae622ec6 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,18 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createScryptModifiedUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<PASSWORD_SALT>', // passwordSalt + '<PASSWORD_SALT_SEPARATOR>', // passwordSaltSeparator + '<PASSWORD_SIGNER_KEY>', // passwordSignerKey + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..6536d6a7c6 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-user.md @@ -0,0 +1,20 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createScryptUser( + '<USER_ID>', // userId + 'email@example.com', // email + 'password', // password + '<PASSWORD_SALT>', // passwordSalt + null, // passwordCpu + null, // passwordMemory + null, // passwordParallel + null, // passwordLength + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-session.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-session.md new file mode 100644 index 0000000000..a419c2ec81 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-session.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createSession( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-target.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-target.md new file mode 100644 index 0000000000..a76c90670a --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-target.md @@ -0,0 +1,17 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createTarget( + '<USER_ID>', // userId + '<TARGET_ID>', // targetId + sdk.MessagingProviderType.Email, // providerType + '<IDENTIFIER>', // identifier + '<PROVIDER_ID>', // providerId (optional) + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-token.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-token.md new file mode 100644 index 0000000000..f635f9846d --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create-token.md @@ -0,0 +1,14 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.createToken( + '<USER_ID>', // userId + 4, // length (optional) + 60 // expire (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create.md b/docs/examples/1.6.x/server-nodejs/examples/users/create.md new file mode 100644 index 0000000000..f28fa456b2 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/create.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.create( + '<USER_ID>', // userId + 'email@example.com', // email (optional) + '+12065550100', // phone (optional) + '', // password (optional) + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete-identity.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete-identity.md new file mode 100644 index 0000000000..5199ab5e2c --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/delete-identity.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.deleteIdentity( + '<IDENTITY_ID>' // identityId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..bcec77c201 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.deleteMfaAuthenticator( + '<USER_ID>', // userId + sdk.AuthenticatorType.Totp // type +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete-session.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete-session.md new file mode 100644 index 0000000000..8554c97895 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/delete-session.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.deleteSession( + '<USER_ID>', // userId + '<SESSION_ID>' // sessionId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete-sessions.md new file mode 100644 index 0000000000..cea3805b6c --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/delete-sessions.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.deleteSessions( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete-target.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete-target.md new file mode 100644 index 0000000000..48db925575 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/delete-target.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.deleteTarget( + '<USER_ID>', // userId + '<TARGET_ID>' // targetId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete.md new file mode 100644 index 0000000000..d1ed4165a4 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/delete.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.delete( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..a528e6c4b3 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.getMfaRecoveryCodes( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/get-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/users/get-prefs.md new file mode 100644 index 0000000000..7f51853c1c --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/get-prefs.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.getPrefs( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/get-target.md b/docs/examples/1.6.x/server-nodejs/examples/users/get-target.md new file mode 100644 index 0000000000..8a3d0378a3 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/get-target.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.getTarget( + '<USER_ID>', // userId + '<TARGET_ID>' // targetId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/get.md b/docs/examples/1.6.x/server-nodejs/examples/users/get.md new file mode 100644 index 0000000000..90581eff68 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/get.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.get( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-identities.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-identities.md new file mode 100644 index 0000000000..b5b2b92418 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/list-identities.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.listIdentities( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-logs.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-logs.md new file mode 100644 index 0000000000..914c4a58e1 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/list-logs.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.listLogs( + '<USER_ID>', // userId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-memberships.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-memberships.md new file mode 100644 index 0000000000..c73eeff2a4 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/list-memberships.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.listMemberships( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..7f4a6c13fb --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/list-mfa-factors.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.listMfaFactors( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-sessions.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-sessions.md new file mode 100644 index 0000000000..0de659f24b --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/list-sessions.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.listSessions( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-targets.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-targets.md new file mode 100644 index 0000000000..8858d25d15 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/list-targets.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.listTargets( + '<USER_ID>', // userId + [] // queries (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list.md b/docs/examples/1.6.x/server-nodejs/examples/users/list.md new file mode 100644 index 0000000000..00f823dedc --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/list.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.list( + [], // queries (optional) + '<SEARCH>' // search (optional) +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-email-verification.md new file mode 100644 index 0000000000..e5e275bcfc --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-email-verification.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updateEmailVerification( + '<USER_ID>', // userId + false // emailVerification +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-email.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-email.md new file mode 100644 index 0000000000..7908c6fdae --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-email.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updateEmail( + '<USER_ID>', // userId + 'email@example.com' // email +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-labels.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-labels.md new file mode 100644 index 0000000000..7aea5e87a1 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-labels.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updateLabels( + '<USER_ID>', // userId + [] // labels +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..d2c4bf962a --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updateMfaRecoveryCodes( + '<USER_ID>' // userId +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa.md new file mode 100644 index 0000000000..ed27b8d95f --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updateMfa( + '<USER_ID>', // userId + false // mfa +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-name.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-name.md new file mode 100644 index 0000000000..105e498f4e --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-name.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updateName( + '<USER_ID>', // userId + '<NAME>' // name +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-password.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-password.md new file mode 100644 index 0000000000..c9a569f8e3 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-password.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updatePassword( + '<USER_ID>', // userId + '' // password +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..9551246057 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-phone-verification.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updatePhoneVerification( + '<USER_ID>', // userId + false // phoneVerification +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-phone.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-phone.md new file mode 100644 index 0000000000..486cf6894d --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-phone.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updatePhone( + '<USER_ID>', // userId + '+12065550100' // number +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-prefs.md new file mode 100644 index 0000000000..ad1a283bde --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-prefs.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updatePrefs( + '<USER_ID>', // userId + {} // prefs +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-status.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-status.md new file mode 100644 index 0000000000..a56bcab437 --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-status.md @@ -0,0 +1,13 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updateStatus( + '<USER_ID>', // userId + false // status +); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-target.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-target.md new file mode 100644 index 0000000000..d4a9c861bf --- /dev/null +++ b/docs/examples/1.6.x/server-nodejs/examples/users/update-target.md @@ -0,0 +1,16 @@ +const sdk = require('node-appwrite'); + +const client = new sdk.Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('<YOUR_PROJECT_ID>') // Your project ID + .setKey('<YOUR_API_KEY>'); // Your secret API key + +const users = new sdk.Users(client); + +const result = await users.updateTarget( + '<USER_ID>', // userId + '<TARGET_ID>', // targetId + '<IDENTIFIER>', // identifier (optional) + '<PROVIDER_ID>', // providerId (optional) + '<NAME>' // name (optional) +); diff --git a/docs/examples/1.6.x/server-php/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-php/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..c43c60e4a6 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-anonymous-session.md @@ -0,0 +1,12 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->createAnonymousSession(); diff --git a/docs/examples/1.6.x/server-php/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-php/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..faefc338dc --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-email-password-session.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->createEmailPasswordSession( + email: 'email@example.com', + password: 'password' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-email-token.md b/docs/examples/1.6.x/server-php/examples/account/create-email-token.md new file mode 100644 index 0000000000..68dd7f4df8 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-email-token.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->createEmailToken( + userId: '<USER_ID>', + email: 'email@example.com', + phrase: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-php/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..33479c46ee --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-j-w-t.md @@ -0,0 +1,12 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->createJWT(); diff --git a/docs/examples/1.6.x/server-php/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-php/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..f75991c381 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->createMagicURLToken( + userId: '<USER_ID>', + email: 'email@example.com', + url: 'https://example.com', // optional + phrase: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-php/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..95fca4654c --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-mfa-authenticator.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; +use Appwrite\Enums\AuthenticatorType; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->createMfaAuthenticator( + type: AuthenticatorType::TOTP() +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-php/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..34bd0634eb --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-mfa-challenge.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; +use Appwrite\Enums\AuthenticationFactor; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->createMfaChallenge( + factor: AuthenticationFactor::EMAIL() +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..c47496728e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->createMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-php/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-php/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..0411d6fa10 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-o-auth2token.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; +use Appwrite\Enums\OAuthProvider; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->createOAuth2Token( + provider: OAuthProvider::AMAZON(), + success: 'https://example.com', // optional + failure: 'https://example.com', // optional + scopes: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-php/examples/account/create-phone-token.md new file mode 100644 index 0000000000..e5724d3716 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-phone-token.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->createPhoneToken( + userId: '<USER_ID>', + phone: '+12065550100' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-php/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..e681607730 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-phone-verification.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->createPhoneVerification(); diff --git a/docs/examples/1.6.x/server-php/examples/account/create-recovery.md b/docs/examples/1.6.x/server-php/examples/account/create-recovery.md new file mode 100644 index 0000000000..86cc2d9007 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-recovery.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->createRecovery( + email: 'email@example.com', + url: 'https://example.com' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-session.md b/docs/examples/1.6.x/server-php/examples/account/create-session.md new file mode 100644 index 0000000000..e714d11a7f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-session.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->createSession( + userId: '<USER_ID>', + secret: '<SECRET>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-verification.md b/docs/examples/1.6.x/server-php/examples/account/create-verification.md new file mode 100644 index 0000000000..9541956bd9 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create-verification.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->createVerification( + url: 'https://example.com' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create.md b/docs/examples/1.6.x/server-php/examples/account/create.md new file mode 100644 index 0000000000..b4bc9df78f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/create.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->create( + userId: '<USER_ID>', + email: 'email@example.com', + password: '', + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/delete-identity.md b/docs/examples/1.6.x/server-php/examples/account/delete-identity.md new file mode 100644 index 0000000000..dc7f751410 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/delete-identity.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->deleteIdentity( + identityId: '<IDENTITY_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-php/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..a0574c554f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; +use Appwrite\Enums\AuthenticatorType; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->deleteMfaAuthenticator( + type: AuthenticatorType::TOTP() +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/delete-session.md b/docs/examples/1.6.x/server-php/examples/account/delete-session.md new file mode 100644 index 0000000000..e52d95e57f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/delete-session.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->deleteSession( + sessionId: '<SESSION_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-php/examples/account/delete-sessions.md new file mode 100644 index 0000000000..a49331776e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/delete-sessions.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->deleteSessions(); diff --git a/docs/examples/1.6.x/server-php/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..f640e9ecae --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->getMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-php/examples/account/get-prefs.md b/docs/examples/1.6.x/server-php/examples/account/get-prefs.md new file mode 100644 index 0000000000..f6489fcfec --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/get-prefs.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->getPrefs(); diff --git a/docs/examples/1.6.x/server-php/examples/account/get-session.md b/docs/examples/1.6.x/server-php/examples/account/get-session.md new file mode 100644 index 0000000000..17bf7f7e0e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/get-session.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->getSession( + sessionId: '<SESSION_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/get.md b/docs/examples/1.6.x/server-php/examples/account/get.md new file mode 100644 index 0000000000..8a362749b6 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/get.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->get(); diff --git a/docs/examples/1.6.x/server-php/examples/account/list-identities.md b/docs/examples/1.6.x/server-php/examples/account/list-identities.md new file mode 100644 index 0000000000..78c6dd3659 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/list-identities.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->listIdentities( + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/list-logs.md b/docs/examples/1.6.x/server-php/examples/account/list-logs.md new file mode 100644 index 0000000000..0dcdb3b2d6 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/list-logs.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->listLogs( + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-php/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..e029574ae6 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/list-mfa-factors.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->listMfaFactors(); diff --git a/docs/examples/1.6.x/server-php/examples/account/list-sessions.md b/docs/examples/1.6.x/server-php/examples/account/list-sessions.md new file mode 100644 index 0000000000..28f2823a24 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/list-sessions.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->listSessions(); diff --git a/docs/examples/1.6.x/server-php/examples/account/update-email.md b/docs/examples/1.6.x/server-php/examples/account/update-email.md new file mode 100644 index 0000000000..60cb7cc4c9 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-email.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updateEmail( + email: 'email@example.com', + password: 'password' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-php/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..1869f7e0d6 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-m-f-a.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updateMFA( + mfa: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-php/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..d5e1a9f7a2 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->updateMagicURLSession( + userId: '<USER_ID>', + secret: '<SECRET>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-php/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..f998c23eed --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-mfa-authenticator.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; +use Appwrite\Enums\AuthenticatorType; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updateMfaAuthenticator( + type: AuthenticatorType::TOTP(), + otp: '<OTP>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-php/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..62124c5673 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-mfa-challenge.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updateMfaChallenge( + challengeId: '<CHALLENGE_ID>', + otp: '<OTP>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..7babcac9c5 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-php/examples/account/update-name.md b/docs/examples/1.6.x/server-php/examples/account/update-name.md new file mode 100644 index 0000000000..4e0f1cb20d --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-name.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updateName( + name: '<NAME>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-password.md b/docs/examples/1.6.x/server-php/examples/account/update-password.md new file mode 100644 index 0000000000..e438d2b290 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-password.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updatePassword( + password: '', + oldPassword: 'password' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-php/examples/account/update-phone-session.md new file mode 100644 index 0000000000..29518153b3 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-phone-session.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>'); // Your project ID + +$account = new Account($client); + +$result = $account->updatePhoneSession( + userId: '<USER_ID>', + secret: '<SECRET>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-php/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..6b95838dda --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-phone-verification.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updatePhoneVerification( + userId: '<USER_ID>', + secret: '<SECRET>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-phone.md b/docs/examples/1.6.x/server-php/examples/account/update-phone.md new file mode 100644 index 0000000000..85cff81cc4 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-phone.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updatePhone( + phone: '+12065550100', + password: 'password' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-prefs.md b/docs/examples/1.6.x/server-php/examples/account/update-prefs.md new file mode 100644 index 0000000000..c47859b9fe --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-prefs.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updatePrefs( + prefs: [] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-recovery.md b/docs/examples/1.6.x/server-php/examples/account/update-recovery.md new file mode 100644 index 0000000000..5400fb5a69 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-recovery.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updateRecovery( + userId: '<USER_ID>', + secret: '<SECRET>', + password: '' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-session.md b/docs/examples/1.6.x/server-php/examples/account/update-session.md new file mode 100644 index 0000000000..1a4611cb5f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-session.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updateSession( + sessionId: '<SESSION_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-status.md b/docs/examples/1.6.x/server-php/examples/account/update-status.md new file mode 100644 index 0000000000..8511b2f08c --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-status.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updateStatus(); diff --git a/docs/examples/1.6.x/server-php/examples/account/update-verification.md b/docs/examples/1.6.x/server-php/examples/account/update-verification.md new file mode 100644 index 0000000000..253693e9a3 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/account/update-verification.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Account; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$account = new Account($client); + +$result = $account->updateVerification( + userId: '<USER_ID>', + secret: '<SECRET>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-php/examples/avatars/get-browser.md new file mode 100644 index 0000000000..47a6c857ea --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/avatars/get-browser.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Avatars; +use Appwrite\Enums\Browser; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$avatars = new Avatars($client); + +$result = $avatars->getBrowser( + code: Browser::AVANTBROWSER(), + width: 0, // optional + height: 0, // optional + quality: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-php/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..c1b6b15f6d --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/avatars/get-credit-card.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Avatars; +use Appwrite\Enums\CreditCard; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$avatars = new Avatars($client); + +$result = $avatars->getCreditCard( + code: CreditCard::AMERICANEXPRESS(), + width: 0, // optional + height: 0, // optional + quality: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-php/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..50bb5c4ae6 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/avatars/get-favicon.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Avatars; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$avatars = new Avatars($client); + +$result = $avatars->getFavicon( + url: 'https://example.com' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-php/examples/avatars/get-flag.md new file mode 100644 index 0000000000..c163deaa69 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/avatars/get-flag.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Avatars; +use Appwrite\Enums\Flag; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$avatars = new Avatars($client); + +$result = $avatars->getFlag( + code: Flag::AFGHANISTAN(), + width: 0, // optional + height: 0, // optional + quality: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-image.md b/docs/examples/1.6.x/server-php/examples/avatars/get-image.md new file mode 100644 index 0000000000..31d2bbfceb --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/avatars/get-image.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Avatars; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$avatars = new Avatars($client); + +$result = $avatars->getImage( + url: 'https://example.com', + width: 0, // optional + height: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-php/examples/avatars/get-initials.md new file mode 100644 index 0000000000..6a94e056a0 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/avatars/get-initials.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Avatars; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$avatars = new Avatars($client); + +$result = $avatars->getInitials( + name: '<NAME>', // optional + width: 0, // optional + height: 0, // optional + background: '' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-php/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..48f0008e5f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/avatars/get-q-r.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Avatars; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$avatars = new Avatars($client); + +$result = $avatars->getQR( + text: '<TEXT>', + size: 1, // optional + margin: 0, // optional + download: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..27eba02779 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-boolean-attribute.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createBooleanAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + default: false, // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-collection.md b/docs/examples/1.6.x/server-php/examples/databases/create-collection.md new file mode 100644 index 0000000000..72d36d2f07 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-collection.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createCollection( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + name: '<NAME>', + permissions: ["read("any")"], // optional + documentSecurity: false, // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..a959381c49 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-datetime-attribute.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createDatetimeAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + default: '', // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-document.md b/docs/examples/1.6.x/server-php/examples/databases/create-document.md new file mode 100644 index 0000000000..612b114b0e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-document.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$databases = new Databases($client); + +$result = $databases->createDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>', + data: [], + permissions: ["read("any")"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..a72a42fa11 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-email-attribute.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createEmailAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + default: 'email@example.com', // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..2d6e3fb911 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-enum-attribute.md @@ -0,0 +1,21 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createEnumAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + elements: [], + required: false, + default: '<DEFAULT>', // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..83f42ead77 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-float-attribute.md @@ -0,0 +1,22 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createFloatAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + min: null, // optional + max: null, // optional + default: null, // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-index.md b/docs/examples/1.6.x/server-php/examples/databases/create-index.md new file mode 100644 index 0000000000..e79527160a --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-index.md @@ -0,0 +1,21 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; +use Appwrite\Enums\IndexType; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createIndex( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + type: IndexType::KEY(), + attributes: [], + orders: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..5abc89ceaf --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-integer-attribute.md @@ -0,0 +1,22 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createIntegerAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + min: null, // optional + max: null, // optional + default: null, // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..04c70f9025 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-ip-attribute.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createIpAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + default: '', // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..2e0ba6426d --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-relationship-attribute.md @@ -0,0 +1,23 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; +use Appwrite\Enums\RelationshipType; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createRelationshipAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + relatedCollectionId: '<RELATED_COLLECTION_ID>', + type: RelationshipType::ONETOONE(), + twoWay: false, // optional + key: '', // optional + twoWayKey: '', // optional + onDelete: RelationMutate::CASCADE() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..450c9bc7a6 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-string-attribute.md @@ -0,0 +1,22 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createStringAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + size: 1, + required: false, + default: '<DEFAULT>', // optional + array: false, // optional + encrypt: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..e7a40b768d --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create-url-attribute.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->createUrlAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + default: 'https://example.com', // optional + array: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create.md b/docs/examples/1.6.x/server-php/examples/databases/create.md new file mode 100644 index 0000000000..da4a650623 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/create.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->create( + databaseId: '<DATABASE_ID>', + name: '<NAME>', + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..e60d39fa47 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/delete-attribute.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->deleteAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-php/examples/databases/delete-collection.md new file mode 100644 index 0000000000..ce821e71bb --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/delete-collection.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->deleteCollection( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/delete-document.md b/docs/examples/1.6.x/server-php/examples/databases/delete-document.md new file mode 100644 index 0000000000..536cdcd9b9 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/delete-document.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$databases = new Databases($client); + +$result = $databases->deleteDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/delete-index.md b/docs/examples/1.6.x/server-php/examples/databases/delete-index.md new file mode 100644 index 0000000000..cb9ddf97e1 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/delete-index.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->deleteIndex( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/delete.md b/docs/examples/1.6.x/server-php/examples/databases/delete.md new file mode 100644 index 0000000000..5b1a3229b0 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/delete.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->delete( + databaseId: '<DATABASE_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/get-attribute.md new file mode 100644 index 0000000000..671f9ac757 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/get-attribute.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->getAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/get-collection.md b/docs/examples/1.6.x/server-php/examples/databases/get-collection.md new file mode 100644 index 0000000000..23df77b4ba --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/get-collection.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->getCollection( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/get-document.md b/docs/examples/1.6.x/server-php/examples/databases/get-document.md new file mode 100644 index 0000000000..bee705fd8e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/get-document.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$databases = new Databases($client); + +$result = $databases->getDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>', + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/get-index.md b/docs/examples/1.6.x/server-php/examples/databases/get-index.md new file mode 100644 index 0000000000..b5878dd8b3 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/get-index.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->getIndex( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/get.md b/docs/examples/1.6.x/server-php/examples/databases/get.md new file mode 100644 index 0000000000..4838b0b496 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/get.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->get( + databaseId: '<DATABASE_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-php/examples/databases/list-attributes.md new file mode 100644 index 0000000000..6b1834f804 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/list-attributes.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->listAttributes( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/list-collections.md b/docs/examples/1.6.x/server-php/examples/databases/list-collections.md new file mode 100644 index 0000000000..045aece5e2 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/list-collections.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->listCollections( + databaseId: '<DATABASE_ID>', + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/list-documents.md b/docs/examples/1.6.x/server-php/examples/databases/list-documents.md new file mode 100644 index 0000000000..c865f3294e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/list-documents.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$databases = new Databases($client); + +$result = $databases->listDocuments( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-php/examples/databases/list-indexes.md new file mode 100644 index 0000000000..fee8e8fd66 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/list-indexes.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->listIndexes( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/list.md b/docs/examples/1.6.x/server-php/examples/databases/list.md new file mode 100644 index 0000000000..ea89f25338 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/list.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->list( + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..a599d60fda --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-boolean-attribute.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->updateBooleanAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + default: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-collection.md b/docs/examples/1.6.x/server-php/examples/databases/update-collection.md new file mode 100644 index 0000000000..70b052d583 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-collection.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->updateCollection( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + name: '<NAME>', + permissions: ["read("any")"], // optional + documentSecurity: false, // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..f0e92cf6e1 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-datetime-attribute.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->updateDatetimeAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + default: '' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-document.md b/docs/examples/1.6.x/server-php/examples/databases/update-document.md new file mode 100644 index 0000000000..5af2f55ec9 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-document.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$databases = new Databases($client); + +$result = $databases->updateDocument( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + documentId: '<DOCUMENT_ID>', + data: [], // optional + permissions: ["read("any")"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..8398758f5e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-email-attribute.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->updateEmailAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + default: 'email@example.com' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..0bd7db5810 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-enum-attribute.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->updateEnumAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + elements: [], + required: false, + default: '<DEFAULT>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..32c3ba484f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-float-attribute.md @@ -0,0 +1,21 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->updateFloatAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + min: null, + max: null, + default: null +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..2233cc02b5 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-integer-attribute.md @@ -0,0 +1,21 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->updateIntegerAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + min: null, + max: null, + default: null +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..a953ae15c8 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-ip-attribute.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->updateIpAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + default: '' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..e4e16dfdac --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-relationship-attribute.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->updateRelationshipAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + onDelete: RelationMutate::CASCADE() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..b1a7ae4bb2 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-string-attribute.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->updateStringAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + default: '<DEFAULT>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..383d721b7f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update-url-attribute.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->updateUrlAttribute( + databaseId: '<DATABASE_ID>', + collectionId: '<COLLECTION_ID>', + key: '', + required: false, + default: 'https://example.com' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update.md b/docs/examples/1.6.x/server-php/examples/databases/update.md new file mode 100644 index 0000000000..68cb21435d --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/databases/update.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Databases; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$databases = new Databases($client); + +$result = $databases->update( + databaseId: '<DATABASE_ID>', + name: '<NAME>', + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/create-build.md b/docs/examples/1.6.x/server-php/examples/functions/create-build.md new file mode 100644 index 0000000000..43c781fa18 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/create-build.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->createBuild( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>', + buildId: '<BUILD_ID>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-php/examples/functions/create-deployment.md new file mode 100644 index 0000000000..c35b88631a --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/create-deployment.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\InputFile; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->createDeployment( + functionId: '<FUNCTION_ID>', + code: InputFile::withPath('file.png'), + activate: false, + entrypoint: '<ENTRYPOINT>', // optional + commands: '<COMMANDS>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/create-execution.md b/docs/examples/1.6.x/server-php/examples/functions/create-execution.md new file mode 100644 index 0000000000..ff531d5423 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/create-execution.md @@ -0,0 +1,21 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$functions = new Functions($client); + +$result = $functions->createExecution( + functionId: '<FUNCTION_ID>', + body: '<BODY>', // optional + async: false, // optional + path: '<PATH>', // optional + method: ExecutionMethod::GET(), // optional + headers: [], // optional + scheduledAt: '' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/create-variable.md b/docs/examples/1.6.x/server-php/examples/functions/create-variable.md new file mode 100644 index 0000000000..441aa9de89 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/create-variable.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->createVariable( + functionId: '<FUNCTION_ID>', + key: '<KEY>', + value: '<VALUE>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/create.md b/docs/examples/1.6.x/server-php/examples/functions/create.md new file mode 100644 index 0000000000..f6dc1830f3 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/create.md @@ -0,0 +1,36 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; +use Appwrite\Enums\; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->create( + functionId: '<FUNCTION_ID>', + name: '<NAME>', + runtime: ::NODE145(), + execute: ["any"], // optional + events: [], // optional + schedule: '', // optional + timeout: 1, // optional + enabled: false, // optional + logging: false, // optional + entrypoint: '<ENTRYPOINT>', // optional + commands: '<COMMANDS>', // optional + scopes: [], // optional + installationId: '<INSTALLATION_ID>', // optional + providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional + providerBranch: '<PROVIDER_BRANCH>', // optional + providerSilentMode: false, // optional + providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // optional + templateRepository: '<TEMPLATE_REPOSITORY>', // optional + templateOwner: '<TEMPLATE_OWNER>', // optional + templateRootDirectory: '<TEMPLATE_ROOT_DIRECTORY>', // optional + templateBranch: '<TEMPLATE_BRANCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-php/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..3f00e9d610 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/delete-deployment.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->deleteDeployment( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-php/examples/functions/delete-execution.md new file mode 100644 index 0000000000..3733583614 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/delete-execution.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->deleteExecution( + functionId: '<FUNCTION_ID>', + executionId: '<EXECUTION_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-php/examples/functions/delete-variable.md new file mode 100644 index 0000000000..5046e1f306 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/delete-variable.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->deleteVariable( + functionId: '<FUNCTION_ID>', + variableId: '<VARIABLE_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/delete.md b/docs/examples/1.6.x/server-php/examples/functions/delete.md new file mode 100644 index 0000000000..3d4da02a89 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/delete.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->delete( + functionId: '<FUNCTION_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-php/examples/functions/download-deployment.md new file mode 100644 index 0000000000..2841d86986 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/download-deployment.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->downloadDeployment( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-php/examples/functions/get-deployment.md new file mode 100644 index 0000000000..d5758dd10e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/get-deployment.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->getDeployment( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/get-execution.md b/docs/examples/1.6.x/server-php/examples/functions/get-execution.md new file mode 100644 index 0000000000..d0c7ec4168 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/get-execution.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$functions = new Functions($client); + +$result = $functions->getExecution( + functionId: '<FUNCTION_ID>', + executionId: '<EXECUTION_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/get-variable.md b/docs/examples/1.6.x/server-php/examples/functions/get-variable.md new file mode 100644 index 0000000000..2bd901bd00 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/get-variable.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->getVariable( + functionId: '<FUNCTION_ID>', + variableId: '<VARIABLE_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/get.md b/docs/examples/1.6.x/server-php/examples/functions/get.md new file mode 100644 index 0000000000..b2c6d7ba06 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/get.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->get( + functionId: '<FUNCTION_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-php/examples/functions/list-deployments.md new file mode 100644 index 0000000000..d8bad27022 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/list-deployments.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->listDeployments( + functionId: '<FUNCTION_ID>', + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/list-executions.md b/docs/examples/1.6.x/server-php/examples/functions/list-executions.md new file mode 100644 index 0000000000..fda330aa44 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/list-executions.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$functions = new Functions($client); + +$result = $functions->listExecutions( + functionId: '<FUNCTION_ID>', + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-php/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..18d3c053ce --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/list-runtimes.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->listRuntimes(); diff --git a/docs/examples/1.6.x/server-php/examples/functions/list-variables.md b/docs/examples/1.6.x/server-php/examples/functions/list-variables.md new file mode 100644 index 0000000000..137a4da032 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/list-variables.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->listVariables( + functionId: '<FUNCTION_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/list.md b/docs/examples/1.6.x/server-php/examples/functions/list.md new file mode 100644 index 0000000000..7b4d3623db --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/list.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->list( + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-php/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..653914ebb4 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/update-deployment-build.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->updateDeploymentBuild( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-php/examples/functions/update-deployment.md new file mode 100644 index 0000000000..095b253f17 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/update-deployment.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->updateDeployment( + functionId: '<FUNCTION_ID>', + deploymentId: '<DEPLOYMENT_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/update-variable.md b/docs/examples/1.6.x/server-php/examples/functions/update-variable.md new file mode 100644 index 0000000000..77a28f12dc --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/update-variable.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->updateVariable( + functionId: '<FUNCTION_ID>', + variableId: '<VARIABLE_ID>', + key: '<KEY>', + value: '<VALUE>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/update.md b/docs/examples/1.6.x/server-php/examples/functions/update.md new file mode 100644 index 0000000000..db0d50a4ba --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/functions/update.md @@ -0,0 +1,31 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Functions; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$functions = new Functions($client); + +$result = $functions->update( + functionId: '<FUNCTION_ID>', + name: '<NAME>', + runtime: ::NODE145(), // optional + execute: ["any"], // optional + events: [], // optional + schedule: '', // optional + timeout: 1, // optional + enabled: false, // optional + logging: false, // optional + entrypoint: '<ENTRYPOINT>', // optional + commands: '<COMMANDS>', // optional + scopes: [], // optional + installationId: '<INSTALLATION_ID>', // optional + providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional + providerBranch: '<PROVIDER_BRANCH>', // optional + providerSilentMode: false, // optional + providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/graphql/mutation.md b/docs/examples/1.6.x/server-php/examples/graphql/mutation.md new file mode 100644 index 0000000000..e074e0c2b3 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/graphql/mutation.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Graphql; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$graphql = new Graphql($client); + +$result = $graphql->mutation( + query: [] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/graphql/query.md b/docs/examples/1.6.x/server-php/examples/graphql/query.md new file mode 100644 index 0000000000..b871063631 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/graphql/query.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Graphql; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$graphql = new Graphql($client); + +$result = $graphql->query( + query: [] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-php/examples/health/get-antivirus.md new file mode 100644 index 0000000000..64e83e0975 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-antivirus.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getAntivirus(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-cache.md b/docs/examples/1.6.x/server-php/examples/health/get-cache.md new file mode 100644 index 0000000000..6096207d9c --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-cache.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getCache(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-certificate.md b/docs/examples/1.6.x/server-php/examples/health/get-certificate.md new file mode 100644 index 0000000000..d5d325e9d3 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-certificate.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getCertificate( + domain: '' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-d-b.md b/docs/examples/1.6.x/server-php/examples/health/get-d-b.md new file mode 100644 index 0000000000..434fcad66e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-d-b.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getDB(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-php/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..14705879cb --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-failed-jobs.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; +use Appwrite\Enums\; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getFailedJobs( + name: ::V1DATABASE(), + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-php/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..d2d3a5d665 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-pub-sub.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getPubSub(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..2911465d93 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-builds.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueBuilds( + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..9323b41da7 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-certificates.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueCertificates( + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..54a9814db9 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-databases.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueDatabases( + name: '<NAME>', // optional + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..aee4deb26c --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-deletes.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueDeletes( + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..f675b750f3 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-functions.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueFunctions( + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..05c463b2b7 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-logs.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueLogs( + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..74d4959cd7 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-mails.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueMails( + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..3fd96c66ea --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-messaging.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueMessaging( + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..9f1a8be1cc --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-migrations.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueMigrations( + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..b856b730e3 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-usage-dump.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueUsageDump( + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..9b5baeb86e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-usage.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueUsage( + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..e42b65b8fa --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue-webhooks.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueueWebhooks( + threshold: null // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue.md b/docs/examples/1.6.x/server-php/examples/health/get-queue.md new file mode 100644 index 0000000000..81b22184ec --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-queue.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getQueue(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-php/examples/health/get-storage-local.md new file mode 100644 index 0000000000..75999cebc6 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-storage-local.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getStorageLocal(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-storage.md b/docs/examples/1.6.x/server-php/examples/health/get-storage.md new file mode 100644 index 0000000000..a3b56b9765 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-storage.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getStorage(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-time.md b/docs/examples/1.6.x/server-php/examples/health/get-time.md new file mode 100644 index 0000000000..5deb2382c2 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get-time.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->getTime(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get.md b/docs/examples/1.6.x/server-php/examples/health/get.md new file mode 100644 index 0000000000..5001c4832e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/health/get.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Health; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$health = new Health($client); + +$result = $health->get(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/get.md b/docs/examples/1.6.x/server-php/examples/locale/get.md new file mode 100644 index 0000000000..b9f48b4c77 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/locale/get.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Locale; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$locale = new Locale($client); + +$result = $locale->get(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-codes.md b/docs/examples/1.6.x/server-php/examples/locale/list-codes.md new file mode 100644 index 0000000000..b35683c590 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/locale/list-codes.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Locale; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$locale = new Locale($client); + +$result = $locale->listCodes(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-continents.md b/docs/examples/1.6.x/server-php/examples/locale/list-continents.md new file mode 100644 index 0000000000..1076f9998a --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/locale/list-continents.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Locale; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$locale = new Locale($client); + +$result = $locale->listContinents(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-php/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..93a4cadafc --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/locale/list-countries-e-u.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Locale; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$locale = new Locale($client); + +$result = $locale->listCountriesEU(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-php/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..1d99f674d6 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/locale/list-countries-phones.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Locale; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$locale = new Locale($client); + +$result = $locale->listCountriesPhones(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-countries.md b/docs/examples/1.6.x/server-php/examples/locale/list-countries.md new file mode 100644 index 0000000000..665dd097c6 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/locale/list-countries.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Locale; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$locale = new Locale($client); + +$result = $locale->listCountries(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-php/examples/locale/list-currencies.md new file mode 100644 index 0000000000..5cd91dea81 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/locale/list-currencies.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Locale; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$locale = new Locale($client); + +$result = $locale->listCurrencies(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-languages.md b/docs/examples/1.6.x/server-php/examples/locale/list-languages.md new file mode 100644 index 0000000000..c615a3d1dc --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/locale/list-languages.md @@ -0,0 +1,13 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Locale; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$locale = new Locale($client); + +$result = $locale->listLanguages(); diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..ebe69e9516 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-apns-provider.md @@ -0,0 +1,22 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createApnsProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + authKey: '<AUTH_KEY>', // optional + authKeyId: '<AUTH_KEY_ID>', // optional + teamId: '<TEAM_ID>', // optional + bundleId: '<BUNDLE_ID>', // optional + sandbox: false, // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-email.md b/docs/examples/1.6.x/server-php/examples/messaging/create-email.md new file mode 100644 index 0000000000..b24e4f29fe --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-email.md @@ -0,0 +1,26 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createEmail( + messageId: '<MESSAGE_ID>', + subject: '<SUBJECT>', + content: '<CONTENT>', + topics: [], // optional + users: [], // optional + targets: [], // optional + cc: [], // optional + bcc: [], // optional + attachments: [], // optional + draft: false, // optional + html: false, // optional + scheduledAt: '' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..b0cfec494f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-fcm-provider.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createFcmProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + serviceAccountJSON: [], // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..bd3bcf8576 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,24 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createMailgunProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + apiKey: '<API_KEY>', // optional + domain: '<DOMAIN>', // optional + isEuRegion: false, // optional + fromName: '<FROM_NAME>', // optional + fromEmail: 'email@example.com', // optional + replyToName: '<REPLY_TO_NAME>', // optional + replyToEmail: 'email@example.com', // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..da377168fa --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-msg91provider.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createMsg91Provider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + templateId: '<TEMPLATE_ID>', // optional + senderId: '<SENDER_ID>', // optional + authKey: '<AUTH_KEY>', // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-push.md b/docs/examples/1.6.x/server-php/examples/messaging/create-push.md new file mode 100644 index 0000000000..7273f0300b --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-push.md @@ -0,0 +1,30 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createPush( + messageId: '<MESSAGE_ID>', + title: '<TITLE>', + body: '<BODY>', + topics: [], // optional + users: [], // optional + targets: [], // optional + data: [], // optional + action: '<ACTION>', // optional + image: '[ID1:ID2]', // optional + icon: '<ICON>', // optional + sound: '<SOUND>', // optional + color: '<COLOR>', // optional + tag: '<TAG>', // optional + badge: '<BADGE>', // optional + draft: false, // optional + scheduledAt: '' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..42764a913e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,22 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createSendgridProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + apiKey: '<API_KEY>', // optional + fromName: '<FROM_NAME>', // optional + fromEmail: 'email@example.com', // optional + replyToName: '<REPLY_TO_NAME>', // optional + replyToEmail: 'email@example.com', // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-php/examples/messaging/create-sms.md new file mode 100644 index 0000000000..36fce84b10 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-sms.md @@ -0,0 +1,21 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createSms( + messageId: '<MESSAGE_ID>', + content: '<CONTENT>', + topics: [], // optional + users: [], // optional + targets: [], // optional + draft: false, // optional + scheduledAt: '' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..ff8cfe0a68 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-smtp-provider.md @@ -0,0 +1,28 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createSmtpProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + host: '<HOST>', + port: 1, // optional + username: '<USERNAME>', // optional + password: '<PASSWORD>', // optional + encryption: SmtpEncryption::NONE(), // optional + autoTLS: false, // optional + mailer: '<MAILER>', // optional + fromName: '<FROM_NAME>', // optional + fromEmail: 'email@example.com', // optional + replyToName: '<REPLY_TO_NAME>', // optional + replyToEmail: 'email@example.com', // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-php/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..bfba263472 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-subscriber.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setJWT('<YOUR_JWT>'); // Your secret JSON Web Token + +$messaging = new Messaging($client); + +$result = $messaging->createSubscriber( + topicId: '<TOPIC_ID>', + subscriberId: '<SUBSCRIBER_ID>', + targetId: '<TARGET_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..ec3ede7b15 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-telesign-provider.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createTelesignProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', // optional + customerId: '<CUSTOMER_ID>', // optional + apiKey: '<API_KEY>', // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..5dc00f8acc --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createTextmagicProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', // optional + username: '<USERNAME>', // optional + apiKey: '<API_KEY>', // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-php/examples/messaging/create-topic.md new file mode 100644 index 0000000000..dd0daf12c6 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-topic.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createTopic( + topicId: '<TOPIC_ID>', + name: '<NAME>', + subscribe: ["any"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..70a1d38ae5 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-twilio-provider.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createTwilioProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', // optional + accountSid: '<ACCOUNT_SID>', // optional + authToken: '<AUTH_TOKEN>', // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..d6a4e11e90 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/create-vonage-provider.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->createVonageProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', // optional + apiKey: '<API_KEY>', // optional + apiSecret: '<API_SECRET>', // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..4f267fefcb --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/delete-provider.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->deleteProvider( + providerId: '<PROVIDER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-php/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..2f91487c2d --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/delete-subscriber.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setJWT('<YOUR_JWT>'); // Your secret JSON Web Token + +$messaging = new Messaging($client); + +$result = $messaging->deleteSubscriber( + topicId: '<TOPIC_ID>', + subscriberId: '<SUBSCRIBER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-php/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..79dca2c6ed --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/delete-topic.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->deleteTopic( + topicId: '<TOPIC_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/delete.md b/docs/examples/1.6.x/server-php/examples/messaging/delete.md new file mode 100644 index 0000000000..b0676ec269 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/delete.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->delete( + messageId: '<MESSAGE_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/get-message.md b/docs/examples/1.6.x/server-php/examples/messaging/get-message.md new file mode 100644 index 0000000000..9ec7a0ed83 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/get-message.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->getMessage( + messageId: '<MESSAGE_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/get-provider.md new file mode 100644 index 0000000000..378fc6db6e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/get-provider.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->getProvider( + providerId: '<PROVIDER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-php/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..a10974a6d1 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/get-subscriber.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->getSubscriber( + topicId: '<TOPIC_ID>', + subscriberId: '<SUBSCRIBER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-php/examples/messaging/get-topic.md new file mode 100644 index 0000000000..cb42254f04 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/get-topic.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->getTopic( + topicId: '<TOPIC_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-php/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..d66d5466fb --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/list-message-logs.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->listMessageLogs( + messageId: '<MESSAGE_ID>', + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-php/examples/messaging/list-messages.md new file mode 100644 index 0000000000..c0f54a635e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/list-messages.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->listMessages( + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-php/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..865daf9eb1 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/list-provider-logs.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->listProviderLogs( + providerId: '<PROVIDER_ID>', + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-php/examples/messaging/list-providers.md new file mode 100644 index 0000000000..fd30837406 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/list-providers.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->listProviders( + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-php/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..b69c057491 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->listSubscriberLogs( + subscriberId: '<SUBSCRIBER_ID>', + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-php/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..2fd274704c --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/list-subscribers.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->listSubscribers( + topicId: '<TOPIC_ID>', + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-php/examples/messaging/list-targets.md new file mode 100644 index 0000000000..3abb9ef70a --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/list-targets.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->listTargets( + messageId: '<MESSAGE_ID>', + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-php/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..0d23c828ae --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/list-topic-logs.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->listTopicLogs( + topicId: '<TOPIC_ID>', + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-php/examples/messaging/list-topics.md new file mode 100644 index 0000000000..008767e5b1 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/list-topics.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->listTopics( + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..a368ce5312 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-apns-provider.md @@ -0,0 +1,22 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateApnsProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + enabled: false, // optional + authKey: '<AUTH_KEY>', // optional + authKeyId: '<AUTH_KEY_ID>', // optional + teamId: '<TEAM_ID>', // optional + bundleId: '<BUNDLE_ID>', // optional + sandbox: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-email.md b/docs/examples/1.6.x/server-php/examples/messaging/update-email.md new file mode 100644 index 0000000000..537ca82e42 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-email.md @@ -0,0 +1,26 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateEmail( + messageId: '<MESSAGE_ID>', + topics: [], // optional + users: [], // optional + targets: [], // optional + subject: '<SUBJECT>', // optional + content: '<CONTENT>', // optional + draft: false, // optional + html: false, // optional + cc: [], // optional + bcc: [], // optional + scheduledAt: '', // optional + attachments: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..d8b2a0e487 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-fcm-provider.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateFcmProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + enabled: false, // optional + serviceAccountJSON: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..d838adb7c8 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,24 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateMailgunProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + apiKey: '<API_KEY>', // optional + domain: '<DOMAIN>', // optional + isEuRegion: false, // optional + enabled: false, // optional + fromName: '<FROM_NAME>', // optional + fromEmail: 'email@example.com', // optional + replyToName: '<REPLY_TO_NAME>', // optional + replyToEmail: '<REPLY_TO_EMAIL>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..eb681023ca --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-msg91provider.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateMsg91Provider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + enabled: false, // optional + templateId: '<TEMPLATE_ID>', // optional + senderId: '<SENDER_ID>', // optional + authKey: '<AUTH_KEY>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-push.md b/docs/examples/1.6.x/server-php/examples/messaging/update-push.md new file mode 100644 index 0000000000..b332ec194f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-push.md @@ -0,0 +1,30 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updatePush( + messageId: '<MESSAGE_ID>', + topics: [], // optional + users: [], // optional + targets: [], // optional + title: '<TITLE>', // optional + body: '<BODY>', // optional + data: [], // optional + action: '<ACTION>', // optional + image: '[ID1:ID2]', // optional + icon: '<ICON>', // optional + sound: '<SOUND>', // optional + color: '<COLOR>', // optional + tag: '<TAG>', // optional + badge: null, // optional + draft: false, // optional + scheduledAt: '' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..7909fef6ac --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,22 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateSendgridProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + enabled: false, // optional + apiKey: '<API_KEY>', // optional + fromName: '<FROM_NAME>', // optional + fromEmail: 'email@example.com', // optional + replyToName: '<REPLY_TO_NAME>', // optional + replyToEmail: '<REPLY_TO_EMAIL>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-php/examples/messaging/update-sms.md new file mode 100644 index 0000000000..a4b4c23f2b --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-sms.md @@ -0,0 +1,21 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateSms( + messageId: '<MESSAGE_ID>', + topics: [], // optional + users: [], // optional + targets: [], // optional + content: '<CONTENT>', // optional + draft: false, // optional + scheduledAt: '' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..997914f06e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-smtp-provider.md @@ -0,0 +1,28 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateSmtpProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + host: '<HOST>', // optional + port: 1, // optional + username: '<USERNAME>', // optional + password: '<PASSWORD>', // optional + encryption: SmtpEncryption::NONE(), // optional + autoTLS: false, // optional + mailer: '<MAILER>', // optional + fromName: '<FROM_NAME>', // optional + fromEmail: 'email@example.com', // optional + replyToName: '<REPLY_TO_NAME>', // optional + replyToEmail: '<REPLY_TO_EMAIL>', // optional + enabled: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..981df0cedd --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-telesign-provider.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateTelesignProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + enabled: false, // optional + customerId: '<CUSTOMER_ID>', // optional + apiKey: '<API_KEY>', // optional + from: '<FROM>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..b7f9bab582 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateTextmagicProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + enabled: false, // optional + username: '<USERNAME>', // optional + apiKey: '<API_KEY>', // optional + from: '<FROM>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-php/examples/messaging/update-topic.md new file mode 100644 index 0000000000..e705c1b727 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-topic.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateTopic( + topicId: '<TOPIC_ID>', + name: '<NAME>', // optional + subscribe: ["any"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..05c2072a43 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-twilio-provider.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateTwilioProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + enabled: false, // optional + accountSid: '<ACCOUNT_SID>', // optional + authToken: '<AUTH_TOKEN>', // optional + from: '<FROM>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..3c421af9d0 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/messaging/update-vonage-provider.md @@ -0,0 +1,20 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Messaging; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$messaging = new Messaging($client); + +$result = $messaging->updateVonageProvider( + providerId: '<PROVIDER_ID>', + name: '<NAME>', // optional + enabled: false, // optional + apiKey: '<API_KEY>', // optional + apiSecret: '<API_SECRET>', // optional + from: '<FROM>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-php/examples/storage/create-bucket.md new file mode 100644 index 0000000000..ca369fbdc5 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/create-bucket.md @@ -0,0 +1,24 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$storage = new Storage($client); + +$result = $storage->createBucket( + bucketId: '<BUCKET_ID>', + name: '<NAME>', + permissions: ["read("any")"], // optional + fileSecurity: false, // optional + enabled: false, // optional + maximumFileSize: 1, // optional + allowedFileExtensions: [], // optional + compression: ::NONE(), // optional + encryption: false, // optional + antivirus: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/create-file.md b/docs/examples/1.6.x/server-php/examples/storage/create-file.md new file mode 100644 index 0000000000..20a25e7641 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/create-file.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\InputFile; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$storage = new Storage($client); + +$result = $storage->createFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', + file: InputFile::withPath('file.png'), + permissions: ["read("any")"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-php/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..a9207f4e4c --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/delete-bucket.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$storage = new Storage($client); + +$result = $storage->deleteBucket( + bucketId: '<BUCKET_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/delete-file.md b/docs/examples/1.6.x/server-php/examples/storage/delete-file.md new file mode 100644 index 0000000000..47f9938b66 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/delete-file.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$storage = new Storage($client); + +$result = $storage->deleteFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-php/examples/storage/get-bucket.md new file mode 100644 index 0000000000..5faf6a6c74 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/get-bucket.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$storage = new Storage($client); + +$result = $storage->getBucket( + bucketId: '<BUCKET_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-php/examples/storage/get-file-download.md new file mode 100644 index 0000000000..48ee5ada02 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/get-file-download.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$storage = new Storage($client); + +$result = $storage->getFileDownload( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-php/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..4f37f386a8 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/get-file-preview.md @@ -0,0 +1,27 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$storage = new Storage($client); + +$result = $storage->getFilePreview( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', + width: 0, // optional + height: 0, // optional + gravity: ImageGravity::CENTER(), // optional + quality: 0, // optional + borderWidth: 0, // optional + borderColor: '', // optional + borderRadius: 0, // optional + opacity: 0, // optional + rotation: -360, // optional + background: '', // optional + output: ImageFormat::JPG() // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-php/examples/storage/get-file-view.md new file mode 100644 index 0000000000..5637fa88bd --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/get-file-view.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$storage = new Storage($client); + +$result = $storage->getFileView( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/get-file.md b/docs/examples/1.6.x/server-php/examples/storage/get-file.md new file mode 100644 index 0000000000..41fdc91c55 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/get-file.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$storage = new Storage($client); + +$result = $storage->getFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-php/examples/storage/list-buckets.md new file mode 100644 index 0000000000..7a988c2b4f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/list-buckets.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$storage = new Storage($client); + +$result = $storage->listBuckets( + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/list-files.md b/docs/examples/1.6.x/server-php/examples/storage/list-files.md new file mode 100644 index 0000000000..038b2cd556 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/list-files.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$storage = new Storage($client); + +$result = $storage->listFiles( + bucketId: '<BUCKET_ID>', + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-php/examples/storage/update-bucket.md new file mode 100644 index 0000000000..96bf127bdf --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/update-bucket.md @@ -0,0 +1,24 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$storage = new Storage($client); + +$result = $storage->updateBucket( + bucketId: '<BUCKET_ID>', + name: '<NAME>', + permissions: ["read("any")"], // optional + fileSecurity: false, // optional + enabled: false, // optional + maximumFileSize: 1, // optional + allowedFileExtensions: [], // optional + compression: ::NONE(), // optional + encryption: false, // optional + antivirus: false // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/update-file.md b/docs/examples/1.6.x/server-php/examples/storage/update-file.md new file mode 100644 index 0000000000..0ddc6d5546 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/storage/update-file.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Storage; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$storage = new Storage($client); + +$result = $storage->updateFile( + bucketId: '<BUCKET_ID>', + fileId: '<FILE_ID>', + name: '<NAME>', // optional + permissions: ["read("any")"] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/create-membership.md b/docs/examples/1.6.x/server-php/examples/teams/create-membership.md new file mode 100644 index 0000000000..061b906bc8 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/create-membership.md @@ -0,0 +1,21 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->createMembership( + teamId: '<TEAM_ID>', + roles: [], + email: 'email@example.com', // optional + userId: '<USER_ID>', // optional + phone: '+12065550100', // optional + url: 'https://example.com', // optional + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/create.md b/docs/examples/1.6.x/server-php/examples/teams/create.md new file mode 100644 index 0000000000..5475bdf384 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/create.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->create( + teamId: '<TEAM_ID>', + name: '<NAME>', + roles: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-php/examples/teams/delete-membership.md new file mode 100644 index 0000000000..15ced8944e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/delete-membership.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->deleteMembership( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/delete.md b/docs/examples/1.6.x/server-php/examples/teams/delete.md new file mode 100644 index 0000000000..98224f7a5f --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/delete.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->delete( + teamId: '<TEAM_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/get-membership.md b/docs/examples/1.6.x/server-php/examples/teams/get-membership.md new file mode 100644 index 0000000000..f27ee3af5a --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/get-membership.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->getMembership( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-php/examples/teams/get-prefs.md new file mode 100644 index 0000000000..932777a563 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/get-prefs.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->getPrefs( + teamId: '<TEAM_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/get.md b/docs/examples/1.6.x/server-php/examples/teams/get.md new file mode 100644 index 0000000000..21320eeb8d --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/get.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->get( + teamId: '<TEAM_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-php/examples/teams/list-memberships.md new file mode 100644 index 0000000000..440553c2e0 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/list-memberships.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->listMemberships( + teamId: '<TEAM_ID>', + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/list.md b/docs/examples/1.6.x/server-php/examples/teams/list.md new file mode 100644 index 0000000000..761b6c216c --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/list.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->list( + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-php/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..3c7924581a --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/update-membership-status.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->updateMembershipStatus( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>', + userId: '<USER_ID>', + secret: '<SECRET>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/update-membership.md b/docs/examples/1.6.x/server-php/examples/teams/update-membership.md new file mode 100644 index 0000000000..438f3540b8 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/update-membership.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->updateMembership( + teamId: '<TEAM_ID>', + membershipId: '<MEMBERSHIP_ID>', + roles: [] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/update-name.md b/docs/examples/1.6.x/server-php/examples/teams/update-name.md new file mode 100644 index 0000000000..cd1f38fd7d --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/update-name.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->updateName( + teamId: '<TEAM_ID>', + name: '<NAME>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-php/examples/teams/update-prefs.md new file mode 100644 index 0000000000..0dadd2c39e --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/teams/update-prefs.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Teams; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setSession(''); // The user session to authenticate with + +$teams = new Teams($client); + +$result = $teams->updatePrefs( + teamId: '<TEAM_ID>', + prefs: [] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-php/examples/users/create-argon2user.md new file mode 100644 index 0000000000..7bee3bc6cb --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-argon2user.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createArgon2User( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-php/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..631e4ccdd3 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-bcrypt-user.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createBcryptUser( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-php/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..2f0bc3775b --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-j-w-t.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createJWT( + userId: '<USER_ID>', + sessionId: '<SESSION_ID>', // optional + duration: 0 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-php/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..0605f6f927 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-m-d5user.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createMD5User( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..f499b22d36 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createMfaRecoveryCodes( + userId: '<USER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-php/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..f6dc863452 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-p-h-pass-user.md @@ -0,0 +1,18 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createPHPassUser( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-php/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..777096d822 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-s-h-a-user.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createSHAUser( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + passwordVersion: PasswordHash::SHA1(), // optional + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-php/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..4f8423ff76 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,21 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createScryptModifiedUser( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + passwordSalt: '<PASSWORD_SALT>', + passwordSaltSeparator: '<PASSWORD_SALT_SEPARATOR>', + passwordSignerKey: '<PASSWORD_SIGNER_KEY>', + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-php/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..2ccc5d7329 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-scrypt-user.md @@ -0,0 +1,23 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createScryptUser( + userId: '<USER_ID>', + email: 'email@example.com', + password: 'password', + passwordSalt: '<PASSWORD_SALT>', + passwordCpu: null, + passwordMemory: null, + passwordParallel: null, + passwordLength: null, + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-session.md b/docs/examples/1.6.x/server-php/examples/users/create-session.md new file mode 100644 index 0000000000..97d8c8aa89 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-session.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createSession( + userId: '<USER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-target.md b/docs/examples/1.6.x/server-php/examples/users/create-target.md new file mode 100644 index 0000000000..03104bc83a --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-target.md @@ -0,0 +1,21 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; +use Appwrite\Enums\MessagingProviderType; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createTarget( + userId: '<USER_ID>', + targetId: '<TARGET_ID>', + providerType: MessagingProviderType::EMAIL(), + identifier: '<IDENTIFIER>', + providerId: '<PROVIDER_ID>', // optional + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-token.md b/docs/examples/1.6.x/server-php/examples/users/create-token.md new file mode 100644 index 0000000000..b08faacd14 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create-token.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->createToken( + userId: '<USER_ID>', + length: 4, // optional + expire: 60 // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create.md b/docs/examples/1.6.x/server-php/examples/users/create.md new file mode 100644 index 0000000000..a50e10e6c9 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/create.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->create( + userId: '<USER_ID>', + email: 'email@example.com', // optional + phone: '+12065550100', // optional + password: '', // optional + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete-identity.md b/docs/examples/1.6.x/server-php/examples/users/delete-identity.md new file mode 100644 index 0000000000..138b89f97d --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/delete-identity.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->deleteIdentity( + identityId: '<IDENTITY_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-php/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..d25c2b72b9 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,17 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; +use Appwrite\Enums\AuthenticatorType; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->deleteMfaAuthenticator( + userId: '<USER_ID>', + type: AuthenticatorType::TOTP() +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete-session.md b/docs/examples/1.6.x/server-php/examples/users/delete-session.md new file mode 100644 index 0000000000..bf673b22ca --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/delete-session.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->deleteSession( + userId: '<USER_ID>', + sessionId: '<SESSION_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-php/examples/users/delete-sessions.md new file mode 100644 index 0000000000..f2a3f21d43 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/delete-sessions.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->deleteSessions( + userId: '<USER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete-target.md b/docs/examples/1.6.x/server-php/examples/users/delete-target.md new file mode 100644 index 0000000000..20e676a983 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/delete-target.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->deleteTarget( + userId: '<USER_ID>', + targetId: '<TARGET_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete.md b/docs/examples/1.6.x/server-php/examples/users/delete.md new file mode 100644 index 0000000000..225708c2b2 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/delete.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->delete( + userId: '<USER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..055ef04564 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->getMfaRecoveryCodes( + userId: '<USER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/get-prefs.md b/docs/examples/1.6.x/server-php/examples/users/get-prefs.md new file mode 100644 index 0000000000..392dc14937 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/get-prefs.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->getPrefs( + userId: '<USER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/get-target.md b/docs/examples/1.6.x/server-php/examples/users/get-target.md new file mode 100644 index 0000000000..7ca05d3547 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/get-target.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->getTarget( + userId: '<USER_ID>', + targetId: '<TARGET_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/get.md b/docs/examples/1.6.x/server-php/examples/users/get.md new file mode 100644 index 0000000000..1cc351adf3 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/get.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->get( + userId: '<USER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-identities.md b/docs/examples/1.6.x/server-php/examples/users/list-identities.md new file mode 100644 index 0000000000..040e309b18 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/list-identities.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->listIdentities( + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-logs.md b/docs/examples/1.6.x/server-php/examples/users/list-logs.md new file mode 100644 index 0000000000..e717bdf9cd --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/list-logs.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->listLogs( + userId: '<USER_ID>', + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-memberships.md b/docs/examples/1.6.x/server-php/examples/users/list-memberships.md new file mode 100644 index 0000000000..da760e0736 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/list-memberships.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->listMemberships( + userId: '<USER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-php/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..16964c5c0c --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/list-mfa-factors.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->listMfaFactors( + userId: '<USER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-sessions.md b/docs/examples/1.6.x/server-php/examples/users/list-sessions.md new file mode 100644 index 0000000000..0bfa2420fc --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/list-sessions.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->listSessions( + userId: '<USER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-targets.md b/docs/examples/1.6.x/server-php/examples/users/list-targets.md new file mode 100644 index 0000000000..c4815be792 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/list-targets.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->listTargets( + userId: '<USER_ID>', + queries: [] // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list.md b/docs/examples/1.6.x/server-php/examples/users/list.md new file mode 100644 index 0000000000..678e97fc6b --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/list.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->list( + queries: [], // optional + search: '<SEARCH>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-php/examples/users/update-email-verification.md new file mode 100644 index 0000000000..d2d6584f84 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-email-verification.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updateEmailVerification( + userId: '<USER_ID>', + emailVerification: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-email.md b/docs/examples/1.6.x/server-php/examples/users/update-email.md new file mode 100644 index 0000000000..a73100c18d --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-email.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updateEmail( + userId: '<USER_ID>', + email: 'email@example.com' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-labels.md b/docs/examples/1.6.x/server-php/examples/users/update-labels.md new file mode 100644 index 0000000000..965183060b --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-labels.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updateLabels( + userId: '<USER_ID>', + labels: [] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..d09ccd7dde --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,15 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updateMfaRecoveryCodes( + userId: '<USER_ID>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-mfa.md b/docs/examples/1.6.x/server-php/examples/users/update-mfa.md new file mode 100644 index 0000000000..5ab48c5308 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-mfa.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updateMfa( + userId: '<USER_ID>', + mfa: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-name.md b/docs/examples/1.6.x/server-php/examples/users/update-name.md new file mode 100644 index 0000000000..96e8afcecb --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-name.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updateName( + userId: '<USER_ID>', + name: '<NAME>' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-password.md b/docs/examples/1.6.x/server-php/examples/users/update-password.md new file mode 100644 index 0000000000..ffcb81725d --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-password.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updatePassword( + userId: '<USER_ID>', + password: '' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-php/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..80545314a1 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-phone-verification.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updatePhoneVerification( + userId: '<USER_ID>', + phoneVerification: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-phone.md b/docs/examples/1.6.x/server-php/examples/users/update-phone.md new file mode 100644 index 0000000000..5828633919 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-phone.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updatePhone( + userId: '<USER_ID>', + number: '+12065550100' +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-prefs.md b/docs/examples/1.6.x/server-php/examples/users/update-prefs.md new file mode 100644 index 0000000000..6d0ecade88 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-prefs.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updatePrefs( + userId: '<USER_ID>', + prefs: [] +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-status.md b/docs/examples/1.6.x/server-php/examples/users/update-status.md new file mode 100644 index 0000000000..7ffbfc2be8 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-status.md @@ -0,0 +1,16 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updateStatus( + userId: '<USER_ID>', + status: false +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-target.md b/docs/examples/1.6.x/server-php/examples/users/update-target.md new file mode 100644 index 0000000000..5c476db0e3 --- /dev/null +++ b/docs/examples/1.6.x/server-php/examples/users/update-target.md @@ -0,0 +1,19 @@ +<?php + +use Appwrite\Client; +use Appwrite\Services\Users; + +$client = (new Client()) + ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + ->setProject('<YOUR_PROJECT_ID>') // Your project ID + ->setKey('<YOUR_API_KEY>'); // Your secret API key + +$users = new Users($client); + +$result = $users->updateTarget( + userId: '<USER_ID>', + targetId: '<TARGET_ID>', + identifier: '<IDENTIFIER>', // optional + providerId: '<PROVIDER_ID>', // optional + name: '<NAME>' // optional +); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-python/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-python/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..a8d0cd5f40 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-anonymous-session.md @@ -0,0 +1,9 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.create_anonymous_session() diff --git a/docs/examples/1.6.x/server-python/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-python/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..1e9233c65f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-email-password-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.create_email_password_session( + email = 'email@example.com', + password = 'password' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-email-token.md b/docs/examples/1.6.x/server-python/examples/account/create-email-token.md new file mode 100644 index 0000000000..6700b12e17 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-email-token.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.create_email_token( + user_id = '<USER_ID>', + email = 'email@example.com', + phrase = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-python/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..182c49d2a4 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-j-w-t.md @@ -0,0 +1,9 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.create_jwt() diff --git a/docs/examples/1.6.x/server-python/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-python/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..8380de3df0 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.create_magic_url_token( + user_id = '<USER_ID>', + email = 'email@example.com', + url = 'https://example.com', # optional + phrase = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-python/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..14b16de009 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-mfa-authenticator.md @@ -0,0 +1,13 @@ +from appwrite.client import Client +from appwrite.enums import AuthenticatorType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.create_mfa_authenticator( + type = AuthenticatorType.TOTP +) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-python/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..1edb1edccf --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-mfa-challenge.md @@ -0,0 +1,12 @@ +from appwrite.client import Client +from appwrite.enums import AuthenticationFactor + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.create_mfa_challenge( + factor = AuthenticationFactor.EMAIL +) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..f6bf7eda1f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.create_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-python/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-python/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..84438a39c6 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-o-auth2token.md @@ -0,0 +1,15 @@ +from appwrite.client import Client +from appwrite.enums import OAuthProvider + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.create_o_auth2_token( + provider = OAuthProvider.AMAZON, + success = 'https://example.com', # optional + failure = 'https://example.com', # optional + scopes = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-python/examples/account/create-phone-token.md new file mode 100644 index 0000000000..8542457a8b --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-phone-token.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.create_phone_token( + user_id = '<USER_ID>', + phone = '+12065550100' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-python/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..dd28e346aa --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-phone-verification.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.create_phone_verification() diff --git a/docs/examples/1.6.x/server-python/examples/account/create-recovery.md b/docs/examples/1.6.x/server-python/examples/account/create-recovery.md new file mode 100644 index 0000000000..e2822a44e0 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-recovery.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.create_recovery( + email = 'email@example.com', + url = 'https://example.com' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-session.md b/docs/examples/1.6.x/server-python/examples/account/create-session.md new file mode 100644 index 0000000000..d4e31c13c6 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.create_session( + user_id = '<USER_ID>', + secret = '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-verification.md b/docs/examples/1.6.x/server-python/examples/account/create-verification.md new file mode 100644 index 0000000000..a671d9deeb --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create-verification.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.create_verification( + url = 'https://example.com' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/create.md b/docs/examples/1.6.x/server-python/examples/account/create.md new file mode 100644 index 0000000000..226c5c757b --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/create.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.create( + user_id = '<USER_ID>', + email = 'email@example.com', + password = '', + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/account/delete-identity.md b/docs/examples/1.6.x/server-python/examples/account/delete-identity.md new file mode 100644 index 0000000000..7029c3543d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/delete-identity.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.delete_identity( + identity_id = '<IDENTITY_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-python/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..138e36df99 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,13 @@ +from appwrite.client import Client +from appwrite.enums import AuthenticatorType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.delete_mfa_authenticator( + type = AuthenticatorType.TOTP +) diff --git a/docs/examples/1.6.x/server-python/examples/account/delete-session.md b/docs/examples/1.6.x/server-python/examples/account/delete-session.md new file mode 100644 index 0000000000..091eca84d5 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/delete-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.delete_session( + session_id = '<SESSION_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-python/examples/account/delete-sessions.md new file mode 100644 index 0000000000..7c64d6666e --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/delete-sessions.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.delete_sessions() diff --git a/docs/examples/1.6.x/server-python/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..39137c7874 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.get_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-python/examples/account/get-prefs.md b/docs/examples/1.6.x/server-python/examples/account/get-prefs.md new file mode 100644 index 0000000000..67db03a8f6 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/get-prefs.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.get_prefs() diff --git a/docs/examples/1.6.x/server-python/examples/account/get-session.md b/docs/examples/1.6.x/server-python/examples/account/get-session.md new file mode 100644 index 0000000000..926279941d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/get-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.get_session( + session_id = '<SESSION_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/get.md b/docs/examples/1.6.x/server-python/examples/account/get.md new file mode 100644 index 0000000000..1b4c8febca --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/get.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.get() diff --git a/docs/examples/1.6.x/server-python/examples/account/list-identities.md b/docs/examples/1.6.x/server-python/examples/account/list-identities.md new file mode 100644 index 0000000000..ed163b38cf --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/list-identities.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.list_identities( + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/account/list-logs.md b/docs/examples/1.6.x/server-python/examples/account/list-logs.md new file mode 100644 index 0000000000..ca2fcfadce --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/list-logs.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.list_logs( + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-python/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..1d09d979eb --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/list-mfa-factors.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.list_mfa_factors() diff --git a/docs/examples/1.6.x/server-python/examples/account/list-sessions.md b/docs/examples/1.6.x/server-python/examples/account/list-sessions.md new file mode 100644 index 0000000000..936b11b27d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/list-sessions.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.list_sessions() diff --git a/docs/examples/1.6.x/server-python/examples/account/update-email.md b/docs/examples/1.6.x/server-python/examples/account/update-email.md new file mode 100644 index 0000000000..5cec58c15a --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-email.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_email( + email = 'email@example.com', + password = 'password' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-python/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..821a549cd1 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-m-f-a.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_mfa( + mfa = False +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-python/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..0cd8fc626a --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.update_magic_url_session( + user_id = '<USER_ID>', + secret = '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-python/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..e980538053 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-mfa-authenticator.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.enums import AuthenticatorType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_mfa_authenticator( + type = AuthenticatorType.TOTP, + otp = '<OTP>' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-python/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..3bce7f3604 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-mfa-challenge.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_mfa_challenge( + challenge_id = '<CHALLENGE_ID>', + otp = '<OTP>' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..fd9863367c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-python/examples/account/update-name.md b/docs/examples/1.6.x/server-python/examples/account/update-name.md new file mode 100644 index 0000000000..2ff8454dc5 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-name.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_name( + name = '<NAME>' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-password.md b/docs/examples/1.6.x/server-python/examples/account/update-password.md new file mode 100644 index 0000000000..e6c9554bd4 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-password.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_password( + password = '', + old_password = 'password' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-python/examples/account/update-phone-session.md new file mode 100644 index 0000000000..d4a35d8d3d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-phone-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account(client) + +result = account.update_phone_session( + user_id = '<USER_ID>', + secret = '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-python/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..0f9db88f45 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-phone-verification.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_phone_verification( + user_id = '<USER_ID>', + secret = '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-phone.md b/docs/examples/1.6.x/server-python/examples/account/update-phone.md new file mode 100644 index 0000000000..540b09a7c3 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-phone.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_phone( + phone = '+12065550100', + password = 'password' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-prefs.md b/docs/examples/1.6.x/server-python/examples/account/update-prefs.md new file mode 100644 index 0000000000..04e4a8f587 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-prefs.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_prefs( + prefs = {} +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-recovery.md b/docs/examples/1.6.x/server-python/examples/account/update-recovery.md new file mode 100644 index 0000000000..4ff91d4ee5 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-recovery.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_recovery( + user_id = '<USER_ID>', + secret = '<SECRET>', + password = '' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-session.md b/docs/examples/1.6.x/server-python/examples/account/update-session.md new file mode 100644 index 0000000000..289cb65725 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_session( + session_id = '<SESSION_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-status.md b/docs/examples/1.6.x/server-python/examples/account/update-status.md new file mode 100644 index 0000000000..8bf6914835 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-status.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_status() diff --git a/docs/examples/1.6.x/server-python/examples/account/update-verification.md b/docs/examples/1.6.x/server-python/examples/account/update-verification.md new file mode 100644 index 0000000000..ed2d77ab5b --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/account/update-verification.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +account = Account(client) + +result = account.update_verification( + user_id = '<USER_ID>', + secret = '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-python/examples/avatars/get-browser.md new file mode 100644 index 0000000000..3301776672 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/avatars/get-browser.md @@ -0,0 +1,16 @@ +from appwrite.client import Client +from appwrite.enums import Browser + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +avatars = Avatars(client) + +result = avatars.get_browser( + code = Browser.AVANT_BROWSER, + width = 0, # optional + height = 0, # optional + quality = 0 # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-python/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..da81afc4a7 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/avatars/get-credit-card.md @@ -0,0 +1,16 @@ +from appwrite.client import Client +from appwrite.enums import CreditCard + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +avatars = Avatars(client) + +result = avatars.get_credit_card( + code = CreditCard.AMERICAN_EXPRESS, + width = 0, # optional + height = 0, # optional + quality = 0 # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-python/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..edffdef219 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/avatars/get-favicon.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +avatars = Avatars(client) + +result = avatars.get_favicon( + url = 'https://example.com' +) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-python/examples/avatars/get-flag.md new file mode 100644 index 0000000000..a1c07e247c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/avatars/get-flag.md @@ -0,0 +1,16 @@ +from appwrite.client import Client +from appwrite.enums import Flag + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +avatars = Avatars(client) + +result = avatars.get_flag( + code = Flag.AFGHANISTAN, + width = 0, # optional + height = 0, # optional + quality = 0 # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-image.md b/docs/examples/1.6.x/server-python/examples/avatars/get-image.md new file mode 100644 index 0000000000..1a4a4c9f0d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/avatars/get-image.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +avatars = Avatars(client) + +result = avatars.get_image( + url = 'https://example.com', + width = 0, # optional + height = 0 # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-python/examples/avatars/get-initials.md new file mode 100644 index 0000000000..b443aa4f01 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/avatars/get-initials.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +avatars = Avatars(client) + +result = avatars.get_initials( + name = '<NAME>', # optional + width = 0, # optional + height = 0, # optional + background = '' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-python/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..3cb9dcca9f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/avatars/get-q-r.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +avatars = Avatars(client) + +result = avatars.get_qr( + text = '<TEXT>', + size = 1, # optional + margin = 0, # optional + download = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..2611488b95 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-boolean-attribute.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_boolean_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + default = False, # optional + array = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-collection.md b/docs/examples/1.6.x/server-python/examples/databases/create-collection.md new file mode 100644 index 0000000000..4950d88b41 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-collection.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_collection( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + name = '<NAME>', + permissions = ["read("any")"], # optional + document_security = False, # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..020d7b6e03 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-datetime-attribute.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_datetime_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + default = '', # optional + array = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-document.md b/docs/examples/1.6.x/server-python/examples/databases/create-document.md new file mode 100644 index 0000000000..3b54babaef --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-document.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +databases = Databases(client) + +result = databases.create_document( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + document_id = '<DOCUMENT_ID>', + data = {}, + permissions = ["read("any")"] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..d6cd87db99 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-email-attribute.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_email_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + default = 'email@example.com', # optional + array = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..ee2c96e41c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-enum-attribute.md @@ -0,0 +1,18 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_enum_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + elements = [], + required = False, + default = '<DEFAULT>', # optional + array = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..cce0e70bbc --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-float-attribute.md @@ -0,0 +1,19 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_float_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + min = None, # optional + max = None, # optional + default = None, # optional + array = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-index.md b/docs/examples/1.6.x/server-python/examples/databases/create-index.md new file mode 100644 index 0000000000..9e6d16f053 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-index.md @@ -0,0 +1,18 @@ +from appwrite.client import Client +from appwrite.enums import IndexType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_index( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + type = IndexType.KEY, + attributes = [], + orders = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..984800f0e6 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-integer-attribute.md @@ -0,0 +1,19 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_integer_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + min = None, # optional + max = None, # optional + default = None, # optional + array = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..a27c7d71a1 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-ip-attribute.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_ip_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + default = '', # optional + array = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..c62d5cb5c6 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-relationship-attribute.md @@ -0,0 +1,20 @@ +from appwrite.client import Client +from appwrite.enums import RelationshipType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_relationship_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + related_collection_id = '<RELATED_COLLECTION_ID>', + type = RelationshipType.ONETOONE, + two_way = False, # optional + key = '', # optional + two_way_key = '', # optional + on_delete = RelationMutate.CASCADE # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..06f86f66fe --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-string-attribute.md @@ -0,0 +1,19 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_string_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + size = 1, + required = False, + default = '<DEFAULT>', # optional + array = False, # optional + encrypt = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..3b882c58f9 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create-url-attribute.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create_url_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + default = 'https://example.com', # optional + array = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create.md b/docs/examples/1.6.x/server-python/examples/databases/create.md new file mode 100644 index 0000000000..33e8770cc9 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/create.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.create( + database_id = '<DATABASE_ID>', + name = '<NAME>', + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..ce454ba867 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/delete-attribute.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.delete_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-python/examples/databases/delete-collection.md new file mode 100644 index 0000000000..c63bedf105 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/delete-collection.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.delete_collection( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/delete-document.md b/docs/examples/1.6.x/server-python/examples/databases/delete-document.md new file mode 100644 index 0000000000..94afc57839 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/delete-document.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +databases = Databases(client) + +result = databases.delete_document( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + document_id = '<DOCUMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/delete-index.md b/docs/examples/1.6.x/server-python/examples/databases/delete-index.md new file mode 100644 index 0000000000..6890a5590c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/delete-index.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.delete_index( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/delete.md b/docs/examples/1.6.x/server-python/examples/databases/delete.md new file mode 100644 index 0000000000..f7506ffa25 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/delete.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.delete( + database_id = '<DATABASE_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/get-attribute.md new file mode 100644 index 0000000000..3e1d7866a8 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/get-attribute.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.get_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/get-collection.md b/docs/examples/1.6.x/server-python/examples/databases/get-collection.md new file mode 100644 index 0000000000..2e2d408e19 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/get-collection.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.get_collection( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/get-document.md b/docs/examples/1.6.x/server-python/examples/databases/get-document.md new file mode 100644 index 0000000000..9c3dfd47bd --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/get-document.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +databases = Databases(client) + +result = databases.get_document( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + document_id = '<DOCUMENT_ID>', + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/get-index.md b/docs/examples/1.6.x/server-python/examples/databases/get-index.md new file mode 100644 index 0000000000..4a9da1da47 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/get-index.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.get_index( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/get.md b/docs/examples/1.6.x/server-python/examples/databases/get.md new file mode 100644 index 0000000000..214e59b4ad --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/get.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.get( + database_id = '<DATABASE_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-python/examples/databases/list-attributes.md new file mode 100644 index 0000000000..dfb1463f32 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/list-attributes.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.list_attributes( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/list-collections.md b/docs/examples/1.6.x/server-python/examples/databases/list-collections.md new file mode 100644 index 0000000000..b6ea0ae0cc --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/list-collections.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.list_collections( + database_id = '<DATABASE_ID>', + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/list-documents.md b/docs/examples/1.6.x/server-python/examples/databases/list-documents.md new file mode 100644 index 0000000000..d167d89d99 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/list-documents.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +databases = Databases(client) + +result = databases.list_documents( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-python/examples/databases/list-indexes.md new file mode 100644 index 0000000000..4699aaef9e --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/list-indexes.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.list_indexes( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/list.md b/docs/examples/1.6.x/server-python/examples/databases/list.md new file mode 100644 index 0000000000..6e8f8ac884 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/list.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.list( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..d28a93a41c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-boolean-attribute.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update_boolean_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + default = False +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-collection.md b/docs/examples/1.6.x/server-python/examples/databases/update-collection.md new file mode 100644 index 0000000000..1710df8433 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-collection.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update_collection( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + name = '<NAME>', + permissions = ["read("any")"], # optional + document_security = False, # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..0c3ae96f58 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-datetime-attribute.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update_datetime_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + default = '' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-document.md b/docs/examples/1.6.x/server-python/examples/databases/update-document.md new file mode 100644 index 0000000000..6675a6c139 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-document.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +databases = Databases(client) + +result = databases.update_document( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + document_id = '<DOCUMENT_ID>', + data = {}, # optional + permissions = ["read("any")"] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..fddd79ec48 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-email-attribute.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update_email_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + default = 'email@example.com' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..6b53a08f9f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-enum-attribute.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update_enum_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + elements = [], + required = False, + default = '<DEFAULT>' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..325a3cabf4 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-float-attribute.md @@ -0,0 +1,18 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update_float_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + min = None, + max = None, + default = None +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..e5105db0f9 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-integer-attribute.md @@ -0,0 +1,18 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update_integer_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + min = None, + max = None, + default = None +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..4473eb1950 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-ip-attribute.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update_ip_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + default = '' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..5db57e7ad3 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-relationship-attribute.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update_relationship_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + on_delete = RelationMutate.CASCADE # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..c8a5de8466 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-string-attribute.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update_string_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + default = '<DEFAULT>' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..857d6bee29 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update-url-attribute.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update_url_attribute( + database_id = '<DATABASE_ID>', + collection_id = '<COLLECTION_ID>', + key = '', + required = False, + default = 'https://example.com' +) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update.md b/docs/examples/1.6.x/server-python/examples/databases/update.md new file mode 100644 index 0000000000..ca8d5ea78f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/databases/update.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases(client) + +result = databases.update( + database_id = '<DATABASE_ID>', + name = '<NAME>', + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/create-build.md b/docs/examples/1.6.x/server-python/examples/functions/create-build.md new file mode 100644 index 0000000000..152d330b25 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/create-build.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.create_build( + function_id = '<FUNCTION_ID>', + deployment_id = '<DEPLOYMENT_ID>', + build_id = '<BUILD_ID>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-python/examples/functions/create-deployment.md new file mode 100644 index 0000000000..665651afad --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/create-deployment.md @@ -0,0 +1,17 @@ +from appwrite.client import Client +from appwrite.input_file import InputFile + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.create_deployment( + function_id = '<FUNCTION_ID>', + code = InputFile.from_path('file.png'), + activate = False, + entrypoint = '<ENTRYPOINT>', # optional + commands = '<COMMANDS>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/create-execution.md b/docs/examples/1.6.x/server-python/examples/functions/create-execution.md new file mode 100644 index 0000000000..a4ff68bd04 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/create-execution.md @@ -0,0 +1,18 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +functions = Functions(client) + +result = functions.create_execution( + function_id = '<FUNCTION_ID>', + body = '<BODY>', # optional + async = False, # optional + path = '<PATH>', # optional + method = ExecutionMethod.GET, # optional + headers = {}, # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/create-variable.md b/docs/examples/1.6.x/server-python/examples/functions/create-variable.md new file mode 100644 index 0000000000..621a04a631 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/create-variable.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.create_variable( + function_id = '<FUNCTION_ID>', + key = '<KEY>', + value = '<VALUE>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/create.md b/docs/examples/1.6.x/server-python/examples/functions/create.md new file mode 100644 index 0000000000..6bc91c17ee --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/create.md @@ -0,0 +1,33 @@ +from appwrite.client import Client +from appwrite.enums import + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.create( + function_id = '<FUNCTION_ID>', + name = '<NAME>', + runtime = .NODE_14_5, + execute = ["any"], # optional + events = [], # optional + schedule = '', # optional + timeout = 1, # optional + enabled = False, # optional + logging = False, # optional + entrypoint = '<ENTRYPOINT>', # optional + commands = '<COMMANDS>', # optional + scopes = [], # optional + installation_id = '<INSTALLATION_ID>', # optional + provider_repository_id = '<PROVIDER_REPOSITORY_ID>', # optional + provider_branch = '<PROVIDER_BRANCH>', # optional + provider_silent_mode = False, # optional + provider_root_directory = '<PROVIDER_ROOT_DIRECTORY>', # optional + template_repository = '<TEMPLATE_REPOSITORY>', # optional + template_owner = '<TEMPLATE_OWNER>', # optional + template_root_directory = '<TEMPLATE_ROOT_DIRECTORY>', # optional + template_branch = '<TEMPLATE_BRANCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-python/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..59fa72908d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/delete-deployment.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.delete_deployment( + function_id = '<FUNCTION_ID>', + deployment_id = '<DEPLOYMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-python/examples/functions/delete-execution.md new file mode 100644 index 0000000000..61919caefe --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/delete-execution.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.delete_execution( + function_id = '<FUNCTION_ID>', + execution_id = '<EXECUTION_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-python/examples/functions/delete-variable.md new file mode 100644 index 0000000000..15c82dc28e --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/delete-variable.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.delete_variable( + function_id = '<FUNCTION_ID>', + variable_id = '<VARIABLE_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/delete.md b/docs/examples/1.6.x/server-python/examples/functions/delete.md new file mode 100644 index 0000000000..660d70b006 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/delete.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.delete( + function_id = '<FUNCTION_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-python/examples/functions/download-deployment.md new file mode 100644 index 0000000000..2d0289bf98 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/download-deployment.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.download_deployment( + function_id = '<FUNCTION_ID>', + deployment_id = '<DEPLOYMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-python/examples/functions/get-deployment.md new file mode 100644 index 0000000000..9475ae0e19 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/get-deployment.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.get_deployment( + function_id = '<FUNCTION_ID>', + deployment_id = '<DEPLOYMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/get-execution.md b/docs/examples/1.6.x/server-python/examples/functions/get-execution.md new file mode 100644 index 0000000000..ccca0860bb --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/get-execution.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +functions = Functions(client) + +result = functions.get_execution( + function_id = '<FUNCTION_ID>', + execution_id = '<EXECUTION_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/get-variable.md b/docs/examples/1.6.x/server-python/examples/functions/get-variable.md new file mode 100644 index 0000000000..1164f2801a --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/get-variable.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.get_variable( + function_id = '<FUNCTION_ID>', + variable_id = '<VARIABLE_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/get.md b/docs/examples/1.6.x/server-python/examples/functions/get.md new file mode 100644 index 0000000000..82d834cd42 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/get.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.get( + function_id = '<FUNCTION_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-python/examples/functions/list-deployments.md new file mode 100644 index 0000000000..1d5dc72b2f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/list-deployments.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.list_deployments( + function_id = '<FUNCTION_ID>', + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/list-executions.md b/docs/examples/1.6.x/server-python/examples/functions/list-executions.md new file mode 100644 index 0000000000..9862222922 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/list-executions.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +functions = Functions(client) + +result = functions.list_executions( + function_id = '<FUNCTION_ID>', + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-python/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..4efe60a18b --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/list-runtimes.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.list_runtimes() diff --git a/docs/examples/1.6.x/server-python/examples/functions/list-variables.md b/docs/examples/1.6.x/server-python/examples/functions/list-variables.md new file mode 100644 index 0000000000..29d6bf0538 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/list-variables.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.list_variables( + function_id = '<FUNCTION_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/list.md b/docs/examples/1.6.x/server-python/examples/functions/list.md new file mode 100644 index 0000000000..0ef5ebaca6 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/list.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.list( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-python/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..d5e9c54da9 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/update-deployment-build.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.update_deployment_build( + function_id = '<FUNCTION_ID>', + deployment_id = '<DEPLOYMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-python/examples/functions/update-deployment.md new file mode 100644 index 0000000000..3bc5ac08dd --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/update-deployment.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.update_deployment( + function_id = '<FUNCTION_ID>', + deployment_id = '<DEPLOYMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/update-variable.md b/docs/examples/1.6.x/server-python/examples/functions/update-variable.md new file mode 100644 index 0000000000..2fdd4a04f8 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/update-variable.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.update_variable( + function_id = '<FUNCTION_ID>', + variable_id = '<VARIABLE_ID>', + key = '<KEY>', + value = '<VALUE>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/functions/update.md b/docs/examples/1.6.x/server-python/examples/functions/update.md new file mode 100644 index 0000000000..7c64a8702f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/functions/update.md @@ -0,0 +1,28 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions(client) + +result = functions.update( + function_id = '<FUNCTION_ID>', + name = '<NAME>', + runtime = .NODE_14_5, # optional + execute = ["any"], # optional + events = [], # optional + schedule = '', # optional + timeout = 1, # optional + enabled = False, # optional + logging = False, # optional + entrypoint = '<ENTRYPOINT>', # optional + commands = '<COMMANDS>', # optional + scopes = [], # optional + installation_id = '<INSTALLATION_ID>', # optional + provider_repository_id = '<PROVIDER_REPOSITORY_ID>', # optional + provider_branch = '<PROVIDER_BRANCH>', # optional + provider_silent_mode = False, # optional + provider_root_directory = '<PROVIDER_ROOT_DIRECTORY>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/graphql/mutation.md b/docs/examples/1.6.x/server-python/examples/graphql/mutation.md new file mode 100644 index 0000000000..d9e0ba63c2 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/graphql/mutation.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +graphql = Graphql(client) + +result = graphql.mutation( + query = {} +) diff --git a/docs/examples/1.6.x/server-python/examples/graphql/query.md b/docs/examples/1.6.x/server-python/examples/graphql/query.md new file mode 100644 index 0000000000..55b526ce7e --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/graphql/query.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +graphql = Graphql(client) + +result = graphql.query( + query = {} +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-python/examples/health/get-antivirus.md new file mode 100644 index 0000000000..2cbf4dc8e2 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-antivirus.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_antivirus() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-cache.md b/docs/examples/1.6.x/server-python/examples/health/get-cache.md new file mode 100644 index 0000000000..12d70604fe --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-cache.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_cache() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-certificate.md b/docs/examples/1.6.x/server-python/examples/health/get-certificate.md new file mode 100644 index 0000000000..fdf5583f07 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-certificate.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_certificate( + domain = '' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-d-b.md b/docs/examples/1.6.x/server-python/examples/health/get-d-b.md new file mode 100644 index 0000000000..2f47125142 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-d-b.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_db() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-python/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..402fde9cec --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-failed-jobs.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.enums import + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_failed_jobs( + name = .V1_DATABASE, + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-python/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..27d1f22f87 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-pub-sub.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_pub_sub() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..a811b10530 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-builds.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_builds( + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..6e3e18b06f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-certificates.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_certificates( + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..502294c5d2 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-databases.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_databases( + name = '<NAME>', # optional + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..bbae3eb5eb --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-deletes.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_deletes( + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..deffbb9038 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-functions.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_functions( + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..081bdfcb01 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-logs.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_logs( + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..f1dafb6acd --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-mails.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_mails( + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..6b5c2fea47 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-messaging.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_messaging( + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..58ba3ebd0d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-migrations.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_migrations( + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..33f66075fb --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-usage-dump.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_usage_dump( + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..e01272cdbb --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-usage.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_usage( + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..b194541614 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue-webhooks.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue_webhooks( + threshold = None # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue.md b/docs/examples/1.6.x/server-python/examples/health/get-queue.md new file mode 100644 index 0000000000..6bc0fd2953 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-queue.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_queue() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-python/examples/health/get-storage-local.md new file mode 100644 index 0000000000..d5a8c367ce --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-storage-local.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_storage_local() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-storage.md b/docs/examples/1.6.x/server-python/examples/health/get-storage.md new file mode 100644 index 0000000000..d1d225b076 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-storage.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_storage() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-time.md b/docs/examples/1.6.x/server-python/examples/health/get-time.md new file mode 100644 index 0000000000..2205c1397c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get-time.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get_time() diff --git a/docs/examples/1.6.x/server-python/examples/health/get.md b/docs/examples/1.6.x/server-python/examples/health/get.md new file mode 100644 index 0000000000..5a5b80c5d4 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/health/get.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health(client) + +result = health.get() diff --git a/docs/examples/1.6.x/server-python/examples/locale/get.md b/docs/examples/1.6.x/server-python/examples/locale/get.md new file mode 100644 index 0000000000..b47f365c4d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/locale/get.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +locale = Locale(client) + +result = locale.get() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-codes.md b/docs/examples/1.6.x/server-python/examples/locale/list-codes.md new file mode 100644 index 0000000000..700455a86f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/locale/list-codes.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +locale = Locale(client) + +result = locale.list_codes() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-continents.md b/docs/examples/1.6.x/server-python/examples/locale/list-continents.md new file mode 100644 index 0000000000..0db5650b1f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/locale/list-continents.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +locale = Locale(client) + +result = locale.list_continents() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-python/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..1b74f1b7a9 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/locale/list-countries-e-u.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +locale = Locale(client) + +result = locale.list_countries_eu() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-python/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..d3432f1467 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/locale/list-countries-phones.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +locale = Locale(client) + +result = locale.list_countries_phones() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-countries.md b/docs/examples/1.6.x/server-python/examples/locale/list-countries.md new file mode 100644 index 0000000000..76db17e353 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/locale/list-countries.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +locale = Locale(client) + +result = locale.list_countries() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-python/examples/locale/list-currencies.md new file mode 100644 index 0000000000..45993bb23f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/locale/list-currencies.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +locale = Locale(client) + +result = locale.list_currencies() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-languages.md b/docs/examples/1.6.x/server-python/examples/locale/list-languages.md new file mode 100644 index 0000000000..9b255ae01b --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/locale/list-languages.md @@ -0,0 +1,10 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +locale = Locale(client) + +result = locale.list_languages() diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..c74886c075 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-apns-provider.md @@ -0,0 +1,19 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_apns_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + auth_key = '<AUTH_KEY>', # optional + auth_key_id = '<AUTH_KEY_ID>', # optional + team_id = '<TEAM_ID>', # optional + bundle_id = '<BUNDLE_ID>', # optional + sandbox = False, # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-email.md b/docs/examples/1.6.x/server-python/examples/messaging/create-email.md new file mode 100644 index 0000000000..2c9f7a505d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-email.md @@ -0,0 +1,23 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_email( + message_id = '<MESSAGE_ID>', + subject = '<SUBJECT>', + content = '<CONTENT>', + topics = [], # optional + users = [], # optional + targets = [], # optional + cc = [], # optional + bcc = [], # optional + attachments = [], # optional + draft = False, # optional + html = False, # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..1f19316bb2 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-fcm-provider.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_fcm_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + service_account_json = {}, # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..5e90d42d36 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,21 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_mailgun_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + api_key = '<API_KEY>', # optional + domain = '<DOMAIN>', # optional + is_eu_region = False, # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = 'email@example.com', # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..16e1075328 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-msg91provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_msg91_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + template_id = '<TEMPLATE_ID>', # optional + sender_id = '<SENDER_ID>', # optional + auth_key = '<AUTH_KEY>', # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-push.md b/docs/examples/1.6.x/server-python/examples/messaging/create-push.md new file mode 100644 index 0000000000..825104aa07 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-push.md @@ -0,0 +1,27 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_push( + message_id = '<MESSAGE_ID>', + title = '<TITLE>', + body = '<BODY>', + topics = [], # optional + users = [], # optional + targets = [], # optional + data = {}, # optional + action = '<ACTION>', # optional + image = '[ID1:ID2]', # optional + icon = '<ICON>', # optional + sound = '<SOUND>', # optional + color = '<COLOR>', # optional + tag = '<TAG>', # optional + badge = '<BADGE>', # optional + draft = False, # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..9ec7d8dd5e --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,19 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_sendgrid_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + api_key = '<API_KEY>', # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = 'email@example.com', # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-python/examples/messaging/create-sms.md new file mode 100644 index 0000000000..50bd9c821a --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-sms.md @@ -0,0 +1,18 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_sms( + message_id = '<MESSAGE_ID>', + content = '<CONTENT>', + topics = [], # optional + users = [], # optional + targets = [], # optional + draft = False, # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..d18b883be0 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-smtp-provider.md @@ -0,0 +1,25 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_smtp_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + host = '<HOST>', + port = 1, # optional + username = '<USERNAME>', # optional + password = '<PASSWORD>', # optional + encryption = SmtpEncryption.NONE, # optional + auto_tls = False, # optional + mailer = '<MAILER>', # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = 'email@example.com', # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-python/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..8c6eab3cc1 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-subscriber.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_jwt('<YOUR_JWT>') # Your secret JSON Web Token + +messaging = Messaging(client) + +result = messaging.create_subscriber( + topic_id = '<TOPIC_ID>', + subscriber_id = '<SUBSCRIBER_ID>', + target_id = '<TARGET_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..cf26b82f1f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-telesign-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_telesign_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + from = '+12065550100', # optional + customer_id = '<CUSTOMER_ID>', # optional + api_key = '<API_KEY>', # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..896fbf5911 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_textmagic_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + from = '+12065550100', # optional + username = '<USERNAME>', # optional + api_key = '<API_KEY>', # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-python/examples/messaging/create-topic.md new file mode 100644 index 0000000000..0d58b9d094 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-topic.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_topic( + topic_id = '<TOPIC_ID>', + name = '<NAME>', + subscribe = ["any"] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..9be321f313 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-twilio-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_twilio_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + from = '+12065550100', # optional + account_sid = '<ACCOUNT_SID>', # optional + auth_token = '<AUTH_TOKEN>', # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..a39246d398 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/create-vonage-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.create_vonage_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', + from = '+12065550100', # optional + api_key = '<API_KEY>', # optional + api_secret = '<API_SECRET>', # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..cb06a2b5ed --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/delete-provider.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.delete_provider( + provider_id = '<PROVIDER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-python/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..ca25bdb2aa --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/delete-subscriber.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_jwt('<YOUR_JWT>') # Your secret JSON Web Token + +messaging = Messaging(client) + +result = messaging.delete_subscriber( + topic_id = '<TOPIC_ID>', + subscriber_id = '<SUBSCRIBER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-python/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..e91403a543 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/delete-topic.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.delete_topic( + topic_id = '<TOPIC_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/delete.md b/docs/examples/1.6.x/server-python/examples/messaging/delete.md new file mode 100644 index 0000000000..b6d7081120 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/delete.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.delete( + message_id = '<MESSAGE_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/get-message.md b/docs/examples/1.6.x/server-python/examples/messaging/get-message.md new file mode 100644 index 0000000000..90b2035202 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/get-message.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.get_message( + message_id = '<MESSAGE_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/get-provider.md new file mode 100644 index 0000000000..b49376055c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/get-provider.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.get_provider( + provider_id = '<PROVIDER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-python/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..68427cf6e6 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/get-subscriber.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.get_subscriber( + topic_id = '<TOPIC_ID>', + subscriber_id = '<SUBSCRIBER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-python/examples/messaging/get-topic.md new file mode 100644 index 0000000000..158c18fdd4 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/get-topic.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.get_topic( + topic_id = '<TOPIC_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-python/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..d920a93816 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/list-message-logs.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_message_logs( + message_id = '<MESSAGE_ID>', + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-python/examples/messaging/list-messages.md new file mode 100644 index 0000000000..0cb376e81e --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/list-messages.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_messages( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-python/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..8590f9b9dd --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/list-provider-logs.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_provider_logs( + provider_id = '<PROVIDER_ID>', + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-python/examples/messaging/list-providers.md new file mode 100644 index 0000000000..cc6aec1425 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/list-providers.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_providers( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-python/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..e39c81feca --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_subscriber_logs( + subscriber_id = '<SUBSCRIBER_ID>', + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-python/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..1c49bc084a --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/list-subscribers.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_subscribers( + topic_id = '<TOPIC_ID>', + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-python/examples/messaging/list-targets.md new file mode 100644 index 0000000000..5d38f70a6a --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/list-targets.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_targets( + message_id = '<MESSAGE_ID>', + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-python/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..6b312454da --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/list-topic-logs.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_topic_logs( + topic_id = '<TOPIC_ID>', + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-python/examples/messaging/list-topics.md new file mode 100644 index 0000000000..6bdd594e41 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/list-topics.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.list_topics( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..5fb6c06c4c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-apns-provider.md @@ -0,0 +1,19 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_apns_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + auth_key = '<AUTH_KEY>', # optional + auth_key_id = '<AUTH_KEY_ID>', # optional + team_id = '<TEAM_ID>', # optional + bundle_id = '<BUNDLE_ID>', # optional + sandbox = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-email.md b/docs/examples/1.6.x/server-python/examples/messaging/update-email.md new file mode 100644 index 0000000000..2b7576a9a3 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-email.md @@ -0,0 +1,23 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_email( + message_id = '<MESSAGE_ID>', + topics = [], # optional + users = [], # optional + targets = [], # optional + subject = '<SUBJECT>', # optional + content = '<CONTENT>', # optional + draft = False, # optional + html = False, # optional + cc = [], # optional + bcc = [], # optional + scheduled_at = '', # optional + attachments = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..4a4b3dc390 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-fcm-provider.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_fcm_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + service_account_json = {} # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..f64307ea3e --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,21 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_mailgun_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + api_key = '<API_KEY>', # optional + domain = '<DOMAIN>', # optional + is_eu_region = False, # optional + enabled = False, # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = '<REPLY_TO_EMAIL>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..2d88e70d3a --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-msg91provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_msg91_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + template_id = '<TEMPLATE_ID>', # optional + sender_id = '<SENDER_ID>', # optional + auth_key = '<AUTH_KEY>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-push.md b/docs/examples/1.6.x/server-python/examples/messaging/update-push.md new file mode 100644 index 0000000000..6069a928ef --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-push.md @@ -0,0 +1,27 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_push( + message_id = '<MESSAGE_ID>', + topics = [], # optional + users = [], # optional + targets = [], # optional + title = '<TITLE>', # optional + body = '<BODY>', # optional + data = {}, # optional + action = '<ACTION>', # optional + image = '[ID1:ID2]', # optional + icon = '<ICON>', # optional + sound = '<SOUND>', # optional + color = '<COLOR>', # optional + tag = '<TAG>', # optional + badge = None, # optional + draft = False, # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..d54c5ccf0a --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,19 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_sendgrid_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + api_key = '<API_KEY>', # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = '<REPLY_TO_EMAIL>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-python/examples/messaging/update-sms.md new file mode 100644 index 0000000000..9f1902bfcb --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-sms.md @@ -0,0 +1,18 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_sms( + message_id = '<MESSAGE_ID>', + topics = [], # optional + users = [], # optional + targets = [], # optional + content = '<CONTENT>', # optional + draft = False, # optional + scheduled_at = '' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..0bbe18d187 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-smtp-provider.md @@ -0,0 +1,25 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_smtp_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + host = '<HOST>', # optional + port = 1, # optional + username = '<USERNAME>', # optional + password = '<PASSWORD>', # optional + encryption = SmtpEncryption.NONE, # optional + auto_tls = False, # optional + mailer = '<MAILER>', # optional + from_name = '<FROM_NAME>', # optional + from_email = 'email@example.com', # optional + reply_to_name = '<REPLY_TO_NAME>', # optional + reply_to_email = '<REPLY_TO_EMAIL>', # optional + enabled = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..b285490c3e --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-telesign-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_telesign_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + customer_id = '<CUSTOMER_ID>', # optional + api_key = '<API_KEY>', # optional + from = '<FROM>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..4384e4c4db --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_textmagic_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + username = '<USERNAME>', # optional + api_key = '<API_KEY>', # optional + from = '<FROM>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-python/examples/messaging/update-topic.md new file mode 100644 index 0000000000..3d084b1707 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-topic.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_topic( + topic_id = '<TOPIC_ID>', + name = '<NAME>', # optional + subscribe = ["any"] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..e8bb4c0892 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-twilio-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_twilio_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + account_sid = '<ACCOUNT_SID>', # optional + auth_token = '<AUTH_TOKEN>', # optional + from = '<FROM>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..115851538a --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/messaging/update-vonage-provider.md @@ -0,0 +1,17 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging(client) + +result = messaging.update_vonage_provider( + provider_id = '<PROVIDER_ID>', + name = '<NAME>', # optional + enabled = False, # optional + api_key = '<API_KEY>', # optional + api_secret = '<API_SECRET>', # optional + from = '<FROM>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-python/examples/storage/create-bucket.md new file mode 100644 index 0000000000..2ca86a5eb2 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/create-bucket.md @@ -0,0 +1,21 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +storage = Storage(client) + +result = storage.create_bucket( + bucket_id = '<BUCKET_ID>', + name = '<NAME>', + permissions = ["read("any")"], # optional + file_security = False, # optional + enabled = False, # optional + maximum_file_size = 1, # optional + allowed_file_extensions = [], # optional + compression = .NONE, # optional + encryption = False, # optional + antivirus = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/create-file.md b/docs/examples/1.6.x/server-python/examples/storage/create-file.md new file mode 100644 index 0000000000..391b6427b1 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/create-file.md @@ -0,0 +1,16 @@ +from appwrite.client import Client +from appwrite.input_file import InputFile + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +storage = Storage(client) + +result = storage.create_file( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>', + file = InputFile.from_path('file.png'), + permissions = ["read("any")"] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-python/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..980e1ec32c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/delete-bucket.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +storage = Storage(client) + +result = storage.delete_bucket( + bucket_id = '<BUCKET_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/delete-file.md b/docs/examples/1.6.x/server-python/examples/storage/delete-file.md new file mode 100644 index 0000000000..8bce51d143 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/delete-file.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +storage = Storage(client) + +result = storage.delete_file( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-python/examples/storage/get-bucket.md new file mode 100644 index 0000000000..a1712b375d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/get-bucket.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +storage = Storage(client) + +result = storage.get_bucket( + bucket_id = '<BUCKET_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-python/examples/storage/get-file-download.md new file mode 100644 index 0000000000..d8658356d6 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/get-file-download.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +storage = Storage(client) + +result = storage.get_file_download( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-python/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..f69f9227a5 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/get-file-preview.md @@ -0,0 +1,24 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +storage = Storage(client) + +result = storage.get_file_preview( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>', + width = 0, # optional + height = 0, # optional + gravity = ImageGravity.CENTER, # optional + quality = 0, # optional + border_width = 0, # optional + border_color = '', # optional + border_radius = 0, # optional + opacity = 0, # optional + rotation = -360, # optional + background = '', # optional + output = ImageFormat.JPG # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-python/examples/storage/get-file-view.md new file mode 100644 index 0000000000..043772a66e --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/get-file-view.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +storage = Storage(client) + +result = storage.get_file_view( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/get-file.md b/docs/examples/1.6.x/server-python/examples/storage/get-file.md new file mode 100644 index 0000000000..af451afbee --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/get-file.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +storage = Storage(client) + +result = storage.get_file( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-python/examples/storage/list-buckets.md new file mode 100644 index 0000000000..e6202bd5ab --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/list-buckets.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +storage = Storage(client) + +result = storage.list_buckets( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/list-files.md b/docs/examples/1.6.x/server-python/examples/storage/list-files.md new file mode 100644 index 0000000000..d1408581f4 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/list-files.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +storage = Storage(client) + +result = storage.list_files( + bucket_id = '<BUCKET_ID>', + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-python/examples/storage/update-bucket.md new file mode 100644 index 0000000000..bcb59eafb1 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/update-bucket.md @@ -0,0 +1,21 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +storage = Storage(client) + +result = storage.update_bucket( + bucket_id = '<BUCKET_ID>', + name = '<NAME>', + permissions = ["read("any")"], # optional + file_security = False, # optional + enabled = False, # optional + maximum_file_size = 1, # optional + allowed_file_extensions = [], # optional + compression = .NONE, # optional + encryption = False, # optional + antivirus = False # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/storage/update-file.md b/docs/examples/1.6.x/server-python/examples/storage/update-file.md new file mode 100644 index 0000000000..22e32cbac8 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/storage/update-file.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +storage = Storage(client) + +result = storage.update_file( + bucket_id = '<BUCKET_ID>', + file_id = '<FILE_ID>', + name = '<NAME>', # optional + permissions = ["read("any")"] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/create-membership.md b/docs/examples/1.6.x/server-python/examples/teams/create-membership.md new file mode 100644 index 0000000000..3664e35eb3 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/create-membership.md @@ -0,0 +1,18 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.create_membership( + team_id = '<TEAM_ID>', + roles = [], + email = 'email@example.com', # optional + user_id = '<USER_ID>', # optional + phone = '+12065550100', # optional + url = 'https://example.com', # optional + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/create.md b/docs/examples/1.6.x/server-python/examples/teams/create.md new file mode 100644 index 0000000000..94a0467cc9 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/create.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.create( + team_id = '<TEAM_ID>', + name = '<NAME>', + roles = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-python/examples/teams/delete-membership.md new file mode 100644 index 0000000000..9dccc49423 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/delete-membership.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.delete_membership( + team_id = '<TEAM_ID>', + membership_id = '<MEMBERSHIP_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/delete.md b/docs/examples/1.6.x/server-python/examples/teams/delete.md new file mode 100644 index 0000000000..f92048854a --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/delete.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.delete( + team_id = '<TEAM_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/get-membership.md b/docs/examples/1.6.x/server-python/examples/teams/get-membership.md new file mode 100644 index 0000000000..fa961e3ea5 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/get-membership.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.get_membership( + team_id = '<TEAM_ID>', + membership_id = '<MEMBERSHIP_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-python/examples/teams/get-prefs.md new file mode 100644 index 0000000000..6b097f1793 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/get-prefs.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.get_prefs( + team_id = '<TEAM_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/get.md b/docs/examples/1.6.x/server-python/examples/teams/get.md new file mode 100644 index 0000000000..20a807e802 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/get.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.get( + team_id = '<TEAM_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-python/examples/teams/list-memberships.md new file mode 100644 index 0000000000..02bb575628 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/list-memberships.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.list_memberships( + team_id = '<TEAM_ID>', + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/list.md b/docs/examples/1.6.x/server-python/examples/teams/list.md new file mode 100644 index 0000000000..7a3018f242 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/list.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.list( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-python/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..6e06b8d037 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/update-membership-status.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.update_membership_status( + team_id = '<TEAM_ID>', + membership_id = '<MEMBERSHIP_ID>', + user_id = '<USER_ID>', + secret = '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/update-membership.md b/docs/examples/1.6.x/server-python/examples/teams/update-membership.md new file mode 100644 index 0000000000..ecdfe2b8fd --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/update-membership.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.update_membership( + team_id = '<TEAM_ID>', + membership_id = '<MEMBERSHIP_ID>', + roles = [] +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/update-name.md b/docs/examples/1.6.x/server-python/examples/teams/update-name.md new file mode 100644 index 0000000000..b5f44aaad5 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/update-name.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.update_name( + team_id = '<TEAM_ID>', + name = '<NAME>' +) diff --git a/docs/examples/1.6.x/server-python/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-python/examples/teams/update-prefs.md new file mode 100644 index 0000000000..c31f64f992 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/teams/update-prefs.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_session('') # The user session to authenticate with + +teams = Teams(client) + +result = teams.update_prefs( + team_id = '<TEAM_ID>', + prefs = {} +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-python/examples/users/create-argon2user.md new file mode 100644 index 0000000000..ab35ec62df --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-argon2user.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_argon2_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-python/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..eadd5e46ad --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-bcrypt-user.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_bcrypt_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-python/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..56d27f4de1 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-j-w-t.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_jwt( + user_id = '<USER_ID>', + session_id = '<SESSION_ID>', # optional + duration = 0 # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-python/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..81c1b462ec --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-m-d5user.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_md5_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..0d2f63e31b --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_mfa_recovery_codes( + user_id = '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-python/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..e499792cc9 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-p-h-pass-user.md @@ -0,0 +1,15 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_ph_pass_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-python/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..c7cacbc2e3 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-s-h-a-user.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_sha_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + password_version = PasswordHash.SHA1, # optional + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-python/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..a3fd282c2c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,18 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_scrypt_modified_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + password_salt = '<PASSWORD_SALT>', + password_salt_separator = '<PASSWORD_SALT_SEPARATOR>', + password_signer_key = '<PASSWORD_SIGNER_KEY>', + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-python/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..483755a7de --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-scrypt-user.md @@ -0,0 +1,20 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_scrypt_user( + user_id = '<USER_ID>', + email = 'email@example.com', + password = 'password', + password_salt = '<PASSWORD_SALT>', + password_cpu = None, + password_memory = None, + password_parallel = None, + password_length = None, + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-session.md b/docs/examples/1.6.x/server-python/examples/users/create-session.md new file mode 100644 index 0000000000..d28faf9a7b --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-session.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_session( + user_id = '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-target.md b/docs/examples/1.6.x/server-python/examples/users/create-target.md new file mode 100644 index 0000000000..2f3ccb6f5f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-target.md @@ -0,0 +1,18 @@ +from appwrite.client import Client +from appwrite.enums import MessagingProviderType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_target( + user_id = '<USER_ID>', + target_id = '<TARGET_ID>', + provider_type = MessagingProviderType.EMAIL, + identifier = '<IDENTIFIER>', + provider_id = '<PROVIDER_ID>', # optional + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-token.md b/docs/examples/1.6.x/server-python/examples/users/create-token.md new file mode 100644 index 0000000000..ee58dbb435 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create-token.md @@ -0,0 +1,14 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create_token( + user_id = '<USER_ID>', + length = 4, # optional + expire = 60 # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/create.md b/docs/examples/1.6.x/server-python/examples/users/create.md new file mode 100644 index 0000000000..e310b81f4c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/create.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.create( + user_id = '<USER_ID>', + email = 'email@example.com', # optional + phone = '+12065550100', # optional + password = '', # optional + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete-identity.md b/docs/examples/1.6.x/server-python/examples/users/delete-identity.md new file mode 100644 index 0000000000..493f618ce1 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/delete-identity.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.delete_identity( + identity_id = '<IDENTITY_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-python/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..e7c3525277 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,14 @@ +from appwrite.client import Client +from appwrite.enums import AuthenticatorType + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.delete_mfa_authenticator( + user_id = '<USER_ID>', + type = AuthenticatorType.TOTP +) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete-session.md b/docs/examples/1.6.x/server-python/examples/users/delete-session.md new file mode 100644 index 0000000000..658a49848d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/delete-session.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.delete_session( + user_id = '<USER_ID>', + session_id = '<SESSION_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-python/examples/users/delete-sessions.md new file mode 100644 index 0000000000..6fdd149bc5 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/delete-sessions.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.delete_sessions( + user_id = '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete-target.md b/docs/examples/1.6.x/server-python/examples/users/delete-target.md new file mode 100644 index 0000000000..67d94d3015 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/delete-target.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.delete_target( + user_id = '<USER_ID>', + target_id = '<TARGET_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete.md b/docs/examples/1.6.x/server-python/examples/users/delete.md new file mode 100644 index 0000000000..056647f8aa --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/delete.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.delete( + user_id = '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..21e9b2730d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.get_mfa_recovery_codes( + user_id = '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/get-prefs.md b/docs/examples/1.6.x/server-python/examples/users/get-prefs.md new file mode 100644 index 0000000000..62c0488bf6 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/get-prefs.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.get_prefs( + user_id = '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/get-target.md b/docs/examples/1.6.x/server-python/examples/users/get-target.md new file mode 100644 index 0000000000..994fbfab0b --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/get-target.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.get_target( + user_id = '<USER_ID>', + target_id = '<TARGET_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/get.md b/docs/examples/1.6.x/server-python/examples/users/get.md new file mode 100644 index 0000000000..3fbfdc748c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/get.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.get( + user_id = '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-identities.md b/docs/examples/1.6.x/server-python/examples/users/list-identities.md new file mode 100644 index 0000000000..20de979a79 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/list-identities.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.list_identities( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-logs.md b/docs/examples/1.6.x/server-python/examples/users/list-logs.md new file mode 100644 index 0000000000..6c7376428c --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/list-logs.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.list_logs( + user_id = '<USER_ID>', + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-memberships.md b/docs/examples/1.6.x/server-python/examples/users/list-memberships.md new file mode 100644 index 0000000000..38f1b05202 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/list-memberships.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.list_memberships( + user_id = '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-python/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..425f4988f3 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/list-mfa-factors.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.list_mfa_factors( + user_id = '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-sessions.md b/docs/examples/1.6.x/server-python/examples/users/list-sessions.md new file mode 100644 index 0000000000..7271449602 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/list-sessions.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.list_sessions( + user_id = '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-targets.md b/docs/examples/1.6.x/server-python/examples/users/list-targets.md new file mode 100644 index 0000000000..e0c288982d --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/list-targets.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.list_targets( + user_id = '<USER_ID>', + queries = [] # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/list.md b/docs/examples/1.6.x/server-python/examples/users/list.md new file mode 100644 index 0000000000..5401629abd --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/list.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.list( + queries = [], # optional + search = '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-python/examples/users/update-email-verification.md new file mode 100644 index 0000000000..af0387e403 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-email-verification.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_email_verification( + user_id = '<USER_ID>', + email_verification = False +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-email.md b/docs/examples/1.6.x/server-python/examples/users/update-email.md new file mode 100644 index 0000000000..fb9f0b5e41 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-email.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_email( + user_id = '<USER_ID>', + email = 'email@example.com' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-labels.md b/docs/examples/1.6.x/server-python/examples/users/update-labels.md new file mode 100644 index 0000000000..58e7145a93 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-labels.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_labels( + user_id = '<USER_ID>', + labels = [] +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..7aede583f3 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_mfa_recovery_codes( + user_id = '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-mfa.md b/docs/examples/1.6.x/server-python/examples/users/update-mfa.md new file mode 100644 index 0000000000..9ed34b511f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-mfa.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_mfa( + user_id = '<USER_ID>', + mfa = False +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-name.md b/docs/examples/1.6.x/server-python/examples/users/update-name.md new file mode 100644 index 0000000000..d232424aa0 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-name.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_name( + user_id = '<USER_ID>', + name = '<NAME>' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-password.md b/docs/examples/1.6.x/server-python/examples/users/update-password.md new file mode 100644 index 0000000000..1d3c30168f --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-password.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_password( + user_id = '<USER_ID>', + password = '' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-python/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..5f61f9498a --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-phone-verification.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_phone_verification( + user_id = '<USER_ID>', + phone_verification = False +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-phone.md b/docs/examples/1.6.x/server-python/examples/users/update-phone.md new file mode 100644 index 0000000000..246e0a7717 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-phone.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_phone( + user_id = '<USER_ID>', + number = '+12065550100' +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-prefs.md b/docs/examples/1.6.x/server-python/examples/users/update-prefs.md new file mode 100644 index 0000000000..0fafb6dd01 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-prefs.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_prefs( + user_id = '<USER_ID>', + prefs = {} +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-status.md b/docs/examples/1.6.x/server-python/examples/users/update-status.md new file mode 100644 index 0000000000..d970440d99 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-status.md @@ -0,0 +1,13 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_status( + user_id = '<USER_ID>', + status = False +) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-target.md b/docs/examples/1.6.x/server-python/examples/users/update-target.md new file mode 100644 index 0000000000..97370cb203 --- /dev/null +++ b/docs/examples/1.6.x/server-python/examples/users/update-target.md @@ -0,0 +1,16 @@ +from appwrite.client import Client + +client = Client() +client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint +client.set_project('<YOUR_PROJECT_ID>') # Your project ID +client.set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users(client) + +result = users.update_target( + user_id = '<USER_ID>', + target_id = '<TARGET_ID>', + identifier = '<IDENTIFIER>', # optional + provider_id = '<PROVIDER_ID>', # optional + name = '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-rest/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..772e31903e --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-anonymous-session.md @@ -0,0 +1,6 @@ +POST /v1/account/sessions/anonymous HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-rest/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..bee865dac0 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-email-password-session.md @@ -0,0 +1,10 @@ +POST /v1/account/sessions/email HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "email": "email@example.com", + "password": "password" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-email-token.md b/docs/examples/1.6.x/server-rest/examples/account/create-email-token.md new file mode 100644 index 0000000000..206711b906 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-email-token.md @@ -0,0 +1,11 @@ +POST /v1/account/tokens/email HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "phrase": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-rest/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..83169a46f9 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-j-w-t.md @@ -0,0 +1,6 @@ +POST /v1/account/jwts HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-rest/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..43b946c7b6 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,12 @@ +POST /v1/account/tokens/magic-url HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "url": "https://example.com", + "phrase": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-rest/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..baacbbe18b --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-mfa-authenticator.md @@ -0,0 +1,8 @@ +POST /v1/account/mfa/authenticators/{type} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-rest/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..991710a0cb --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-mfa-challenge.md @@ -0,0 +1,9 @@ +POST /v1/account/mfa/challenge HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "factor": "email" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..b7214f244d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,8 @@ +POST /v1/account/mfa/recovery-codes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-rest/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..99abb6d4a9 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-o-auth2token.md @@ -0,0 +1,6 @@ +GET /v1/account/tokens/oauth2/{provider} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-rest/examples/account/create-phone-token.md new file mode 100644 index 0000000000..4a9a99c949 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-phone-token.md @@ -0,0 +1,10 @@ +POST /v1/account/tokens/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "phone": "+12065550100" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-rest/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..3811b6a523 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-phone-verification.md @@ -0,0 +1,8 @@ +POST /v1/account/verification/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-recovery.md b/docs/examples/1.6.x/server-rest/examples/account/create-recovery.md new file mode 100644 index 0000000000..f8f0a9cdd6 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-recovery.md @@ -0,0 +1,12 @@ +POST /v1/account/recovery HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "email": "email@example.com", + "url": "https://example.com" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-session.md b/docs/examples/1.6.x/server-rest/examples/account/create-session.md new file mode 100644 index 0000000000..2a9108c0f4 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-session.md @@ -0,0 +1,10 @@ +POST /v1/account/sessions/token HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-verification.md b/docs/examples/1.6.x/server-rest/examples/account/create-verification.md new file mode 100644 index 0000000000..7582b81d01 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create-verification.md @@ -0,0 +1,11 @@ +POST /v1/account/verification HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "url": "https://example.com" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create.md b/docs/examples/1.6.x/server-rest/examples/account/create.md new file mode 100644 index 0000000000..ec4b11df00 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/create.md @@ -0,0 +1,12 @@ +POST /v1/account HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": , + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/delete-identity.md b/docs/examples/1.6.x/server-rest/examples/account/delete-identity.md new file mode 100644 index 0000000000..01df4d7e90 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/delete-identity.md @@ -0,0 +1,8 @@ +DELETE /v1/account/identities/{identityId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-rest/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..25b1733019 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,8 @@ +DELETE /v1/account/mfa/authenticators/{type} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/delete-session.md b/docs/examples/1.6.x/server-rest/examples/account/delete-session.md new file mode 100644 index 0000000000..f8d4c0035f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/delete-session.md @@ -0,0 +1,8 @@ +DELETE /v1/account/sessions/{sessionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-rest/examples/account/delete-sessions.md new file mode 100644 index 0000000000..1e9d00b1ca --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/delete-sessions.md @@ -0,0 +1,8 @@ +DELETE /v1/account/sessions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..cb27036775 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,8 @@ +GET /v1/account/mfa/recovery-codes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/get-prefs.md b/docs/examples/1.6.x/server-rest/examples/account/get-prefs.md new file mode 100644 index 0000000000..c0513aa8b6 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/get-prefs.md @@ -0,0 +1,8 @@ +GET /v1/account/prefs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/get-session.md b/docs/examples/1.6.x/server-rest/examples/account/get-session.md new file mode 100644 index 0000000000..64950545ec --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/get-session.md @@ -0,0 +1,8 @@ +GET /v1/account/sessions/{sessionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/get.md b/docs/examples/1.6.x/server-rest/examples/account/get.md new file mode 100644 index 0000000000..40841841e5 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/get.md @@ -0,0 +1,8 @@ +GET /v1/account HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/list-identities.md b/docs/examples/1.6.x/server-rest/examples/account/list-identities.md new file mode 100644 index 0000000000..2ea442b347 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/list-identities.md @@ -0,0 +1,8 @@ +GET /v1/account/identities HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/list-logs.md b/docs/examples/1.6.x/server-rest/examples/account/list-logs.md new file mode 100644 index 0000000000..9d1589e9a2 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/list-logs.md @@ -0,0 +1,8 @@ +GET /v1/account/logs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-rest/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..5b12a4948a --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/list-mfa-factors.md @@ -0,0 +1,8 @@ +GET /v1/account/mfa/factors HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/list-sessions.md b/docs/examples/1.6.x/server-rest/examples/account/list-sessions.md new file mode 100644 index 0000000000..39ee92bb20 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/list-sessions.md @@ -0,0 +1,8 @@ +GET /v1/account/sessions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-email.md b/docs/examples/1.6.x/server-rest/examples/account/update-email.md new file mode 100644 index 0000000000..4c9723d856 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-email.md @@ -0,0 +1,12 @@ +PATCH /v1/account/email HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "email": "email@example.com", + "password": "password" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-rest/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..668cc887a0 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-m-f-a.md @@ -0,0 +1,11 @@ +PATCH /v1/account/mfa HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "mfa": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-rest/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..b568b35c55 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,10 @@ +PUT /v1/account/sessions/magic-url HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-rest/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..3048091fb7 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-mfa-authenticator.md @@ -0,0 +1,11 @@ +PUT /v1/account/mfa/authenticators/{type} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "otp": "<OTP>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-rest/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..33d5fe45d5 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-mfa-challenge.md @@ -0,0 +1,12 @@ +PUT /v1/account/mfa/challenge HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "challengeId": "<CHALLENGE_ID>", + "otp": "<OTP>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..353908edcf --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,8 @@ +PATCH /v1/account/mfa/recovery-codes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-name.md b/docs/examples/1.6.x/server-rest/examples/account/update-name.md new file mode 100644 index 0000000000..43d100c8f5 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-name.md @@ -0,0 +1,11 @@ +PATCH /v1/account/name HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-password.md b/docs/examples/1.6.x/server-rest/examples/account/update-password.md new file mode 100644 index 0000000000..e35d9a8c76 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-password.md @@ -0,0 +1,12 @@ +PATCH /v1/account/password HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "password": , + "oldPassword": "password" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-rest/examples/account/update-phone-session.md new file mode 100644 index 0000000000..540267f6d8 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-phone-session.md @@ -0,0 +1,10 @@ +PUT /v1/account/sessions/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-rest/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..301f0b1057 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-phone-verification.md @@ -0,0 +1,12 @@ +PUT /v1/account/verification/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-phone.md b/docs/examples/1.6.x/server-rest/examples/account/update-phone.md new file mode 100644 index 0000000000..ea35a1b8ca --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-phone.md @@ -0,0 +1,12 @@ +PATCH /v1/account/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "phone": "+12065550100", + "password": "password" +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-prefs.md b/docs/examples/1.6.x/server-rest/examples/account/update-prefs.md new file mode 100644 index 0000000000..87af8ec625 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-prefs.md @@ -0,0 +1,11 @@ +PATCH /v1/account/prefs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "prefs": {} +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-recovery.md b/docs/examples/1.6.x/server-rest/examples/account/update-recovery.md new file mode 100644 index 0000000000..77ae28a33d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-recovery.md @@ -0,0 +1,13 @@ +PUT /v1/account/recovery HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>", + "password": +} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-session.md b/docs/examples/1.6.x/server-rest/examples/account/update-session.md new file mode 100644 index 0000000000..d8a7b97f3c --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-session.md @@ -0,0 +1,8 @@ +PATCH /v1/account/sessions/{sessionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-status.md b/docs/examples/1.6.x/server-rest/examples/account/update-status.md new file mode 100644 index 0000000000..b10060a866 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-status.md @@ -0,0 +1,8 @@ +PATCH /v1/account/status HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-verification.md b/docs/examples/1.6.x/server-rest/examples/account/update-verification.md new file mode 100644 index 0000000000..cd6c2f9e88 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/account/update-verification.md @@ -0,0 +1,12 @@ +PUT /v1/account/verification HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-browser.md new file mode 100644 index 0000000000..b7861af9e8 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/avatars/get-browser.md @@ -0,0 +1,9 @@ +GET /v1/avatars/browsers/{code} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..c01974a5ff --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/avatars/get-credit-card.md @@ -0,0 +1,9 @@ +GET /v1/avatars/credit-cards/{code} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..377d021965 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/avatars/get-favicon.md @@ -0,0 +1,9 @@ +GET /v1/avatars/favicon HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-flag.md new file mode 100644 index 0000000000..3034220d31 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/avatars/get-flag.md @@ -0,0 +1,9 @@ +GET /v1/avatars/flags/{code} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-image.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-image.md new file mode 100644 index 0000000000..fb34b92df4 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/avatars/get-image.md @@ -0,0 +1,9 @@ +GET /v1/avatars/image HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-initials.md new file mode 100644 index 0000000000..c1e5cd066d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/avatars/get-initials.md @@ -0,0 +1,9 @@ +GET /v1/avatars/initials HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..05add56280 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/avatars/get-q-r.md @@ -0,0 +1,9 @@ +GET /v1/avatars/qr HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..c2d3a05eff --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-boolean-attribute.md @@ -0,0 +1,13 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": , + "required": false, + "default": false, + "array": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-collection.md b/docs/examples/1.6.x/server-rest/examples/databases/create-collection.md new file mode 100644 index 0000000000..2ceb00c67d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-collection.md @@ -0,0 +1,14 @@ +POST /v1/databases/{databaseId}/collections HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "collectionId": "<COLLECTION_ID>", + "name": "<NAME>", + "permissions": ["read(\"any\")"], + "documentSecurity": false, + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..8b717bb08b --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-datetime-attribute.md @@ -0,0 +1,13 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": , + "required": false, + "default": , + "array": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-document.md b/docs/examples/1.6.x/server-rest/examples/databases/create-document.md new file mode 100644 index 0000000000..e61a3deff2 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-document.md @@ -0,0 +1,14 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + +{ + "documentId": "<DOCUMENT_ID>", + "data": {}, + "permissions": ["read(\"any\")"] +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..8b7dc1cc28 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-email-attribute.md @@ -0,0 +1,13 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/email HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": , + "required": false, + "default": "email@example.com", + "array": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..3eb3c084c2 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-enum-attribute.md @@ -0,0 +1,14 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": , + "elements": [], + "required": false, + "default": "<DEFAULT>", + "array": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..a688549b0f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-float-attribute.md @@ -0,0 +1,15 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/float HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": , + "required": false, + "min": 0, + "max": 0, + "default": 0, + "array": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-index.md b/docs/examples/1.6.x/server-rest/examples/databases/create-index.md new file mode 100644 index 0000000000..c02336035a --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-index.md @@ -0,0 +1,13 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": , + "type": "key", + "attributes": [], + "orders": [] +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..f21710018f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-integer-attribute.md @@ -0,0 +1,15 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": , + "required": false, + "min": 0, + "max": 0, + "default": 0, + "array": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..a89d13e390 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-ip-attribute.md @@ -0,0 +1,13 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": , + "required": false, + "default": , + "array": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..fa14ee33bb --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-relationship-attribute.md @@ -0,0 +1,15 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/relationship HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "relatedCollectionId": "<RELATED_COLLECTION_ID>", + "type": "oneToOne", + "twoWay": false, + "key": , + "twoWayKey": , + "onDelete": "cascade" +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..b14825e1f8 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-string-attribute.md @@ -0,0 +1,15 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/string HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": , + "size": 1, + "required": false, + "default": "<DEFAULT>", + "array": false, + "encrypt": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..c40e70f8b1 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create-url-attribute.md @@ -0,0 +1,13 @@ +POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/url HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": , + "required": false, + "default": "https://example.com", + "array": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create.md b/docs/examples/1.6.x/server-rest/examples/databases/create.md new file mode 100644 index 0000000000..6a4954f0ad --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/create.md @@ -0,0 +1,12 @@ +POST /v1/databases HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "databaseId": "<DATABASE_ID>", + "name": "<NAME>", + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..7980c1c3f5 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/delete-attribute.md @@ -0,0 +1,7 @@ +DELETE /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-rest/examples/databases/delete-collection.md new file mode 100644 index 0000000000..4c78160192 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/delete-collection.md @@ -0,0 +1,7 @@ +DELETE /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/delete-document.md b/docs/examples/1.6.x/server-rest/examples/databases/delete-document.md new file mode 100644 index 0000000000..5f7e3ffef5 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/delete-document.md @@ -0,0 +1,9 @@ +DELETE /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/delete-index.md b/docs/examples/1.6.x/server-rest/examples/databases/delete-index.md new file mode 100644 index 0000000000..5c41baf57d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/delete-index.md @@ -0,0 +1,7 @@ +DELETE /v1/databases/{databaseId}/collections/{collectionId}/indexes/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/delete.md b/docs/examples/1.6.x/server-rest/examples/databases/delete.md new file mode 100644 index 0000000000..d9557c1192 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/delete.md @@ -0,0 +1,7 @@ +DELETE /v1/databases/{databaseId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/get-attribute.md new file mode 100644 index 0000000000..416ed42a88 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/get-attribute.md @@ -0,0 +1,7 @@ +GET /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/get-collection.md b/docs/examples/1.6.x/server-rest/examples/databases/get-collection.md new file mode 100644 index 0000000000..54b6b60dfa --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/get-collection.md @@ -0,0 +1,7 @@ +GET /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/get-document.md b/docs/examples/1.6.x/server-rest/examples/databases/get-document.md new file mode 100644 index 0000000000..ff9950ba08 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/get-document.md @@ -0,0 +1,9 @@ +GET /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/get-index.md b/docs/examples/1.6.x/server-rest/examples/databases/get-index.md new file mode 100644 index 0000000000..4170437cf3 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/get-index.md @@ -0,0 +1,7 @@ +GET /v1/databases/{databaseId}/collections/{collectionId}/indexes/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/get.md b/docs/examples/1.6.x/server-rest/examples/databases/get.md new file mode 100644 index 0000000000..d946abbc85 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/get.md @@ -0,0 +1,7 @@ +GET /v1/databases/{databaseId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-rest/examples/databases/list-attributes.md new file mode 100644 index 0000000000..01d8f71e8b --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/list-attributes.md @@ -0,0 +1,7 @@ +GET /v1/databases/{databaseId}/collections/{collectionId}/attributes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/list-collections.md b/docs/examples/1.6.x/server-rest/examples/databases/list-collections.md new file mode 100644 index 0000000000..1ce2e5339d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/list-collections.md @@ -0,0 +1,7 @@ +GET /v1/databases/{databaseId}/collections HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/list-documents.md b/docs/examples/1.6.x/server-rest/examples/databases/list-documents.md new file mode 100644 index 0000000000..f57d5f243c --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/list-documents.md @@ -0,0 +1,9 @@ +GET /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-rest/examples/databases/list-indexes.md new file mode 100644 index 0000000000..57a45b513a --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/list-indexes.md @@ -0,0 +1,7 @@ +GET /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/list.md b/docs/examples/1.6.x/server-rest/examples/databases/list.md new file mode 100644 index 0000000000..715b7f3f1d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/list.md @@ -0,0 +1,7 @@ +GET /v1/databases HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..2a2acc1df8 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-boolean-attribute.md @@ -0,0 +1,11 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-collection.md b/docs/examples/1.6.x/server-rest/examples/databases/update-collection.md new file mode 100644 index 0000000000..fdaf7e65bd --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-collection.md @@ -0,0 +1,13 @@ +PUT /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "permissions": ["read(\"any\")"], + "documentSecurity": false, + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..3bff0cf1a6 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-datetime-attribute.md @@ -0,0 +1,11 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-document.md b/docs/examples/1.6.x/server-rest/examples/databases/update-document.md new file mode 100644 index 0000000000..d27465c556 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-document.md @@ -0,0 +1,13 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + +{ + "data": {}, + "permissions": ["read(\"any\")"] +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..8e13c9222f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-email-attribute.md @@ -0,0 +1,11 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/email/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "email@example.com" +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..ee3baf5c85 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-enum-attribute.md @@ -0,0 +1,12 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "elements": [], + "required": false, + "default": "<DEFAULT>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..871eaf1ab8 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-float-attribute.md @@ -0,0 +1,13 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/float/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "min": 0, + "max": 0, + "default": 0 +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..0673c67e3a --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-integer-attribute.md @@ -0,0 +1,13 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "min": 0, + "max": 0, + "default": 0 +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..dc60998b6d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-ip-attribute.md @@ -0,0 +1,11 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..f7aaa6ca1b --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-relationship-attribute.md @@ -0,0 +1,10 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "onDelete": "cascade" +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..fd6ae0b8f8 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-string-attribute.md @@ -0,0 +1,11 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/string/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "<DEFAULT>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..b677970863 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update-url-attribute.md @@ -0,0 +1,11 @@ +PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/url/{key} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "required": false, + "default": "https://example.com" +} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update.md b/docs/examples/1.6.x/server-rest/examples/databases/update.md new file mode 100644 index 0000000000..0fae967e7b --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/databases/update.md @@ -0,0 +1,11 @@ +PUT /v1/databases/{databaseId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/create-build.md b/docs/examples/1.6.x/server-rest/examples/functions/create-build.md new file mode 100644 index 0000000000..584609d1da --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/create-build.md @@ -0,0 +1,10 @@ +POST /v1/functions/{functionId}/deployments/{deploymentId}/build HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "buildId": "<BUILD_ID>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-rest/examples/functions/create-deployment.md new file mode 100644 index 0000000000..b822c3245c --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/create-deployment.md @@ -0,0 +1,30 @@ +POST /v1/functions/{functionId}/deployments HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> +Content-Length: *Length of your entity body in bytes* + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="entrypoint" + +"<ENTRYPOINT>" + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="commands" + +"<COMMANDS>" + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="code" + +cf 94 84 24 8d c4 91 10 0f dc 54 26 6c 8e 4b bc +e8 ee 55 94 29 e7 94 89 19 26 28 01 26 29 3f 16... + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="activate" + +false + +--cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/server-rest/examples/functions/create-execution.md b/docs/examples/1.6.x/server-rest/examples/functions/create-execution.md new file mode 100644 index 0000000000..594eed59b4 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/create-execution.md @@ -0,0 +1,17 @@ +POST /v1/functions/{functionId}/executions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + +{ + "body": "<BODY>", + "async": false, + "path": "<PATH>", + "method": "GET", + "headers": {}, + "scheduledAt": +} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/create-variable.md b/docs/examples/1.6.x/server-rest/examples/functions/create-variable.md new file mode 100644 index 0000000000..511efbeb5a --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/create-variable.md @@ -0,0 +1,11 @@ +POST /v1/functions/{functionId}/variables HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "<KEY>", + "value": "<VALUE>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/create.md b/docs/examples/1.6.x/server-rest/examples/functions/create.md new file mode 100644 index 0000000000..89addac4fb --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/create.md @@ -0,0 +1,30 @@ +POST /v1/functions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "functionId": "<FUNCTION_ID>", + "name": "<NAME>", + "runtime": "node-14.5", + "execute": ["any"], + "events": [], + "schedule": , + "timeout": 1, + "enabled": false, + "logging": false, + "entrypoint": "<ENTRYPOINT>", + "commands": "<COMMANDS>", + "scopes": [], + "installationId": "<INSTALLATION_ID>", + "providerRepositoryId": "<PROVIDER_REPOSITORY_ID>", + "providerBranch": "<PROVIDER_BRANCH>", + "providerSilentMode": false, + "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>", + "templateRepository": "<TEMPLATE_REPOSITORY>", + "templateOwner": "<TEMPLATE_OWNER>", + "templateRootDirectory": "<TEMPLATE_ROOT_DIRECTORY>", + "templateBranch": "<TEMPLATE_BRANCH>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-rest/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..1d80de488f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/delete-deployment.md @@ -0,0 +1,7 @@ +DELETE /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-rest/examples/functions/delete-execution.md new file mode 100644 index 0000000000..bc34b12e9a --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/delete-execution.md @@ -0,0 +1,7 @@ +DELETE /v1/functions/{functionId}/executions/{executionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-rest/examples/functions/delete-variable.md new file mode 100644 index 0000000000..a9ec4ecde1 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/delete-variable.md @@ -0,0 +1,7 @@ +DELETE /v1/functions/{functionId}/variables/{variableId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/delete.md b/docs/examples/1.6.x/server-rest/examples/functions/delete.md new file mode 100644 index 0000000000..9916ab6016 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/delete.md @@ -0,0 +1,7 @@ +DELETE /v1/functions/{functionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-rest/examples/functions/download-deployment.md new file mode 100644 index 0000000000..3bcb92b0e4 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/download-deployment.md @@ -0,0 +1,7 @@ +GET /v1/functions/{functionId}/deployments/{deploymentId}/download HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-rest/examples/functions/get-deployment.md new file mode 100644 index 0000000000..882a5ec659 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/get-deployment.md @@ -0,0 +1,7 @@ +GET /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/get-execution.md b/docs/examples/1.6.x/server-rest/examples/functions/get-execution.md new file mode 100644 index 0000000000..a14c896a6f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/get-execution.md @@ -0,0 +1,9 @@ +GET /v1/functions/{functionId}/executions/{executionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/get-variable.md b/docs/examples/1.6.x/server-rest/examples/functions/get-variable.md new file mode 100644 index 0000000000..435de87d1d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/get-variable.md @@ -0,0 +1,7 @@ +GET /v1/functions/{functionId}/variables/{variableId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/get.md b/docs/examples/1.6.x/server-rest/examples/functions/get.md new file mode 100644 index 0000000000..6a763ec557 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/get.md @@ -0,0 +1,7 @@ +GET /v1/functions/{functionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-rest/examples/functions/list-deployments.md new file mode 100644 index 0000000000..32d813313c --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/list-deployments.md @@ -0,0 +1,7 @@ +GET /v1/functions/{functionId}/deployments HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/list-executions.md b/docs/examples/1.6.x/server-rest/examples/functions/list-executions.md new file mode 100644 index 0000000000..e2d75d27c0 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/list-executions.md @@ -0,0 +1,9 @@ +GET /v1/functions/{functionId}/executions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-rest/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..358bcedfcd --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/list-runtimes.md @@ -0,0 +1,7 @@ +GET /v1/functions/runtimes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/list-variables.md b/docs/examples/1.6.x/server-rest/examples/functions/list-variables.md new file mode 100644 index 0000000000..48fb392980 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/list-variables.md @@ -0,0 +1,7 @@ +GET /v1/functions/{functionId}/variables HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/list.md b/docs/examples/1.6.x/server-rest/examples/functions/list.md new file mode 100644 index 0000000000..a8cb40e2f3 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/list.md @@ -0,0 +1,7 @@ +GET /v1/functions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-rest/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..740c04b91e --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/update-deployment-build.md @@ -0,0 +1,7 @@ +PATCH /v1/functions/{functionId}/deployments/{deploymentId}/build HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-rest/examples/functions/update-deployment.md new file mode 100644 index 0000000000..a644913d94 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/update-deployment.md @@ -0,0 +1,7 @@ +PATCH /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/functions/update-variable.md b/docs/examples/1.6.x/server-rest/examples/functions/update-variable.md new file mode 100644 index 0000000000..0fdd3ac5f5 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/update-variable.md @@ -0,0 +1,11 @@ +PUT /v1/functions/{functionId}/variables/{variableId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "key": "<KEY>", + "value": "<VALUE>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/update.md b/docs/examples/1.6.x/server-rest/examples/functions/update.md new file mode 100644 index 0000000000..c74161a96c --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/functions/update.md @@ -0,0 +1,25 @@ +PUT /v1/functions/{functionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "runtime": "node-14.5", + "execute": ["any"], + "events": [], + "schedule": , + "timeout": 1, + "enabled": false, + "logging": false, + "entrypoint": "<ENTRYPOINT>", + "commands": "<COMMANDS>", + "scopes": [], + "installationId": "<INSTALLATION_ID>", + "providerRepositoryId": "<PROVIDER_REPOSITORY_ID>", + "providerBranch": "<PROVIDER_BRANCH>", + "providerSilentMode": false, + "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/graphql/mutation.md b/docs/examples/1.6.x/server-rest/examples/graphql/mutation.md new file mode 100644 index 0000000000..7e367323ae --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/graphql/mutation.md @@ -0,0 +1,13 @@ +POST /v1/graphql/mutation HTTP/1.1 +Host: cloud.appwrite.io +X-Sdk-Graphql: true +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "query": {} +} diff --git a/docs/examples/1.6.x/server-rest/examples/graphql/query.md b/docs/examples/1.6.x/server-rest/examples/graphql/query.md new file mode 100644 index 0000000000..2b7f32fd94 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/graphql/query.md @@ -0,0 +1,13 @@ +POST /v1/graphql HTTP/1.1 +Host: cloud.appwrite.io +X-Sdk-Graphql: true +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "query": {} +} diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-rest/examples/health/get-antivirus.md new file mode 100644 index 0000000000..4210461968 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-antivirus.md @@ -0,0 +1,7 @@ +GET /v1/health/anti-virus HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-cache.md b/docs/examples/1.6.x/server-rest/examples/health/get-cache.md new file mode 100644 index 0000000000..b0a322f80f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-cache.md @@ -0,0 +1,7 @@ +GET /v1/health/cache HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-certificate.md b/docs/examples/1.6.x/server-rest/examples/health/get-certificate.md new file mode 100644 index 0000000000..f183ecb555 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-certificate.md @@ -0,0 +1,7 @@ +GET /v1/health/certificate HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-d-b.md b/docs/examples/1.6.x/server-rest/examples/health/get-d-b.md new file mode 100644 index 0000000000..2685c7e230 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-d-b.md @@ -0,0 +1,7 @@ +GET /v1/health/db HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-rest/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..16fd22f6a5 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-failed-jobs.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/failed/{name} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-rest/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..336531207e --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-pub-sub.md @@ -0,0 +1,7 @@ +GET /v1/health/pubsub HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..bed1e14fc8 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-builds.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/builds HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..a4f9247248 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-certificates.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/certificates HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..ef7e9b66ce --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-databases.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/databases HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..9a43c99bf3 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-deletes.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/deletes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..acef066f4a --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-functions.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/functions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..bb5126e7c3 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-logs.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/logs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..ea8f161582 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-mails.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/mails HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..74cea8d67e --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-messaging.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/messaging HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..e7728d8353 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-migrations.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/migrations HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..2a9680055e --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage-dump.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/usage-dump HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..e7cb93391f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/usage HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..dbb10191f7 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue-webhooks.md @@ -0,0 +1,7 @@ +GET /v1/health/queue/webhooks HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue.md new file mode 100644 index 0000000000..d0109a6b2c --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-queue.md @@ -0,0 +1,7 @@ +GET /v1/health/queue HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-rest/examples/health/get-storage-local.md new file mode 100644 index 0000000000..d7bc8237d9 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-storage-local.md @@ -0,0 +1,7 @@ +GET /v1/health/storage/local HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-storage.md b/docs/examples/1.6.x/server-rest/examples/health/get-storage.md new file mode 100644 index 0000000000..b2f8bfee26 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-storage.md @@ -0,0 +1,7 @@ +GET /v1/health/storage HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-time.md b/docs/examples/1.6.x/server-rest/examples/health/get-time.md new file mode 100644 index 0000000000..fa9b52bef0 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get-time.md @@ -0,0 +1,7 @@ +GET /v1/health/time HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/health/get.md b/docs/examples/1.6.x/server-rest/examples/health/get.md new file mode 100644 index 0000000000..08e20d1a08 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/health/get.md @@ -0,0 +1,7 @@ +GET /v1/health HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/locale/get.md b/docs/examples/1.6.x/server-rest/examples/locale/get.md new file mode 100644 index 0000000000..c9dbe68a31 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/locale/get.md @@ -0,0 +1,9 @@ +GET /v1/locale HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-codes.md b/docs/examples/1.6.x/server-rest/examples/locale/list-codes.md new file mode 100644 index 0000000000..8d0d871db4 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/locale/list-codes.md @@ -0,0 +1,9 @@ +GET /v1/locale/codes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-continents.md b/docs/examples/1.6.x/server-rest/examples/locale/list-continents.md new file mode 100644 index 0000000000..8b9799de34 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/locale/list-continents.md @@ -0,0 +1,9 @@ +GET /v1/locale/continents HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-rest/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..3a121207ac --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/locale/list-countries-e-u.md @@ -0,0 +1,9 @@ +GET /v1/locale/countries/eu HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-rest/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..1eae458ee3 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/locale/list-countries-phones.md @@ -0,0 +1,9 @@ +GET /v1/locale/countries/phones HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-countries.md b/docs/examples/1.6.x/server-rest/examples/locale/list-countries.md new file mode 100644 index 0000000000..5ea5cd4ac0 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/locale/list-countries.md @@ -0,0 +1,9 @@ +GET /v1/locale/countries HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-rest/examples/locale/list-currencies.md new file mode 100644 index 0000000000..cf387187b2 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/locale/list-currencies.md @@ -0,0 +1,9 @@ +GET /v1/locale/currencies HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-languages.md b/docs/examples/1.6.x/server-rest/examples/locale/list-languages.md new file mode 100644 index 0000000000..b0d4d680a1 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/locale/list-languages.md @@ -0,0 +1,9 @@ +GET /v1/locale/languages HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..bcbf1be099 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-apns-provider.md @@ -0,0 +1,17 @@ +POST /v1/messaging/providers/apns HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "authKey": "<AUTH_KEY>", + "authKeyId": "<AUTH_KEY_ID>", + "teamId": "<TEAM_ID>", + "bundleId": "<BUNDLE_ID>", + "sandbox": false, + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-email.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-email.md new file mode 100644 index 0000000000..49b34ce5dd --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-email.md @@ -0,0 +1,21 @@ +POST /v1/messaging/messages/email HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "messageId": "<MESSAGE_ID>", + "subject": "<SUBJECT>", + "content": "<CONTENT>", + "topics": [], + "users": [], + "targets": [], + "cc": [], + "bcc": [], + "attachments": [], + "draft": false, + "html": false, + "scheduledAt": +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..75355675c6 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-fcm-provider.md @@ -0,0 +1,13 @@ +POST /v1/messaging/providers/fcm HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "serviceAccountJSON": {}, + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..2516714a65 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,19 @@ +POST /v1/messaging/providers/mailgun HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "apiKey": "<API_KEY>", + "domain": "<DOMAIN>", + "isEuRegion": false, + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "email@example.com", + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..776568c2e1 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-msg91provider.md @@ -0,0 +1,15 @@ +POST /v1/messaging/providers/msg91 HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "templateId": "<TEMPLATE_ID>", + "senderId": "<SENDER_ID>", + "authKey": "<AUTH_KEY>", + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-push.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-push.md new file mode 100644 index 0000000000..cb95ab984d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-push.md @@ -0,0 +1,25 @@ +POST /v1/messaging/messages/push HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "messageId": "<MESSAGE_ID>", + "title": "<TITLE>", + "body": "<BODY>", + "topics": [], + "users": [], + "targets": [], + "data": {}, + "action": "<ACTION>", + "image": "[ID1:ID2]", + "icon": "<ICON>", + "sound": "<SOUND>", + "color": "<COLOR>", + "tag": "<TAG>", + "badge": "<BADGE>", + "draft": false, + "scheduledAt": +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..4ff66b4248 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,17 @@ +POST /v1/messaging/providers/sendgrid HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "apiKey": "<API_KEY>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "email@example.com", + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-sms.md new file mode 100644 index 0000000000..3549a2c8ce --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-sms.md @@ -0,0 +1,16 @@ +POST /v1/messaging/messages/sms HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "messageId": "<MESSAGE_ID>", + "content": "<CONTENT>", + "topics": [], + "users": [], + "targets": [], + "draft": false, + "scheduledAt": +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..35c3753cd6 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-smtp-provider.md @@ -0,0 +1,23 @@ +POST /v1/messaging/providers/smtp HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "host": "<HOST>", + "port": 1, + "username": "<USERNAME>", + "password": "<PASSWORD>", + "encryption": "none", + "autoTLS": false, + "mailer": "<MAILER>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "email@example.com", + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..fc88e3c12d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-subscriber.md @@ -0,0 +1,13 @@ +POST /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-JWT: <YOUR_JWT> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "subscriberId": "<SUBSCRIBER_ID>", + "targetId": "<TARGET_ID>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..57d1d0ebd6 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-telesign-provider.md @@ -0,0 +1,15 @@ +POST /v1/messaging/providers/telesign HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "from": "+12065550100", + "customerId": "<CUSTOMER_ID>", + "apiKey": "<API_KEY>", + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..b7b830601f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,15 @@ +POST /v1/messaging/providers/textmagic HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "from": "+12065550100", + "username": "<USERNAME>", + "apiKey": "<API_KEY>", + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-topic.md new file mode 100644 index 0000000000..a805ac5951 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-topic.md @@ -0,0 +1,12 @@ +POST /v1/messaging/topics HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "topicId": "<TOPIC_ID>", + "name": "<NAME>", + "subscribe": ["any"] +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..b0d8dbe432 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-twilio-provider.md @@ -0,0 +1,15 @@ +POST /v1/messaging/providers/twilio HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "from": "+12065550100", + "accountSid": "<ACCOUNT_SID>", + "authToken": "<AUTH_TOKEN>", + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..0366560f2b --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/create-vonage-provider.md @@ -0,0 +1,15 @@ +POST /v1/messaging/providers/vonage HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "providerId": "<PROVIDER_ID>", + "name": "<NAME>", + "from": "+12065550100", + "apiKey": "<API_KEY>", + "apiSecret": "<API_SECRET>", + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..138eddcde4 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/delete-provider.md @@ -0,0 +1,7 @@ +DELETE /v1/messaging/providers/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-rest/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..bbaa568a5c --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/delete-subscriber.md @@ -0,0 +1,9 @@ +DELETE /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-JWT: <YOUR_JWT> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-rest/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..a3faad27a2 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/delete-topic.md @@ -0,0 +1,7 @@ +DELETE /v1/messaging/topics/{topicId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/delete.md b/docs/examples/1.6.x/server-rest/examples/messaging/delete.md new file mode 100644 index 0000000000..84997d4be9 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/delete.md @@ -0,0 +1,7 @@ +DELETE /v1/messaging/messages/{messageId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/get-message.md b/docs/examples/1.6.x/server-rest/examples/messaging/get-message.md new file mode 100644 index 0000000000..f64f9d1a7d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/get-message.md @@ -0,0 +1,7 @@ +GET /v1/messaging/messages/{messageId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/get-provider.md new file mode 100644 index 0000000000..499fb6f685 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/get-provider.md @@ -0,0 +1,7 @@ +GET /v1/messaging/providers/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-rest/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..25922d4792 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/get-subscriber.md @@ -0,0 +1,7 @@ +GET /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-rest/examples/messaging/get-topic.md new file mode 100644 index 0000000000..9eba673740 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/get-topic.md @@ -0,0 +1,7 @@ +GET /v1/messaging/topics/{topicId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..f9caa0bc3a --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/list-message-logs.md @@ -0,0 +1,7 @@ +GET /v1/messaging/messages/{messageId}/logs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-messages.md new file mode 100644 index 0000000000..509a029b2c --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/list-messages.md @@ -0,0 +1,7 @@ +GET /v1/messaging/messages HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..b083fc766f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/list-provider-logs.md @@ -0,0 +1,7 @@ +GET /v1/messaging/providers/{providerId}/logs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-providers.md new file mode 100644 index 0000000000..214b31bc8d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/list-providers.md @@ -0,0 +1,7 @@ +GET /v1/messaging/providers HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..ddbc4f6aa5 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,7 @@ +GET /v1/messaging/subscribers/{subscriberId}/logs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..eefcfff199 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/list-subscribers.md @@ -0,0 +1,7 @@ +GET /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-targets.md new file mode 100644 index 0000000000..c8bb1791e3 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/list-targets.md @@ -0,0 +1,7 @@ +GET /v1/messaging/messages/{messageId}/targets HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..3225bde3ce --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/list-topic-logs.md @@ -0,0 +1,7 @@ +GET /v1/messaging/topics/{topicId}/logs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-topics.md new file mode 100644 index 0000000000..f752e77c47 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/list-topics.md @@ -0,0 +1,7 @@ +GET /v1/messaging/topics HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..f26ee35f70 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-apns-provider.md @@ -0,0 +1,16 @@ +PATCH /v1/messaging/providers/apns/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "authKey": "<AUTH_KEY>", + "authKeyId": "<AUTH_KEY_ID>", + "teamId": "<TEAM_ID>", + "bundleId": "<BUNDLE_ID>", + "sandbox": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-email.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-email.md new file mode 100644 index 0000000000..22d169c354 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-email.md @@ -0,0 +1,20 @@ +PATCH /v1/messaging/messages/email/{messageId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "topics": [], + "users": [], + "targets": [], + "subject": "<SUBJECT>", + "content": "<CONTENT>", + "draft": false, + "html": false, + "cc": [], + "bcc": [], + "scheduledAt": , + "attachments": [] +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..d6802ba1ce --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-fcm-provider.md @@ -0,0 +1,12 @@ +PATCH /v1/messaging/providers/fcm/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "serviceAccountJSON": {} +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..818ad01ae3 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,18 @@ +PATCH /v1/messaging/providers/mailgun/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "apiKey": "<API_KEY>", + "domain": "<DOMAIN>", + "isEuRegion": false, + "enabled": false, + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "<REPLY_TO_EMAIL>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..721a590602 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-msg91provider.md @@ -0,0 +1,14 @@ +PATCH /v1/messaging/providers/msg91/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "templateId": "<TEMPLATE_ID>", + "senderId": "<SENDER_ID>", + "authKey": "<AUTH_KEY>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-push.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-push.md new file mode 100644 index 0000000000..4bef5e902f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-push.md @@ -0,0 +1,24 @@ +PATCH /v1/messaging/messages/push/{messageId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "topics": [], + "users": [], + "targets": [], + "title": "<TITLE>", + "body": "<BODY>", + "data": {}, + "action": "<ACTION>", + "image": "[ID1:ID2]", + "icon": "<ICON>", + "sound": "<SOUND>", + "color": "<COLOR>", + "tag": "<TAG>", + "badge": 0, + "draft": false, + "scheduledAt": +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..3ca8af372e --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,16 @@ +PATCH /v1/messaging/providers/sendgrid/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "apiKey": "<API_KEY>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "<REPLY_TO_EMAIL>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-sms.md new file mode 100644 index 0000000000..08ac37f45b --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-sms.md @@ -0,0 +1,15 @@ +PATCH /v1/messaging/messages/sms/{messageId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "topics": [], + "users": [], + "targets": [], + "content": "<CONTENT>", + "draft": false, + "scheduledAt": +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..c37ff1027c --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-smtp-provider.md @@ -0,0 +1,22 @@ +PATCH /v1/messaging/providers/smtp/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "host": "<HOST>", + "port": 1, + "username": "<USERNAME>", + "password": "<PASSWORD>", + "encryption": "none", + "autoTLS": false, + "mailer": "<MAILER>", + "fromName": "<FROM_NAME>", + "fromEmail": "email@example.com", + "replyToName": "<REPLY_TO_NAME>", + "replyToEmail": "<REPLY_TO_EMAIL>", + "enabled": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..50b48fd655 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-telesign-provider.md @@ -0,0 +1,14 @@ +PATCH /v1/messaging/providers/telesign/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "customerId": "<CUSTOMER_ID>", + "apiKey": "<API_KEY>", + "from": "<FROM>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..f9692cc945 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,14 @@ +PATCH /v1/messaging/providers/textmagic/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "username": "<USERNAME>", + "apiKey": "<API_KEY>", + "from": "<FROM>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-topic.md new file mode 100644 index 0000000000..50fd57acd3 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-topic.md @@ -0,0 +1,11 @@ +PATCH /v1/messaging/topics/{topicId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "subscribe": ["any"] +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..78dbe9dcea --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-twilio-provider.md @@ -0,0 +1,14 @@ +PATCH /v1/messaging/providers/twilio/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "accountSid": "<ACCOUNT_SID>", + "authToken": "<AUTH_TOKEN>", + "from": "<FROM>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..cc17380616 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/messaging/update-vonage-provider.md @@ -0,0 +1,14 @@ +PATCH /v1/messaging/providers/vonage/{providerId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "enabled": false, + "apiKey": "<API_KEY>", + "apiSecret": "<API_SECRET>", + "from": "<FROM>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-rest/examples/storage/create-bucket.md new file mode 100644 index 0000000000..6c11c5f0c6 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/create-bucket.md @@ -0,0 +1,19 @@ +POST /v1/storage/buckets HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "bucketId": "<BUCKET_ID>", + "name": "<NAME>", + "permissions": ["read(\"any\")"], + "fileSecurity": false, + "enabled": false, + "maximumFileSize": 1, + "allowedFileExtensions": [], + "compression": "none", + "encryption": false, + "antivirus": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/storage/create-file.md b/docs/examples/1.6.x/server-rest/examples/storage/create-file.md new file mode 100644 index 0000000000..c93c525987 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/create-file.md @@ -0,0 +1,27 @@ +POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> +Content-Length: *Length of your entity body in bytes* + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="fileId" + +"<FILE_ID>" + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="file" + +cf 94 84 24 8d c4 91 10 0f dc 54 26 6c 8e 4b bc +e8 ee 55 94 29 e7 94 89 19 26 28 01 26 29 3f 16... + +--cec8e8123c05ba25 +Content-Disposition: form-data; name="permissions[]" + +["read(\"any\")"] + +--cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/server-rest/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-rest/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..51898e1078 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/delete-bucket.md @@ -0,0 +1,7 @@ +DELETE /v1/storage/buckets/{bucketId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/storage/delete-file.md b/docs/examples/1.6.x/server-rest/examples/storage/delete-file.md new file mode 100644 index 0000000000..f0c6cb1fc0 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/delete-file.md @@ -0,0 +1,9 @@ +DELETE /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-rest/examples/storage/get-bucket.md new file mode 100644 index 0000000000..b201700f17 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/get-bucket.md @@ -0,0 +1,7 @@ +GET /v1/storage/buckets/{bucketId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-rest/examples/storage/get-file-download.md new file mode 100644 index 0000000000..5559ffa32e --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/get-file-download.md @@ -0,0 +1,9 @@ +GET /v1/storage/buckets/{bucketId}/files/{fileId}/download HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-rest/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..dd25c4ca29 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/get-file-preview.md @@ -0,0 +1,9 @@ +GET /v1/storage/buckets/{bucketId}/files/{fileId}/preview HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-rest/examples/storage/get-file-view.md new file mode 100644 index 0000000000..4e08d2868b --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/get-file-view.md @@ -0,0 +1,9 @@ +GET /v1/storage/buckets/{bucketId}/files/{fileId}/view HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/storage/get-file.md b/docs/examples/1.6.x/server-rest/examples/storage/get-file.md new file mode 100644 index 0000000000..4f878588b1 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/get-file.md @@ -0,0 +1,9 @@ +GET /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-rest/examples/storage/list-buckets.md new file mode 100644 index 0000000000..337c39c4ae --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/list-buckets.md @@ -0,0 +1,7 @@ +GET /v1/storage/buckets HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/storage/list-files.md b/docs/examples/1.6.x/server-rest/examples/storage/list-files.md new file mode 100644 index 0000000000..0644b40320 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/list-files.md @@ -0,0 +1,9 @@ +GET /v1/storage/buckets/{bucketId}/files HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-rest/examples/storage/update-bucket.md new file mode 100644 index 0000000000..003d461901 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/update-bucket.md @@ -0,0 +1,18 @@ +PUT /v1/storage/buckets/{bucketId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>", + "permissions": ["read(\"any\")"], + "fileSecurity": false, + "enabled": false, + "maximumFileSize": 1, + "allowedFileExtensions": [], + "compression": "none", + "encryption": false, + "antivirus": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/storage/update-file.md b/docs/examples/1.6.x/server-rest/examples/storage/update-file.md new file mode 100644 index 0000000000..6ee412b647 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/storage/update-file.md @@ -0,0 +1,13 @@ +PUT /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + +{ + "name": "<NAME>", + "permissions": ["read(\"any\")"] +} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/create-membership.md b/docs/examples/1.6.x/server-rest/examples/teams/create-membership.md new file mode 100644 index 0000000000..6d5e8a3b48 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/create-membership.md @@ -0,0 +1,17 @@ +POST /v1/teams/{teamId}/memberships HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + +{ + "email": "email@example.com", + "userId": "<USER_ID>", + "phone": "+12065550100", + "roles": [], + "url": "https://example.com", + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/create.md b/docs/examples/1.6.x/server-rest/examples/teams/create.md new file mode 100644 index 0000000000..bc273cb35f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/create.md @@ -0,0 +1,14 @@ +POST /v1/teams HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + +{ + "teamId": "<TEAM_ID>", + "name": "<NAME>", + "roles": [] +} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-rest/examples/teams/delete-membership.md new file mode 100644 index 0000000000..32e5ed4177 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/delete-membership.md @@ -0,0 +1,9 @@ +DELETE /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/teams/delete.md b/docs/examples/1.6.x/server-rest/examples/teams/delete.md new file mode 100644 index 0000000000..8cf0c667a3 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/delete.md @@ -0,0 +1,9 @@ +DELETE /v1/teams/{teamId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/teams/get-membership.md b/docs/examples/1.6.x/server-rest/examples/teams/get-membership.md new file mode 100644 index 0000000000..40d0b5601e --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/get-membership.md @@ -0,0 +1,9 @@ +GET /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-rest/examples/teams/get-prefs.md new file mode 100644 index 0000000000..d143f6b904 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/get-prefs.md @@ -0,0 +1,8 @@ +GET /v1/teams/{teamId}/prefs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/teams/get.md b/docs/examples/1.6.x/server-rest/examples/teams/get.md new file mode 100644 index 0000000000..0ca3c655c5 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/get.md @@ -0,0 +1,9 @@ +GET /v1/teams/{teamId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-rest/examples/teams/list-memberships.md new file mode 100644 index 0000000000..39309d9c75 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/list-memberships.md @@ -0,0 +1,9 @@ +GET /v1/teams/{teamId}/memberships HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/teams/list.md b/docs/examples/1.6.x/server-rest/examples/teams/list.md new file mode 100644 index 0000000000..e02fb01ce3 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/list.md @@ -0,0 +1,9 @@ +GET /v1/teams HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + diff --git a/docs/examples/1.6.x/server-rest/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-rest/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..5cc6b91536 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/update-membership-status.md @@ -0,0 +1,12 @@ +PATCH /v1/teams/{teamId}/memberships/{membershipId}/status HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "userId": "<USER_ID>", + "secret": "<SECRET>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/update-membership.md b/docs/examples/1.6.x/server-rest/examples/teams/update-membership.md new file mode 100644 index 0000000000..cac7c16bdb --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/update-membership.md @@ -0,0 +1,12 @@ +PATCH /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + +{ + "roles": [] +} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/update-name.md b/docs/examples/1.6.x/server-rest/examples/teams/update-name.md new file mode 100644 index 0000000000..d36b3db779 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/update-name.md @@ -0,0 +1,12 @@ +PUT /v1/teams/{teamId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-Key: <YOUR_API_KEY> +X-Appwrite-JWT: <YOUR_JWT> + +{ + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-rest/examples/teams/update-prefs.md new file mode 100644 index 0000000000..d6b42128be --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/teams/update-prefs.md @@ -0,0 +1,11 @@ +PUT /v1/teams/{teamId}/prefs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Session: +X-Appwrite-JWT: <YOUR_JWT> + +{ + "prefs": {} +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-rest/examples/users/create-argon2user.md new file mode 100644 index 0000000000..f21a7661e4 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-argon2user.md @@ -0,0 +1,13 @@ +POST /v1/users/argon2 HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-rest/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..1f28133fb1 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-bcrypt-user.md @@ -0,0 +1,13 @@ +POST /v1/users/bcrypt HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-rest/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..7dc3943dfd --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-j-w-t.md @@ -0,0 +1,11 @@ +POST /v1/users/{userId}/jwts HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "sessionId": "<SESSION_ID>", + "duration": 0 +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-rest/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..e81ee952ad --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-m-d5user.md @@ -0,0 +1,13 @@ +POST /v1/users/md5 HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..39eb9ec6f8 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,7 @@ +PATCH /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-rest/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..cfbf131cc6 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-p-h-pass-user.md @@ -0,0 +1,13 @@ +POST /v1/users/phpass HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-rest/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..4d67231999 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-s-h-a-user.md @@ -0,0 +1,14 @@ +POST /v1/users/sha HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "passwordVersion": "sha1", + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..d81ba878b1 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,16 @@ +POST /v1/users/scrypt-modified HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "passwordSalt": "<PASSWORD_SALT>", + "passwordSaltSeparator": "<PASSWORD_SALT_SEPARATOR>", + "passwordSignerKey": "<PASSWORD_SIGNER_KEY>", + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..21dc205a30 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-user.md @@ -0,0 +1,18 @@ +POST /v1/users/scrypt HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "password": "password", + "passwordSalt": "<PASSWORD_SALT>", + "passwordCpu": 0, + "passwordMemory": 0, + "passwordParallel": 0, + "passwordLength": 0, + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-session.md b/docs/examples/1.6.x/server-rest/examples/users/create-session.md new file mode 100644 index 0000000000..61608c96b0 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-session.md @@ -0,0 +1,7 @@ +POST /v1/users/{userId}/sessions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-target.md b/docs/examples/1.6.x/server-rest/examples/users/create-target.md new file mode 100644 index 0000000000..13910ad39c --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-target.md @@ -0,0 +1,14 @@ +POST /v1/users/{userId}/targets HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "targetId": "<TARGET_ID>", + "providerType": "email", + "identifier": "<IDENTIFIER>", + "providerId": "<PROVIDER_ID>", + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-token.md b/docs/examples/1.6.x/server-rest/examples/users/create-token.md new file mode 100644 index 0000000000..90b96725b7 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create-token.md @@ -0,0 +1,11 @@ +POST /v1/users/{userId}/tokens HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "length": 4, + "expire": 60 +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create.md b/docs/examples/1.6.x/server-rest/examples/users/create.md new file mode 100644 index 0000000000..026bba49b3 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/create.md @@ -0,0 +1,14 @@ +POST /v1/users HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "userId": "<USER_ID>", + "email": "email@example.com", + "phone": "+12065550100", + "password": , + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete-identity.md b/docs/examples/1.6.x/server-rest/examples/users/delete-identity.md new file mode 100644 index 0000000000..eba9192b72 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/delete-identity.md @@ -0,0 +1,7 @@ +DELETE /v1/users/identities/{identityId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-rest/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..081a59aead --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,7 @@ +DELETE /v1/users/{userId}/mfa/authenticators/{type} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete-session.md b/docs/examples/1.6.x/server-rest/examples/users/delete-session.md new file mode 100644 index 0000000000..f2a1a7079b --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/delete-session.md @@ -0,0 +1,7 @@ +DELETE /v1/users/{userId}/sessions/{sessionId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-rest/examples/users/delete-sessions.md new file mode 100644 index 0000000000..11a55e3249 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/delete-sessions.md @@ -0,0 +1,7 @@ +DELETE /v1/users/{userId}/sessions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete-target.md b/docs/examples/1.6.x/server-rest/examples/users/delete-target.md new file mode 100644 index 0000000000..7a84c4f764 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/delete-target.md @@ -0,0 +1,7 @@ +DELETE /v1/users/{userId}/targets/{targetId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete.md b/docs/examples/1.6.x/server-rest/examples/users/delete.md new file mode 100644 index 0000000000..44c60c5901 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/delete.md @@ -0,0 +1,7 @@ +DELETE /v1/users/{userId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..fd69bac8cb --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,7 @@ +GET /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/get-prefs.md b/docs/examples/1.6.x/server-rest/examples/users/get-prefs.md new file mode 100644 index 0000000000..3383dc1df1 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/get-prefs.md @@ -0,0 +1,7 @@ +GET /v1/users/{userId}/prefs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/get-target.md b/docs/examples/1.6.x/server-rest/examples/users/get-target.md new file mode 100644 index 0000000000..2391d11c38 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/get-target.md @@ -0,0 +1,7 @@ +GET /v1/users/{userId}/targets/{targetId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/get.md b/docs/examples/1.6.x/server-rest/examples/users/get.md new file mode 100644 index 0000000000..84cf52eb3d --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/get.md @@ -0,0 +1,7 @@ +GET /v1/users/{userId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-identities.md b/docs/examples/1.6.x/server-rest/examples/users/list-identities.md new file mode 100644 index 0000000000..518a46b632 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/list-identities.md @@ -0,0 +1,7 @@ +GET /v1/users/identities HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-logs.md b/docs/examples/1.6.x/server-rest/examples/users/list-logs.md new file mode 100644 index 0000000000..08c534aa95 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/list-logs.md @@ -0,0 +1,7 @@ +GET /v1/users/{userId}/logs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-memberships.md b/docs/examples/1.6.x/server-rest/examples/users/list-memberships.md new file mode 100644 index 0000000000..c273866a40 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/list-memberships.md @@ -0,0 +1,7 @@ +GET /v1/users/{userId}/memberships HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-rest/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..13c3685384 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/list-mfa-factors.md @@ -0,0 +1,7 @@ +GET /v1/users/{userId}/mfa/factors HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-sessions.md b/docs/examples/1.6.x/server-rest/examples/users/list-sessions.md new file mode 100644 index 0000000000..fff9772c2b --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/list-sessions.md @@ -0,0 +1,7 @@ +GET /v1/users/{userId}/sessions HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-targets.md b/docs/examples/1.6.x/server-rest/examples/users/list-targets.md new file mode 100644 index 0000000000..7e5151d1e2 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/list-targets.md @@ -0,0 +1,7 @@ +GET /v1/users/{userId}/targets HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/list.md b/docs/examples/1.6.x/server-rest/examples/users/list.md new file mode 100644 index 0000000000..c7916d3b08 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/list.md @@ -0,0 +1,7 @@ +GET /v1/users HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-rest/examples/users/update-email-verification.md new file mode 100644 index 0000000000..b0c7def168 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-email-verification.md @@ -0,0 +1,10 @@ +PATCH /v1/users/{userId}/verification HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "emailVerification": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-email.md b/docs/examples/1.6.x/server-rest/examples/users/update-email.md new file mode 100644 index 0000000000..1ea77d58b9 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-email.md @@ -0,0 +1,10 @@ +PATCH /v1/users/{userId}/email HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "email": "email@example.com" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-labels.md b/docs/examples/1.6.x/server-rest/examples/users/update-labels.md new file mode 100644 index 0000000000..50e33667ac --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-labels.md @@ -0,0 +1,10 @@ +PUT /v1/users/{userId}/labels HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "labels": [] +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..1164bc5735 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,7 @@ +PUT /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-mfa.md b/docs/examples/1.6.x/server-rest/examples/users/update-mfa.md new file mode 100644 index 0000000000..a63bd11e4a --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-mfa.md @@ -0,0 +1,10 @@ +PATCH /v1/users/{userId}/mfa HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "mfa": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-name.md b/docs/examples/1.6.x/server-rest/examples/users/update-name.md new file mode 100644 index 0000000000..442b9cce84 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-name.md @@ -0,0 +1,10 @@ +PATCH /v1/users/{userId}/name HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-password.md b/docs/examples/1.6.x/server-rest/examples/users/update-password.md new file mode 100644 index 0000000000..4c0e964b47 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-password.md @@ -0,0 +1,10 @@ +PATCH /v1/users/{userId}/password HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "password": +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-rest/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..5a446f2a5e --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-phone-verification.md @@ -0,0 +1,10 @@ +PATCH /v1/users/{userId}/verification/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "phoneVerification": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-phone.md b/docs/examples/1.6.x/server-rest/examples/users/update-phone.md new file mode 100644 index 0000000000..2f30e7590f --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-phone.md @@ -0,0 +1,10 @@ +PATCH /v1/users/{userId}/phone HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "number": "+12065550100" +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-prefs.md b/docs/examples/1.6.x/server-rest/examples/users/update-prefs.md new file mode 100644 index 0000000000..7d0171cc50 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-prefs.md @@ -0,0 +1,10 @@ +PATCH /v1/users/{userId}/prefs HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "prefs": {} +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-status.md b/docs/examples/1.6.x/server-rest/examples/users/update-status.md new file mode 100644 index 0000000000..2fbdd7a180 --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-status.md @@ -0,0 +1,10 @@ +PATCH /v1/users/{userId}/status HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "status": false +} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-target.md b/docs/examples/1.6.x/server-rest/examples/users/update-target.md new file mode 100644 index 0000000000..4b9815cb8a --- /dev/null +++ b/docs/examples/1.6.x/server-rest/examples/users/update-target.md @@ -0,0 +1,12 @@ +PATCH /v1/users/{userId}/targets/{targetId} HTTP/1.1 +Host: cloud.appwrite.io +Content-Type: application/json +X-Appwrite-Response-Format: 1.5.0 +X-Appwrite-Project: <YOUR_PROJECT_ID> +X-Appwrite-Key: <YOUR_API_KEY> + +{ + "identifier": "<IDENTIFIER>", + "providerId": "<PROVIDER_ID>", + "name": "<NAME>" +} diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-ruby/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..5e73f3f0d8 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-anonymous-session.md @@ -0,0 +1,11 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.create_anonymous_session() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-ruby/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..d5391d881a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-email-password-session.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.create_email_password_session( + email: 'email@example.com', + password: 'password' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-email-token.md b/docs/examples/1.6.x/server-ruby/examples/account/create-email-token.md new file mode 100644 index 0000000000..823cc108f0 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-email-token.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.create_email_token( + user_id: '<USER_ID>', + email: 'email@example.com', + phrase: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-ruby/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..a6632a73c6 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-j-w-t.md @@ -0,0 +1,11 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.create_jwt() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-ruby/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..015ad800f8 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.create_magic_url_token( + user_id: '<USER_ID>', + email: 'email@example.com', + url: 'https://example.com', # optional + phrase: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..cec05887a2 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-authenticator.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.create_mfa_authenticator( + type: AuthenticatorType::TOTP +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..d4e9d8ed20 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-challenge.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.create_mfa_challenge( + factor: AuthenticationFactor::EMAIL +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..bf66c399b6 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.create_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-ruby/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..5b17f1c29d --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-o-auth2token.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.create_o_auth2_token( + provider: OAuthProvider::AMAZON, + success: 'https://example.com', # optional + failure: 'https://example.com', # optional + scopes: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-ruby/examples/account/create-phone-token.md new file mode 100644 index 0000000000..592b964c37 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-phone-token.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.create_phone_token( + user_id: '<USER_ID>', + phone: '+12065550100' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-ruby/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..50c0ce0e4a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-phone-verification.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.create_phone_verification() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-recovery.md b/docs/examples/1.6.x/server-ruby/examples/account/create-recovery.md new file mode 100644 index 0000000000..91bf09fd12 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-recovery.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.create_recovery( + email: 'email@example.com', + url: 'https://example.com' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-session.md b/docs/examples/1.6.x/server-ruby/examples/account/create-session.md new file mode 100644 index 0000000000..ce6c738667 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-session.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.create_session( + user_id: '<USER_ID>', + secret: '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-verification.md b/docs/examples/1.6.x/server-ruby/examples/account/create-verification.md new file mode 100644 index 0000000000..d4614d47ce --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create-verification.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.create_verification( + url: 'https://example.com' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create.md b/docs/examples/1.6.x/server-ruby/examples/account/create.md new file mode 100644 index 0000000000..8922cf4241 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/create.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.create( + user_id: '<USER_ID>', + email: 'email@example.com', + password: '', + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/delete-identity.md b/docs/examples/1.6.x/server-ruby/examples/account/delete-identity.md new file mode 100644 index 0000000000..2a3ebb72b2 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/delete-identity.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.delete_identity( + identity_id: '<IDENTITY_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-ruby/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..1d21a5cd43 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.delete_mfa_authenticator( + type: AuthenticatorType::TOTP +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/delete-session.md b/docs/examples/1.6.x/server-ruby/examples/account/delete-session.md new file mode 100644 index 0000000000..c597e807a4 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/delete-session.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.delete_session( + session_id: '<SESSION_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-ruby/examples/account/delete-sessions.md new file mode 100644 index 0000000000..379c893da2 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/delete-sessions.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.delete_sessions() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..f91b03550e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.get_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/get-prefs.md b/docs/examples/1.6.x/server-ruby/examples/account/get-prefs.md new file mode 100644 index 0000000000..65a1e22885 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/get-prefs.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.get_prefs() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/get-session.md b/docs/examples/1.6.x/server-ruby/examples/account/get-session.md new file mode 100644 index 0000000000..d8341c61d9 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/get-session.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.get_session( + session_id: '<SESSION_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/get.md b/docs/examples/1.6.x/server-ruby/examples/account/get.md new file mode 100644 index 0000000000..ac2c9d0b3a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/get.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.get() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/list-identities.md b/docs/examples/1.6.x/server-ruby/examples/account/list-identities.md new file mode 100644 index 0000000000..98ae35d512 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/list-identities.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.list_identities( + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/list-logs.md b/docs/examples/1.6.x/server-ruby/examples/account/list-logs.md new file mode 100644 index 0000000000..1462f08cb5 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/list-logs.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.list_logs( + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-ruby/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..c228560721 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/list-mfa-factors.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.list_mfa_factors() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/list-sessions.md b/docs/examples/1.6.x/server-ruby/examples/account/list-sessions.md new file mode 100644 index 0000000000..8b67920586 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/list-sessions.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.list_sessions() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-email.md b/docs/examples/1.6.x/server-ruby/examples/account/update-email.md new file mode 100644 index 0000000000..66e8e3a1d7 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-email.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_email( + email: 'email@example.com', + password: 'password' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-ruby/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..cfb58d4741 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-m-f-a.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_mfa( + mfa: false +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-ruby/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..3635bc1ed7 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.update_magic_url_session( + user_id: '<USER_ID>', + secret: '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..15d964c37e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-authenticator.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_mfa_authenticator( + type: AuthenticatorType::TOTP, + otp: '<OTP>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..f412b4bcbf --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-challenge.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_mfa_challenge( + challenge_id: '<CHALLENGE_ID>', + otp: '<OTP>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..14b069e99e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-name.md b/docs/examples/1.6.x/server-ruby/examples/account/update-name.md new file mode 100644 index 0000000000..fa7a3e32c1 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-name.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_name( + name: '<NAME>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-password.md b/docs/examples/1.6.x/server-ruby/examples/account/update-password.md new file mode 100644 index 0000000000..7342f7d017 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-password.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_password( + password: '', + old_password: 'password' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-ruby/examples/account/update-phone-session.md new file mode 100644 index 0000000000..46e6abede5 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-phone-session.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + +account = Account.new(client) + +result = account.update_phone_session( + user_id: '<USER_ID>', + secret: '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-ruby/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..662b172f05 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-phone-verification.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_phone_verification( + user_id: '<USER_ID>', + secret: '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-phone.md b/docs/examples/1.6.x/server-ruby/examples/account/update-phone.md new file mode 100644 index 0000000000..8ed5e1d21c --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-phone.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_phone( + phone: '+12065550100', + password: 'password' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-prefs.md b/docs/examples/1.6.x/server-ruby/examples/account/update-prefs.md new file mode 100644 index 0000000000..296a67d683 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-prefs.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_prefs( + prefs: {} +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-recovery.md b/docs/examples/1.6.x/server-ruby/examples/account/update-recovery.md new file mode 100644 index 0000000000..97ac1d4fa5 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-recovery.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_recovery( + user_id: '<USER_ID>', + secret: '<SECRET>', + password: '' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-session.md b/docs/examples/1.6.x/server-ruby/examples/account/update-session.md new file mode 100644 index 0000000000..4bfded0e4e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-session.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_session( + session_id: '<SESSION_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-status.md b/docs/examples/1.6.x/server-ruby/examples/account/update-status.md new file mode 100644 index 0000000000..72b81280a7 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-status.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_status() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-verification.md b/docs/examples/1.6.x/server-ruby/examples/account/update-verification.md new file mode 100644 index 0000000000..29f01d3843 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/account/update-verification.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +account = Account.new(client) + +result = account.update_verification( + user_id: '<USER_ID>', + secret: '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-browser.md new file mode 100644 index 0000000000..199e9e26d1 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/avatars/get-browser.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +avatars = Avatars.new(client) + +result = avatars.get_browser( + code: Browser::AVANT_BROWSER, + width: 0, # optional + height: 0, # optional + quality: 0 # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..68e1a1cc0e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/avatars/get-credit-card.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +avatars = Avatars.new(client) + +result = avatars.get_credit_card( + code: CreditCard::AMERICAN_EXPRESS, + width: 0, # optional + height: 0, # optional + quality: 0 # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..0ebf7fdc05 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/avatars/get-favicon.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +avatars = Avatars.new(client) + +result = avatars.get_favicon( + url: 'https://example.com' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-flag.md new file mode 100644 index 0000000000..c249f2fbbc --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/avatars/get-flag.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +avatars = Avatars.new(client) + +result = avatars.get_flag( + code: Flag::AFGHANISTAN, + width: 0, # optional + height: 0, # optional + quality: 0 # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-image.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-image.md new file mode 100644 index 0000000000..c21ddf74b5 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/avatars/get-image.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +avatars = Avatars.new(client) + +result = avatars.get_image( + url: 'https://example.com', + width: 0, # optional + height: 0 # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-initials.md new file mode 100644 index 0000000000..ffac9acd23 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/avatars/get-initials.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +avatars = Avatars.new(client) + +result = avatars.get_initials( + name: '<NAME>', # optional + width: 0, # optional + height: 0, # optional + background: '' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..a5eb84eb01 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/avatars/get-q-r.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +avatars = Avatars.new(client) + +result = avatars.get_qr( + text: '<TEXT>', + size: 1, # optional + margin: 0, # optional + download: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..5d709737f4 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-boolean-attribute.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_boolean_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + default: false, # optional + array: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-collection.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-collection.md new file mode 100644 index 0000000000..801c9ad01d --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-collection.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_collection( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + name: '<NAME>', + permissions: ["read("any")"], # optional + document_security: false, # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..5bdd4e234f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-datetime-attribute.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_datetime_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + default: '', # optional + array: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-document.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-document.md new file mode 100644 index 0000000000..0dd99aa3a5 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-document.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +databases = Databases.new(client) + +result = databases.create_document( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + document_id: '<DOCUMENT_ID>', + data: {}, + permissions: ["read("any")"] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..dcacad20bf --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-email-attribute.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_email_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + default: 'email@example.com', # optional + array: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..374efab75f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-enum-attribute.md @@ -0,0 +1,20 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_enum_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + elements: [], + required: false, + default: '<DEFAULT>', # optional + array: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..e90c657582 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-float-attribute.md @@ -0,0 +1,21 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_float_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + min: null, # optional + max: null, # optional + default: null, # optional + array: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-index.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-index.md new file mode 100644 index 0000000000..e195c5921e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-index.md @@ -0,0 +1,20 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_index( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + type: IndexType::KEY, + attributes: [], + orders: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..eaafbc3280 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-integer-attribute.md @@ -0,0 +1,21 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_integer_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + min: null, # optional + max: null, # optional + default: null, # optional + array: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..babe694df5 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-ip-attribute.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_ip_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + default: '', # optional + array: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..8ed96f53f3 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-relationship-attribute.md @@ -0,0 +1,22 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_relationship_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + related_collection_id: '<RELATED_COLLECTION_ID>', + type: RelationshipType::ONETOONE, + two_way: false, # optional + key: '', # optional + two_way_key: '', # optional + on_delete: RelationMutate::CASCADE # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..6bf200d122 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-string-attribute.md @@ -0,0 +1,21 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_string_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + size: 1, + required: false, + default: '<DEFAULT>', # optional + array: false, # optional + encrypt: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..fd39f03085 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create-url-attribute.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create_url_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + default: 'https://example.com', # optional + array: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create.md b/docs/examples/1.6.x/server-ruby/examples/databases/create.md new file mode 100644 index 0000000000..d000e1e239 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/create.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.create( + database_id: '<DATABASE_ID>', + name: '<NAME>', + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..fbcf76ff92 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/delete-attribute.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.delete_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-ruby/examples/databases/delete-collection.md new file mode 100644 index 0000000000..4cbc39c552 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/delete-collection.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.delete_collection( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/delete-document.md b/docs/examples/1.6.x/server-ruby/examples/databases/delete-document.md new file mode 100644 index 0000000000..de947b04cb --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/delete-document.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +databases = Databases.new(client) + +result = databases.delete_document( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + document_id: '<DOCUMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/delete-index.md b/docs/examples/1.6.x/server-ruby/examples/databases/delete-index.md new file mode 100644 index 0000000000..5249ceaf22 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/delete-index.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.delete_index( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/delete.md b/docs/examples/1.6.x/server-ruby/examples/databases/delete.md new file mode 100644 index 0000000000..31b169f07f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/delete.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.delete( + database_id: '<DATABASE_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/get-attribute.md new file mode 100644 index 0000000000..f1ca6b9545 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/get-attribute.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.get_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/get-collection.md b/docs/examples/1.6.x/server-ruby/examples/databases/get-collection.md new file mode 100644 index 0000000000..0c26fb63f2 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/get-collection.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.get_collection( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/get-document.md b/docs/examples/1.6.x/server-ruby/examples/databases/get-document.md new file mode 100644 index 0000000000..35f802ca96 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/get-document.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +databases = Databases.new(client) + +result = databases.get_document( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + document_id: '<DOCUMENT_ID>', + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/get-index.md b/docs/examples/1.6.x/server-ruby/examples/databases/get-index.md new file mode 100644 index 0000000000..bb5e831ae7 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/get-index.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.get_index( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/get.md b/docs/examples/1.6.x/server-ruby/examples/databases/get.md new file mode 100644 index 0000000000..fb678031bc --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/get.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.get( + database_id: '<DATABASE_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-ruby/examples/databases/list-attributes.md new file mode 100644 index 0000000000..8c15ccdb23 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/list-attributes.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.list_attributes( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/list-collections.md b/docs/examples/1.6.x/server-ruby/examples/databases/list-collections.md new file mode 100644 index 0000000000..b04d6dfcbc --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/list-collections.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.list_collections( + database_id: '<DATABASE_ID>', + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/list-documents.md b/docs/examples/1.6.x/server-ruby/examples/databases/list-documents.md new file mode 100644 index 0000000000..8337438bdf --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/list-documents.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +databases = Databases.new(client) + +result = databases.list_documents( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-ruby/examples/databases/list-indexes.md new file mode 100644 index 0000000000..851196b36c --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/list-indexes.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.list_indexes( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/list.md b/docs/examples/1.6.x/server-ruby/examples/databases/list.md new file mode 100644 index 0000000000..76a9472f57 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/list.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.list( + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..1c9ea78263 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-boolean-attribute.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_boolean_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + default: false +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-collection.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-collection.md new file mode 100644 index 0000000000..871c2838b5 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-collection.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_collection( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + name: '<NAME>', + permissions: ["read("any")"], # optional + document_security: false, # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..784513a16f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-datetime-attribute.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_datetime_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + default: '' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-document.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-document.md new file mode 100644 index 0000000000..c870243599 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-document.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +databases = Databases.new(client) + +result = databases.update_document( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + document_id: '<DOCUMENT_ID>', + data: {}, # optional + permissions: ["read("any")"] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..ff8b2a722a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-email-attribute.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_email_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + default: 'email@example.com' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..60acfcad55 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-enum-attribute.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_enum_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + elements: [], + required: false, + default: '<DEFAULT>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..691aec9c1b --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-float-attribute.md @@ -0,0 +1,20 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_float_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + min: null, + max: null, + default: null +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..05d0b1a2f8 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-integer-attribute.md @@ -0,0 +1,20 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_integer_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + min: null, + max: null, + default: null +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..c0520fa1f0 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-ip-attribute.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_ip_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + default: '' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..58e2e49347 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-relationship-attribute.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_relationship_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + on_delete: RelationMutate::CASCADE # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..f065dd2229 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-string-attribute.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_string_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + default: '<DEFAULT>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..7778c26ced --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update-url-attribute.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_url_attribute( + database_id: '<DATABASE_ID>', + collection_id: '<COLLECTION_ID>', + key: '', + required: false, + default: 'https://example.com' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update.md b/docs/examples/1.6.x/server-ruby/examples/databases/update.md new file mode 100644 index 0000000000..acafe1ac1f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/databases/update.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +databases = Databases.new(client) + +result = databases.update( + database_id: '<DATABASE_ID>', + name: '<NAME>', + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/create-build.md b/docs/examples/1.6.x/server-ruby/examples/functions/create-build.md new file mode 100644 index 0000000000..e2a0c6a48f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/create-build.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.create_build( + function_id: '<FUNCTION_ID>', + deployment_id: '<DEPLOYMENT_ID>', + build_id: '<BUILD_ID>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-ruby/examples/functions/create-deployment.md new file mode 100644 index 0000000000..a21bd37d6f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/create-deployment.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.create_deployment( + function_id: '<FUNCTION_ID>', + code: InputFile.from_path('dir/file.png'), + activate: false, + entrypoint: '<ENTRYPOINT>', # optional + commands: '<COMMANDS>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/create-execution.md b/docs/examples/1.6.x/server-ruby/examples/functions/create-execution.md new file mode 100644 index 0000000000..d2c5786418 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/create-execution.md @@ -0,0 +1,20 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +functions = Functions.new(client) + +result = functions.create_execution( + function_id: '<FUNCTION_ID>', + body: '<BODY>', # optional + async: false, # optional + path: '<PATH>', # optional + method: ExecutionMethod::GET, # optional + headers: {}, # optional + scheduled_at: '' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/create-variable.md b/docs/examples/1.6.x/server-ruby/examples/functions/create-variable.md new file mode 100644 index 0000000000..0a5de5506a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/create-variable.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.create_variable( + function_id: '<FUNCTION_ID>', + key: '<KEY>', + value: '<VALUE>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/create.md b/docs/examples/1.6.x/server-ruby/examples/functions/create.md new file mode 100644 index 0000000000..975f985607 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/create.md @@ -0,0 +1,35 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.create( + function_id: '<FUNCTION_ID>', + name: '<NAME>', + runtime: ::NODE_14_5, + execute: ["any"], # optional + events: [], # optional + schedule: '', # optional + timeout: 1, # optional + enabled: false, # optional + logging: false, # optional + entrypoint: '<ENTRYPOINT>', # optional + commands: '<COMMANDS>', # optional + scopes: [], # optional + installation_id: '<INSTALLATION_ID>', # optional + provider_repository_id: '<PROVIDER_REPOSITORY_ID>', # optional + provider_branch: '<PROVIDER_BRANCH>', # optional + provider_silent_mode: false, # optional + provider_root_directory: '<PROVIDER_ROOT_DIRECTORY>', # optional + template_repository: '<TEMPLATE_REPOSITORY>', # optional + template_owner: '<TEMPLATE_OWNER>', # optional + template_root_directory: '<TEMPLATE_ROOT_DIRECTORY>', # optional + template_branch: '<TEMPLATE_BRANCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-ruby/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..7e525b78e9 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/delete-deployment.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.delete_deployment( + function_id: '<FUNCTION_ID>', + deployment_id: '<DEPLOYMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-ruby/examples/functions/delete-execution.md new file mode 100644 index 0000000000..07003cdfe9 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/delete-execution.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.delete_execution( + function_id: '<FUNCTION_ID>', + execution_id: '<EXECUTION_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-ruby/examples/functions/delete-variable.md new file mode 100644 index 0000000000..dd2a4df1e4 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/delete-variable.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.delete_variable( + function_id: '<FUNCTION_ID>', + variable_id: '<VARIABLE_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/delete.md b/docs/examples/1.6.x/server-ruby/examples/functions/delete.md new file mode 100644 index 0000000000..a55d56f196 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/delete.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.delete( + function_id: '<FUNCTION_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-ruby/examples/functions/download-deployment.md new file mode 100644 index 0000000000..57369287e6 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/download-deployment.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.download_deployment( + function_id: '<FUNCTION_ID>', + deployment_id: '<DEPLOYMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-ruby/examples/functions/get-deployment.md new file mode 100644 index 0000000000..d5c9698be9 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/get-deployment.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.get_deployment( + function_id: '<FUNCTION_ID>', + deployment_id: '<DEPLOYMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/get-execution.md b/docs/examples/1.6.x/server-ruby/examples/functions/get-execution.md new file mode 100644 index 0000000000..a127259c3f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/get-execution.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +functions = Functions.new(client) + +result = functions.get_execution( + function_id: '<FUNCTION_ID>', + execution_id: '<EXECUTION_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/get-variable.md b/docs/examples/1.6.x/server-ruby/examples/functions/get-variable.md new file mode 100644 index 0000000000..8e7c73ac3d --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/get-variable.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.get_variable( + function_id: '<FUNCTION_ID>', + variable_id: '<VARIABLE_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/get.md b/docs/examples/1.6.x/server-ruby/examples/functions/get.md new file mode 100644 index 0000000000..36872251ad --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/get.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.get( + function_id: '<FUNCTION_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-ruby/examples/functions/list-deployments.md new file mode 100644 index 0000000000..4213536fed --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/list-deployments.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.list_deployments( + function_id: '<FUNCTION_ID>', + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/list-executions.md b/docs/examples/1.6.x/server-ruby/examples/functions/list-executions.md new file mode 100644 index 0000000000..41cb940f74 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/list-executions.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +functions = Functions.new(client) + +result = functions.list_executions( + function_id: '<FUNCTION_ID>', + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-ruby/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..b305843dd9 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/list-runtimes.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.list_runtimes() diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/list-variables.md b/docs/examples/1.6.x/server-ruby/examples/functions/list-variables.md new file mode 100644 index 0000000000..91b2371e00 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/list-variables.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.list_variables( + function_id: '<FUNCTION_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/list.md b/docs/examples/1.6.x/server-ruby/examples/functions/list.md new file mode 100644 index 0000000000..b73c5f958e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/list.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.list( + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..39a09321d1 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment-build.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.update_deployment_build( + function_id: '<FUNCTION_ID>', + deployment_id: '<DEPLOYMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment.md new file mode 100644 index 0000000000..913ac485c9 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.update_deployment( + function_id: '<FUNCTION_ID>', + deployment_id: '<DEPLOYMENT_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/update-variable.md b/docs/examples/1.6.x/server-ruby/examples/functions/update-variable.md new file mode 100644 index 0000000000..9b029d7882 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/update-variable.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.update_variable( + function_id: '<FUNCTION_ID>', + variable_id: '<VARIABLE_ID>', + key: '<KEY>', + value: '<VALUE>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/update.md b/docs/examples/1.6.x/server-ruby/examples/functions/update.md new file mode 100644 index 0000000000..7111a48b13 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/functions/update.md @@ -0,0 +1,30 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +functions = Functions.new(client) + +result = functions.update( + function_id: '<FUNCTION_ID>', + name: '<NAME>', + runtime: ::NODE_14_5, # optional + execute: ["any"], # optional + events: [], # optional + schedule: '', # optional + timeout: 1, # optional + enabled: false, # optional + logging: false, # optional + entrypoint: '<ENTRYPOINT>', # optional + commands: '<COMMANDS>', # optional + scopes: [], # optional + installation_id: '<INSTALLATION_ID>', # optional + provider_repository_id: '<PROVIDER_REPOSITORY_ID>', # optional + provider_branch: '<PROVIDER_BRANCH>', # optional + provider_silent_mode: false, # optional + provider_root_directory: '<PROVIDER_ROOT_DIRECTORY>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/graphql/mutation.md b/docs/examples/1.6.x/server-ruby/examples/graphql/mutation.md new file mode 100644 index 0000000000..6c656da967 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/graphql/mutation.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +graphql = Graphql.new(client) + +result = graphql.mutation( + query: {} +) diff --git a/docs/examples/1.6.x/server-ruby/examples/graphql/query.md b/docs/examples/1.6.x/server-ruby/examples/graphql/query.md new file mode 100644 index 0000000000..ced6a9de02 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/graphql/query.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +graphql = Graphql.new(client) + +result = graphql.query( + query: {} +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-ruby/examples/health/get-antivirus.md new file mode 100644 index 0000000000..41081c1837 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-antivirus.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_antivirus() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-cache.md b/docs/examples/1.6.x/server-ruby/examples/health/get-cache.md new file mode 100644 index 0000000000..371f77f58a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-cache.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_cache() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-certificate.md b/docs/examples/1.6.x/server-ruby/examples/health/get-certificate.md new file mode 100644 index 0000000000..82c26057ef --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-certificate.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_certificate( + domain: '' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-d-b.md b/docs/examples/1.6.x/server-ruby/examples/health/get-d-b.md new file mode 100644 index 0000000000..48039916fc --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-d-b.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_db() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-ruby/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..440095c7bb --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-failed-jobs.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_failed_jobs( + name: ::V1_DATABASE, + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-ruby/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..b77e726671 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-pub-sub.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_pub_sub() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..18dc388dc7 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-builds.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_builds( + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..541e2ddd30 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-certificates.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_certificates( + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..0be4fc0614 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-databases.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_databases( + name: '<NAME>', # optional + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..1f95b21ddf --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-deletes.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_deletes( + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..34e1d73044 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-functions.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_functions( + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..87ee4c2a0f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-logs.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_logs( + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..ccf8fe87fa --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-mails.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_mails( + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..7cd55d0aae --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-messaging.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_messaging( + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..fff087f1ec --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-migrations.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_migrations( + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..236507d265 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage-dump.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_usage_dump( + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..ebe54bf6b3 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_usage( + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..ce159224f9 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-webhooks.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue_webhooks( + threshold: null # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue.md new file mode 100644 index 0000000000..c9bf96a1bd --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-queue.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_queue() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-ruby/examples/health/get-storage-local.md new file mode 100644 index 0000000000..4ae699107a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-storage-local.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_storage_local() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-storage.md b/docs/examples/1.6.x/server-ruby/examples/health/get-storage.md new file mode 100644 index 0000000000..6da3548b71 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-storage.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_storage() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-time.md b/docs/examples/1.6.x/server-ruby/examples/health/get-time.md new file mode 100644 index 0000000000..20be01b942 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get-time.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get_time() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get.md b/docs/examples/1.6.x/server-ruby/examples/health/get.md new file mode 100644 index 0000000000..7b51ecea84 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/health/get.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +health = Health.new(client) + +result = health.get() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/get.md b/docs/examples/1.6.x/server-ruby/examples/locale/get.md new file mode 100644 index 0000000000..4c26a0913f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/locale/get.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +locale = Locale.new(client) + +result = locale.get() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-codes.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-codes.md new file mode 100644 index 0000000000..3f4b763024 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/locale/list-codes.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +locale = Locale.new(client) + +result = locale.list_codes() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-continents.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-continents.md new file mode 100644 index 0000000000..a841a55ec8 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/locale/list-continents.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +locale = Locale.new(client) + +result = locale.list_continents() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..21845cd953 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-e-u.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +locale = Locale.new(client) + +result = locale.list_countries_eu() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..453a86cde0 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-phones.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +locale = Locale.new(client) + +result = locale.list_countries_phones() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-countries.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-countries.md new file mode 100644 index 0000000000..c34d341515 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/locale/list-countries.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +locale = Locale.new(client) + +result = locale.list_countries() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-currencies.md new file mode 100644 index 0000000000..30af2ef359 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/locale/list-currencies.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +locale = Locale.new(client) + +result = locale.list_currencies() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-languages.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-languages.md new file mode 100644 index 0000000000..904f9cebe3 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/locale/list-languages.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +locale = Locale.new(client) + +result = locale.list_languages() diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..e18993ddd9 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-apns-provider.md @@ -0,0 +1,21 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_apns_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', + auth_key: '<AUTH_KEY>', # optional + auth_key_id: '<AUTH_KEY_ID>', # optional + team_id: '<TEAM_ID>', # optional + bundle_id: '<BUNDLE_ID>', # optional + sandbox: false, # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-email.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-email.md new file mode 100644 index 0000000000..98b069f1b1 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-email.md @@ -0,0 +1,25 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_email( + message_id: '<MESSAGE_ID>', + subject: '<SUBJECT>', + content: '<CONTENT>', + topics: [], # optional + users: [], # optional + targets: [], # optional + cc: [], # optional + bcc: [], # optional + attachments: [], # optional + draft: false, # optional + html: false, # optional + scheduled_at: '' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..05daa6f63a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-fcm-provider.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_fcm_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', + service_account_json: {}, # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..2640bb0dfb --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,23 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_mailgun_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', + api_key: '<API_KEY>', # optional + domain: '<DOMAIN>', # optional + is_eu_region: false, # optional + from_name: '<FROM_NAME>', # optional + from_email: 'email@example.com', # optional + reply_to_name: '<REPLY_TO_NAME>', # optional + reply_to_email: 'email@example.com', # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..1f6d408146 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-msg91provider.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_msg91_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', + template_id: '<TEMPLATE_ID>', # optional + sender_id: '<SENDER_ID>', # optional + auth_key: '<AUTH_KEY>', # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-push.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-push.md new file mode 100644 index 0000000000..ccb2f79f79 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-push.md @@ -0,0 +1,29 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_push( + message_id: '<MESSAGE_ID>', + title: '<TITLE>', + body: '<BODY>', + topics: [], # optional + users: [], # optional + targets: [], # optional + data: {}, # optional + action: '<ACTION>', # optional + image: '[ID1:ID2]', # optional + icon: '<ICON>', # optional + sound: '<SOUND>', # optional + color: '<COLOR>', # optional + tag: '<TAG>', # optional + badge: '<BADGE>', # optional + draft: false, # optional + scheduled_at: '' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..1f129e8c79 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,21 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_sendgrid_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', + api_key: '<API_KEY>', # optional + from_name: '<FROM_NAME>', # optional + from_email: 'email@example.com', # optional + reply_to_name: '<REPLY_TO_NAME>', # optional + reply_to_email: 'email@example.com', # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-sms.md new file mode 100644 index 0000000000..7ae0ad6faf --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-sms.md @@ -0,0 +1,20 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_sms( + message_id: '<MESSAGE_ID>', + content: '<CONTENT>', + topics: [], # optional + users: [], # optional + targets: [], # optional + draft: false, # optional + scheduled_at: '' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..aa514fc3e1 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-smtp-provider.md @@ -0,0 +1,27 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_smtp_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', + host: '<HOST>', + port: 1, # optional + username: '<USERNAME>', # optional + password: '<PASSWORD>', # optional + encryption: SmtpEncryption::NONE, # optional + auto_tls: false, # optional + mailer: '<MAILER>', # optional + from_name: '<FROM_NAME>', # optional + from_email: 'email@example.com', # optional + reply_to_name: '<REPLY_TO_NAME>', # optional + reply_to_email: 'email@example.com', # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..a5dbcc0c50 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-subscriber.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_jwt('<YOUR_JWT>') # Your secret JSON Web Token + +messaging = Messaging.new(client) + +result = messaging.create_subscriber( + topic_id: '<TOPIC_ID>', + subscriber_id: '<SUBSCRIBER_ID>', + target_id: '<TARGET_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..7f8430be07 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-telesign-provider.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_telesign_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', # optional + customer_id: '<CUSTOMER_ID>', # optional + api_key: '<API_KEY>', # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..ab49e44f48 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_textmagic_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', # optional + username: '<USERNAME>', # optional + api_key: '<API_KEY>', # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-topic.md new file mode 100644 index 0000000000..d4c77f0e45 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-topic.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_topic( + topic_id: '<TOPIC_ID>', + name: '<NAME>', + subscribe: ["any"] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..ef0d6ced8d --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-twilio-provider.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_twilio_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', # optional + account_sid: '<ACCOUNT_SID>', # optional + auth_token: '<AUTH_TOKEN>', # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..4a20d79140 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/create-vonage-provider.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.create_vonage_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', + from: '+12065550100', # optional + api_key: '<API_KEY>', # optional + api_secret: '<API_SECRET>', # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..2abdb5b537 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/delete-provider.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.delete_provider( + provider_id: '<PROVIDER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-ruby/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..4f527336cc --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/delete-subscriber.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_jwt('<YOUR_JWT>') # Your secret JSON Web Token + +messaging = Messaging.new(client) + +result = messaging.delete_subscriber( + topic_id: '<TOPIC_ID>', + subscriber_id: '<SUBSCRIBER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-ruby/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..253f5cdc17 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/delete-topic.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.delete_topic( + topic_id: '<TOPIC_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/delete.md b/docs/examples/1.6.x/server-ruby/examples/messaging/delete.md new file mode 100644 index 0000000000..00eeaa3b57 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/delete.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.delete( + message_id: '<MESSAGE_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/get-message.md b/docs/examples/1.6.x/server-ruby/examples/messaging/get-message.md new file mode 100644 index 0000000000..15ebe03221 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/get-message.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.get_message( + message_id: '<MESSAGE_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/get-provider.md new file mode 100644 index 0000000000..73845ee7fb --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/get-provider.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.get_provider( + provider_id: '<PROVIDER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-ruby/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..c1ede6456f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/get-subscriber.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.get_subscriber( + topic_id: '<TOPIC_ID>', + subscriber_id: '<SUBSCRIBER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-ruby/examples/messaging/get-topic.md new file mode 100644 index 0000000000..bf232b20b3 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/get-topic.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.get_topic( + topic_id: '<TOPIC_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..7b9ef925f8 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/list-message-logs.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.list_message_logs( + message_id: '<MESSAGE_ID>', + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-messages.md new file mode 100644 index 0000000000..97d73e6e32 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/list-messages.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.list_messages( + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..8510f5cd91 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/list-provider-logs.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.list_provider_logs( + provider_id: '<PROVIDER_ID>', + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-providers.md new file mode 100644 index 0000000000..4df1f29fc9 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/list-providers.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.list_providers( + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..2a40254b9a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.list_subscriber_logs( + subscriber_id: '<SUBSCRIBER_ID>', + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..f14aeb0b2e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscribers.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.list_subscribers( + topic_id: '<TOPIC_ID>', + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-targets.md new file mode 100644 index 0000000000..0c4a696ea2 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/list-targets.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.list_targets( + message_id: '<MESSAGE_ID>', + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..52fca3ec11 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/list-topic-logs.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.list_topic_logs( + topic_id: '<TOPIC_ID>', + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-topics.md new file mode 100644 index 0000000000..89edddc1af --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/list-topics.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.list_topics( + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..b37dfa0a46 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-apns-provider.md @@ -0,0 +1,21 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_apns_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', # optional + enabled: false, # optional + auth_key: '<AUTH_KEY>', # optional + auth_key_id: '<AUTH_KEY_ID>', # optional + team_id: '<TEAM_ID>', # optional + bundle_id: '<BUNDLE_ID>', # optional + sandbox: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-email.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-email.md new file mode 100644 index 0000000000..6323e02939 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-email.md @@ -0,0 +1,25 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_email( + message_id: '<MESSAGE_ID>', + topics: [], # optional + users: [], # optional + targets: [], # optional + subject: '<SUBJECT>', # optional + content: '<CONTENT>', # optional + draft: false, # optional + html: false, # optional + cc: [], # optional + bcc: [], # optional + scheduled_at: '', # optional + attachments: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..6c7b776cd0 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-fcm-provider.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_fcm_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', # optional + enabled: false, # optional + service_account_json: {} # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..ca8f8a0502 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,23 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_mailgun_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', # optional + api_key: '<API_KEY>', # optional + domain: '<DOMAIN>', # optional + is_eu_region: false, # optional + enabled: false, # optional + from_name: '<FROM_NAME>', # optional + from_email: 'email@example.com', # optional + reply_to_name: '<REPLY_TO_NAME>', # optional + reply_to_email: '<REPLY_TO_EMAIL>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..6c939c7aa6 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-msg91provider.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_msg91_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', # optional + enabled: false, # optional + template_id: '<TEMPLATE_ID>', # optional + sender_id: '<SENDER_ID>', # optional + auth_key: '<AUTH_KEY>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-push.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-push.md new file mode 100644 index 0000000000..9a7ef52443 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-push.md @@ -0,0 +1,29 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_push( + message_id: '<MESSAGE_ID>', + topics: [], # optional + users: [], # optional + targets: [], # optional + title: '<TITLE>', # optional + body: '<BODY>', # optional + data: {}, # optional + action: '<ACTION>', # optional + image: '[ID1:ID2]', # optional + icon: '<ICON>', # optional + sound: '<SOUND>', # optional + color: '<COLOR>', # optional + tag: '<TAG>', # optional + badge: null, # optional + draft: false, # optional + scheduled_at: '' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..d472dc7153 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,21 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_sendgrid_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', # optional + enabled: false, # optional + api_key: '<API_KEY>', # optional + from_name: '<FROM_NAME>', # optional + from_email: 'email@example.com', # optional + reply_to_name: '<REPLY_TO_NAME>', # optional + reply_to_email: '<REPLY_TO_EMAIL>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-sms.md new file mode 100644 index 0000000000..87fa0f9e14 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-sms.md @@ -0,0 +1,20 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_sms( + message_id: '<MESSAGE_ID>', + topics: [], # optional + users: [], # optional + targets: [], # optional + content: '<CONTENT>', # optional + draft: false, # optional + scheduled_at: '' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..979036974b --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-smtp-provider.md @@ -0,0 +1,27 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_smtp_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', # optional + host: '<HOST>', # optional + port: 1, # optional + username: '<USERNAME>', # optional + password: '<PASSWORD>', # optional + encryption: SmtpEncryption::NONE, # optional + auto_tls: false, # optional + mailer: '<MAILER>', # optional + from_name: '<FROM_NAME>', # optional + from_email: 'email@example.com', # optional + reply_to_name: '<REPLY_TO_NAME>', # optional + reply_to_email: '<REPLY_TO_EMAIL>', # optional + enabled: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..95bf2071f2 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-telesign-provider.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_telesign_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', # optional + enabled: false, # optional + customer_id: '<CUSTOMER_ID>', # optional + api_key: '<API_KEY>', # optional + from: '<FROM>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..7c7f828db0 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_textmagic_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', # optional + enabled: false, # optional + username: '<USERNAME>', # optional + api_key: '<API_KEY>', # optional + from: '<FROM>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-topic.md new file mode 100644 index 0000000000..3e9aa84a5e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-topic.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_topic( + topic_id: '<TOPIC_ID>', + name: '<NAME>', # optional + subscribe: ["any"] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..7b88a5998e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-twilio-provider.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_twilio_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', # optional + enabled: false, # optional + account_sid: '<ACCOUNT_SID>', # optional + auth_token: '<AUTH_TOKEN>', # optional + from: '<FROM>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..37f55393e6 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/messaging/update-vonage-provider.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +messaging = Messaging.new(client) + +result = messaging.update_vonage_provider( + provider_id: '<PROVIDER_ID>', + name: '<NAME>', # optional + enabled: false, # optional + api_key: '<API_KEY>', # optional + api_secret: '<API_SECRET>', # optional + from: '<FROM>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-ruby/examples/storage/create-bucket.md new file mode 100644 index 0000000000..8bac198b6c --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/create-bucket.md @@ -0,0 +1,23 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +storage = Storage.new(client) + +result = storage.create_bucket( + bucket_id: '<BUCKET_ID>', + name: '<NAME>', + permissions: ["read("any")"], # optional + file_security: false, # optional + enabled: false, # optional + maximum_file_size: 1, # optional + allowed_file_extensions: [], # optional + compression: ::NONE, # optional + encryption: false, # optional + antivirus: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/create-file.md b/docs/examples/1.6.x/server-ruby/examples/storage/create-file.md new file mode 100644 index 0000000000..ba0c27ec86 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/create-file.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +storage = Storage.new(client) + +result = storage.create_file( + bucket_id: '<BUCKET_ID>', + file_id: '<FILE_ID>', + file: InputFile.from_path('dir/file.png'), + permissions: ["read("any")"] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-ruby/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..e765f45dd8 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/delete-bucket.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +storage = Storage.new(client) + +result = storage.delete_bucket( + bucket_id: '<BUCKET_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/delete-file.md b/docs/examples/1.6.x/server-ruby/examples/storage/delete-file.md new file mode 100644 index 0000000000..a6d90d7952 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/delete-file.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +storage = Storage.new(client) + +result = storage.delete_file( + bucket_id: '<BUCKET_ID>', + file_id: '<FILE_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-ruby/examples/storage/get-bucket.md new file mode 100644 index 0000000000..17e96a375d --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/get-bucket.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +storage = Storage.new(client) + +result = storage.get_bucket( + bucket_id: '<BUCKET_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-ruby/examples/storage/get-file-download.md new file mode 100644 index 0000000000..2a3bcb6b64 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/get-file-download.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +storage = Storage.new(client) + +result = storage.get_file_download( + bucket_id: '<BUCKET_ID>', + file_id: '<FILE_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-ruby/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..768aa9bd4b --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/get-file-preview.md @@ -0,0 +1,26 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +storage = Storage.new(client) + +result = storage.get_file_preview( + bucket_id: '<BUCKET_ID>', + file_id: '<FILE_ID>', + width: 0, # optional + height: 0, # optional + gravity: ImageGravity::CENTER, # optional + quality: 0, # optional + border_width: 0, # optional + border_color: '', # optional + border_radius: 0, # optional + opacity: 0, # optional + rotation: -360, # optional + background: '', # optional + output: ImageFormat::JPG # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-ruby/examples/storage/get-file-view.md new file mode 100644 index 0000000000..a93b62d787 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/get-file-view.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +storage = Storage.new(client) + +result = storage.get_file_view( + bucket_id: '<BUCKET_ID>', + file_id: '<FILE_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/get-file.md b/docs/examples/1.6.x/server-ruby/examples/storage/get-file.md new file mode 100644 index 0000000000..dfbd05d166 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/get-file.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +storage = Storage.new(client) + +result = storage.get_file( + bucket_id: '<BUCKET_ID>', + file_id: '<FILE_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-ruby/examples/storage/list-buckets.md new file mode 100644 index 0000000000..f2e6c63296 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/list-buckets.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +storage = Storage.new(client) + +result = storage.list_buckets( + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/list-files.md b/docs/examples/1.6.x/server-ruby/examples/storage/list-files.md new file mode 100644 index 0000000000..392639a3e0 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/list-files.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +storage = Storage.new(client) + +result = storage.list_files( + bucket_id: '<BUCKET_ID>', + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-ruby/examples/storage/update-bucket.md new file mode 100644 index 0000000000..055ea5de9d --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/update-bucket.md @@ -0,0 +1,23 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +storage = Storage.new(client) + +result = storage.update_bucket( + bucket_id: '<BUCKET_ID>', + name: '<NAME>', + permissions: ["read("any")"], # optional + file_security: false, # optional + enabled: false, # optional + maximum_file_size: 1, # optional + allowed_file_extensions: [], # optional + compression: ::NONE, # optional + encryption: false, # optional + antivirus: false # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/update-file.md b/docs/examples/1.6.x/server-ruby/examples/storage/update-file.md new file mode 100644 index 0000000000..d83780dcde --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/storage/update-file.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +storage = Storage.new(client) + +result = storage.update_file( + bucket_id: '<BUCKET_ID>', + file_id: '<FILE_ID>', + name: '<NAME>', # optional + permissions: ["read("any")"] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/create-membership.md b/docs/examples/1.6.x/server-ruby/examples/teams/create-membership.md new file mode 100644 index 0000000000..d1310df525 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/create-membership.md @@ -0,0 +1,20 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.create_membership( + team_id: '<TEAM_ID>', + roles: [], + email: 'email@example.com', # optional + user_id: '<USER_ID>', # optional + phone: '+12065550100', # optional + url: 'https://example.com', # optional + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/create.md b/docs/examples/1.6.x/server-ruby/examples/teams/create.md new file mode 100644 index 0000000000..f35023c8f3 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/create.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.create( + team_id: '<TEAM_ID>', + name: '<NAME>', + roles: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-ruby/examples/teams/delete-membership.md new file mode 100644 index 0000000000..82ab4380ce --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/delete-membership.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.delete_membership( + team_id: '<TEAM_ID>', + membership_id: '<MEMBERSHIP_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/delete.md b/docs/examples/1.6.x/server-ruby/examples/teams/delete.md new file mode 100644 index 0000000000..bd80fbd985 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/delete.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.delete( + team_id: '<TEAM_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/get-membership.md b/docs/examples/1.6.x/server-ruby/examples/teams/get-membership.md new file mode 100644 index 0000000000..0cb3d9d87e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/get-membership.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.get_membership( + team_id: '<TEAM_ID>', + membership_id: '<MEMBERSHIP_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-ruby/examples/teams/get-prefs.md new file mode 100644 index 0000000000..4cf9b58647 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/get-prefs.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.get_prefs( + team_id: '<TEAM_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/get.md b/docs/examples/1.6.x/server-ruby/examples/teams/get.md new file mode 100644 index 0000000000..bd98069ccc --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/get.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.get( + team_id: '<TEAM_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-ruby/examples/teams/list-memberships.md new file mode 100644 index 0000000000..98cc550091 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/list-memberships.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.list_memberships( + team_id: '<TEAM_ID>', + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/list.md b/docs/examples/1.6.x/server-ruby/examples/teams/list.md new file mode 100644 index 0000000000..8f375e14e8 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/list.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.list( + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-ruby/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..876c565e72 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/update-membership-status.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.update_membership_status( + team_id: '<TEAM_ID>', + membership_id: '<MEMBERSHIP_ID>', + user_id: '<USER_ID>', + secret: '<SECRET>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/update-membership.md b/docs/examples/1.6.x/server-ruby/examples/teams/update-membership.md new file mode 100644 index 0000000000..89c57fa1fa --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/update-membership.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.update_membership( + team_id: '<TEAM_ID>', + membership_id: '<MEMBERSHIP_ID>', + roles: [] +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/update-name.md b/docs/examples/1.6.x/server-ruby/examples/teams/update-name.md new file mode 100644 index 0000000000..ad628e833e --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/update-name.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.update_name( + team_id: '<TEAM_ID>', + name: '<NAME>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-ruby/examples/teams/update-prefs.md new file mode 100644 index 0000000000..a3d73497ee --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/teams/update-prefs.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_session('') # The user session to authenticate with + +teams = Teams.new(client) + +result = teams.update_prefs( + team_id: '<TEAM_ID>', + prefs: {} +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-argon2user.md new file mode 100644 index 0000000000..d67fe3c7ae --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-argon2user.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_argon2_user( + user_id: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..c68ba7562a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-bcrypt-user.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_bcrypt_user( + user_id: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-ruby/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..f92d8ecdef --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-j-w-t.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_jwt( + user_id: '<USER_ID>', + session_id: '<SESSION_ID>', # optional + duration: 0 # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..a294a5a326 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-m-d5user.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_md5_user( + user_id: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..9850d43cd7 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_mfa_recovery_codes( + user_id: '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..0e71f62a63 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-p-h-pass-user.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_ph_pass_user( + user_id: '<USER_ID>', + email: 'email@example.com', + password: 'password', + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..e44703c403 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-s-h-a-user.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_sha_user( + user_id: '<USER_ID>', + email: 'email@example.com', + password: 'password', + password_version: PasswordHash::SHA1, # optional + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..fdcbf528ea --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,20 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_scrypt_modified_user( + user_id: '<USER_ID>', + email: 'email@example.com', + password: 'password', + password_salt: '<PASSWORD_SALT>', + password_salt_separator: '<PASSWORD_SALT_SEPARATOR>', + password_signer_key: '<PASSWORD_SIGNER_KEY>', + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..581a28cc77 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-user.md @@ -0,0 +1,22 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_scrypt_user( + user_id: '<USER_ID>', + email: 'email@example.com', + password: 'password', + password_salt: '<PASSWORD_SALT>', + password_cpu: null, + password_memory: null, + password_parallel: null, + password_length: null, + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-session.md b/docs/examples/1.6.x/server-ruby/examples/users/create-session.md new file mode 100644 index 0000000000..15d7219f2d --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-session.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_session( + user_id: '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-target.md b/docs/examples/1.6.x/server-ruby/examples/users/create-target.md new file mode 100644 index 0000000000..a9441229fb --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-target.md @@ -0,0 +1,20 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_target( + user_id: '<USER_ID>', + target_id: '<TARGET_ID>', + provider_type: MessagingProviderType::EMAIL, + identifier: '<IDENTIFIER>', + provider_id: '<PROVIDER_ID>', # optional + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-token.md b/docs/examples/1.6.x/server-ruby/examples/users/create-token.md new file mode 100644 index 0000000000..8840b4b1ce --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create-token.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create_token( + user_id: '<USER_ID>', + length: 4, # optional + expire: 60 # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create.md b/docs/examples/1.6.x/server-ruby/examples/users/create.md new file mode 100644 index 0000000000..ffc6b5e4db --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/create.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.create( + user_id: '<USER_ID>', + email: 'email@example.com', # optional + phone: '+12065550100', # optional + password: '', # optional + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete-identity.md b/docs/examples/1.6.x/server-ruby/examples/users/delete-identity.md new file mode 100644 index 0000000000..366e4aee37 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/delete-identity.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.delete_identity( + identity_id: '<IDENTITY_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-ruby/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..501e68e143 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.delete_mfa_authenticator( + user_id: '<USER_ID>', + type: AuthenticatorType::TOTP +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete-session.md b/docs/examples/1.6.x/server-ruby/examples/users/delete-session.md new file mode 100644 index 0000000000..524581c9a7 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/delete-session.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.delete_session( + user_id: '<USER_ID>', + session_id: '<SESSION_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-ruby/examples/users/delete-sessions.md new file mode 100644 index 0000000000..fc8f97618a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/delete-sessions.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.delete_sessions( + user_id: '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete-target.md b/docs/examples/1.6.x/server-ruby/examples/users/delete-target.md new file mode 100644 index 0000000000..54005b686d --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/delete-target.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.delete_target( + user_id: '<USER_ID>', + target_id: '<TARGET_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete.md b/docs/examples/1.6.x/server-ruby/examples/users/delete.md new file mode 100644 index 0000000000..dca01f7612 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/delete.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.delete( + user_id: '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..3d09974493 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.get_mfa_recovery_codes( + user_id: '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/get-prefs.md b/docs/examples/1.6.x/server-ruby/examples/users/get-prefs.md new file mode 100644 index 0000000000..f4e38d9118 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/get-prefs.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.get_prefs( + user_id: '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/get-target.md b/docs/examples/1.6.x/server-ruby/examples/users/get-target.md new file mode 100644 index 0000000000..a97fca8bbc --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/get-target.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.get_target( + user_id: '<USER_ID>', + target_id: '<TARGET_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/get.md b/docs/examples/1.6.x/server-ruby/examples/users/get.md new file mode 100644 index 0000000000..143f5fc133 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/get.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.get( + user_id: '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-identities.md b/docs/examples/1.6.x/server-ruby/examples/users/list-identities.md new file mode 100644 index 0000000000..4e6a6ffc41 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/list-identities.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.list_identities( + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-logs.md b/docs/examples/1.6.x/server-ruby/examples/users/list-logs.md new file mode 100644 index 0000000000..45b7ad4ac0 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/list-logs.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.list_logs( + user_id: '<USER_ID>', + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-memberships.md b/docs/examples/1.6.x/server-ruby/examples/users/list-memberships.md new file mode 100644 index 0000000000..dc26c0e94a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/list-memberships.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.list_memberships( + user_id: '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-ruby/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..18760fb107 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/list-mfa-factors.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.list_mfa_factors( + user_id: '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-sessions.md b/docs/examples/1.6.x/server-ruby/examples/users/list-sessions.md new file mode 100644 index 0000000000..875dab433a --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/list-sessions.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.list_sessions( + user_id: '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-targets.md b/docs/examples/1.6.x/server-ruby/examples/users/list-targets.md new file mode 100644 index 0000000000..c836a08769 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/list-targets.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.list_targets( + user_id: '<USER_ID>', + queries: [] # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list.md b/docs/examples/1.6.x/server-ruby/examples/users/list.md new file mode 100644 index 0000000000..9f60f6876b --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/list.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.list( + queries: [], # optional + search: '<SEARCH>' # optional +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-ruby/examples/users/update-email-verification.md new file mode 100644 index 0000000000..2dc10ae17f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-email-verification.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_email_verification( + user_id: '<USER_ID>', + email_verification: false +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-email.md b/docs/examples/1.6.x/server-ruby/examples/users/update-email.md new file mode 100644 index 0000000000..f1ad7fd4b4 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-email.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_email( + user_id: '<USER_ID>', + email: 'email@example.com' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-labels.md b/docs/examples/1.6.x/server-ruby/examples/users/update-labels.md new file mode 100644 index 0000000000..15340763ca --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-labels.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_labels( + user_id: '<USER_ID>', + labels: [] +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..cff62e5600 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_mfa_recovery_codes( + user_id: '<USER_ID>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-mfa.md b/docs/examples/1.6.x/server-ruby/examples/users/update-mfa.md new file mode 100644 index 0000000000..b4b5d19feb --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-mfa.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_mfa( + user_id: '<USER_ID>', + mfa: false +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-name.md b/docs/examples/1.6.x/server-ruby/examples/users/update-name.md new file mode 100644 index 0000000000..e8dbfe90dd --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-name.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_name( + user_id: '<USER_ID>', + name: '<NAME>' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-password.md b/docs/examples/1.6.x/server-ruby/examples/users/update-password.md new file mode 100644 index 0000000000..57af0c6c26 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-password.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_password( + user_id: '<USER_ID>', + password: '' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-ruby/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..188c60103c --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-phone-verification.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_phone_verification( + user_id: '<USER_ID>', + phone_verification: false +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-phone.md b/docs/examples/1.6.x/server-ruby/examples/users/update-phone.md new file mode 100644 index 0000000000..2a4ce0b5cf --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-phone.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_phone( + user_id: '<USER_ID>', + number: '+12065550100' +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-prefs.md b/docs/examples/1.6.x/server-ruby/examples/users/update-prefs.md new file mode 100644 index 0000000000..866d2c2e2f --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-prefs.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_prefs( + user_id: '<USER_ID>', + prefs: {} +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-status.md b/docs/examples/1.6.x/server-ruby/examples/users/update-status.md new file mode 100644 index 0000000000..bd589e3c1d --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-status.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_status( + user_id: '<USER_ID>', + status: false +) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-target.md b/docs/examples/1.6.x/server-ruby/examples/users/update-target.md new file mode 100644 index 0000000000..a3ec8ae580 --- /dev/null +++ b/docs/examples/1.6.x/server-ruby/examples/users/update-target.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_project('<YOUR_PROJECT_ID>') # Your project ID + .set_key('<YOUR_API_KEY>') # Your secret API key + +users = Users.new(client) + +result = users.update_target( + user_id: '<USER_ID>', + target_id: '<TARGET_ID>', + identifier: '<IDENTIFIER>', # optional + provider_id: '<PROVIDER_ID>', # optional + name: '<NAME>' # optional +) diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-swift/examples/account/create-anonymous-session.md new file mode 100644 index 0000000000..6392cc4728 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-anonymous-session.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.createAnonymousSession() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-swift/examples/account/create-email-password-session.md new file mode 100644 index 0000000000..2ff62e4c3d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-email-password-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.createEmailPasswordSession( + email: "email@example.com", + password: "password" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-email-token.md b/docs/examples/1.6.x/server-swift/examples/account/create-email-token.md new file mode 100644 index 0000000000..1da4ecb425 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-email-token.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.createEmailToken( + userId: "<USER_ID>", + email: "email@example.com", + phrase: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-swift/examples/account/create-j-w-t.md new file mode 100644 index 0000000000..ade54e673e --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-j-w-t.md @@ -0,0 +1,10 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let jwt = try await account.createJWT() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-swift/examples/account/create-magic-u-r-l-token.md new file mode 100644 index 0000000000..83d763c871 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-magic-u-r-l-token.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.createMagicURLToken( + userId: "<USER_ID>", + email: "email@example.com", + url: "https://example.com", // optional + phrase: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-swift/examples/account/create-mfa-authenticator.md new file mode 100644 index 0000000000..1d1bf46013 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-mfa-authenticator.md @@ -0,0 +1,14 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let mfaType = try await account.createMfaAuthenticator( + type: .totp +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-swift/examples/account/create-mfa-challenge.md new file mode 100644 index 0000000000..3798884fde --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-mfa-challenge.md @@ -0,0 +1,13 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let mfaChallenge = try await account.createMfaChallenge( + factor: .email +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/account/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..acbd337f21 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let mfaRecoveryCodes = try await account.createMfaRecoveryCodes() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-swift/examples/account/create-o-auth2token.md new file mode 100644 index 0000000000..4224c6b4c3 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-o-auth2token.md @@ -0,0 +1,16 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let success = try await account.createOAuth2Token( + provider: .amazon, + success: "https://example.com", // optional + failure: "https://example.com", // optional + scopes: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-swift/examples/account/create-phone-token.md new file mode 100644 index 0000000000..f8cff783f4 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-phone-token.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let token = try await account.createPhoneToken( + userId: "<USER_ID>", + phone: "+12065550100" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-swift/examples/account/create-phone-verification.md new file mode 100644 index 0000000000..3d2af4aed5 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-phone-verification.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let token = try await account.createPhoneVerification() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-recovery.md b/docs/examples/1.6.x/server-swift/examples/account/create-recovery.md new file mode 100644 index 0000000000..3926a8616d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-recovery.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let token = try await account.createRecovery( + email: "email@example.com", + url: "https://example.com" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-session.md b/docs/examples/1.6.x/server-swift/examples/account/create-session.md new file mode 100644 index 0000000000..2bdecc74d3 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.createSession( + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-verification.md b/docs/examples/1.6.x/server-swift/examples/account/create-verification.md new file mode 100644 index 0000000000..96b414c9f4 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create-verification.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let token = try await account.createVerification( + url: "https://example.com" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/create.md b/docs/examples/1.6.x/server-swift/examples/account/create.md new file mode 100644 index 0000000000..cb8dd109bb --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/create.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let user = try await account.create( + userId: "<USER_ID>", + email: "email@example.com", + password: "", + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/delete-identity.md b/docs/examples/1.6.x/server-swift/examples/account/delete-identity.md new file mode 100644 index 0000000000..1a25053fbb --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/delete-identity.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let result = try await account.deleteIdentity( + identityId: "<IDENTITY_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-swift/examples/account/delete-mfa-authenticator.md new file mode 100644 index 0000000000..6d8854a809 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/delete-mfa-authenticator.md @@ -0,0 +1,14 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let result = try await account.deleteMfaAuthenticator( + type: .totp +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/delete-session.md b/docs/examples/1.6.x/server-swift/examples/account/delete-session.md new file mode 100644 index 0000000000..e452a6c13a --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/delete-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let result = try await account.deleteSession( + sessionId: "<SESSION_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-swift/examples/account/delete-sessions.md new file mode 100644 index 0000000000..08f667cca5 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/delete-sessions.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let result = try await account.deleteSessions() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/account/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..d8d30b3a06 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/get-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let mfaRecoveryCodes = try await account.getMfaRecoveryCodes() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/get-prefs.md b/docs/examples/1.6.x/server-swift/examples/account/get-prefs.md new file mode 100644 index 0000000000..eed98330e0 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/get-prefs.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let preferences = try await account.getPrefs() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/get-session.md b/docs/examples/1.6.x/server-swift/examples/account/get-session.md new file mode 100644 index 0000000000..6f3bce3ec1 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/get-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let session = try await account.getSession( + sessionId: "<SESSION_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/get.md b/docs/examples/1.6.x/server-swift/examples/account/get.md new file mode 100644 index 0000000000..80ae68232e --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/get.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let user = try await account.get() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/list-identities.md b/docs/examples/1.6.x/server-swift/examples/account/list-identities.md new file mode 100644 index 0000000000..175508b3c0 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/list-identities.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let identityList = try await account.listIdentities( + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/list-logs.md b/docs/examples/1.6.x/server-swift/examples/account/list-logs.md new file mode 100644 index 0000000000..c2e505a78a --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/list-logs.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let logList = try await account.listLogs( + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-swift/examples/account/list-mfa-factors.md new file mode 100644 index 0000000000..41dd98aab1 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/list-mfa-factors.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let mfaFactors = try await account.listMfaFactors() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/list-sessions.md b/docs/examples/1.6.x/server-swift/examples/account/list-sessions.md new file mode 100644 index 0000000000..922c8f305c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/list-sessions.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let sessionList = try await account.listSessions() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-email.md b/docs/examples/1.6.x/server-swift/examples/account/update-email.md new file mode 100644 index 0000000000..7a94b49610 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-email.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let user = try await account.updateEmail( + email: "email@example.com", + password: "password" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-swift/examples/account/update-m-f-a.md new file mode 100644 index 0000000000..46c849d678 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-m-f-a.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let user = try await account.updateMFA( + mfa: false +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-swift/examples/account/update-magic-u-r-l-session.md new file mode 100644 index 0000000000..6571266959 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-magic-u-r-l-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.updateMagicURLSession( + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-swift/examples/account/update-mfa-authenticator.md new file mode 100644 index 0000000000..2bb3ce7430 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-mfa-authenticator.md @@ -0,0 +1,15 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let user = try await account.updateMfaAuthenticator( + type: .totp, + otp: "<OTP>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-swift/examples/account/update-mfa-challenge.md new file mode 100644 index 0000000000..2eac96d81b --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-mfa-challenge.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let result = try await account.updateMfaChallenge( + challengeId: "<CHALLENGE_ID>", + otp: "<OTP>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/account/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..f06ede45e9 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-mfa-recovery-codes.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let mfaRecoveryCodes = try await account.updateMfaRecoveryCodes() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-name.md b/docs/examples/1.6.x/server-swift/examples/account/update-name.md new file mode 100644 index 0000000000..d51f9d26aa --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-name.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let user = try await account.updateName( + name: "<NAME>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-password.md b/docs/examples/1.6.x/server-swift/examples/account/update-password.md new file mode 100644 index 0000000000..d9232b8c7c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-password.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let user = try await account.updatePassword( + password: "", + oldPassword: "password" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-swift/examples/account/update-phone-session.md new file mode 100644 index 0000000000..df1feae1e3 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-phone-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + +let account = Account(client) + +let session = try await account.updatePhoneSession( + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-swift/examples/account/update-phone-verification.md new file mode 100644 index 0000000000..20085acf7d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-phone-verification.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let token = try await account.updatePhoneVerification( + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-phone.md b/docs/examples/1.6.x/server-swift/examples/account/update-phone.md new file mode 100644 index 0000000000..c7c817bd74 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-phone.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let user = try await account.updatePhone( + phone: "+12065550100", + password: "password" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-prefs.md b/docs/examples/1.6.x/server-swift/examples/account/update-prefs.md new file mode 100644 index 0000000000..3fc0a9cae1 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-prefs.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let user = try await account.updatePrefs( + prefs: [:] +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-recovery.md b/docs/examples/1.6.x/server-swift/examples/account/update-recovery.md new file mode 100644 index 0000000000..0b8d463322 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-recovery.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let token = try await account.updateRecovery( + userId: "<USER_ID>", + secret: "<SECRET>", + password: "" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-session.md b/docs/examples/1.6.x/server-swift/examples/account/update-session.md new file mode 100644 index 0000000000..40b88d801e --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let session = try await account.updateSession( + sessionId: "<SESSION_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-status.md b/docs/examples/1.6.x/server-swift/examples/account/update-status.md new file mode 100644 index 0000000000..1d2f7f220d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-status.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let user = try await account.updateStatus() + diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-verification.md b/docs/examples/1.6.x/server-swift/examples/account/update-verification.md new file mode 100644 index 0000000000..07c1131206 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/account/update-verification.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let account = Account(client) + +let token = try await account.updateVerification( + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-browser.md new file mode 100644 index 0000000000..3ac6c599db --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/avatars/get-browser.md @@ -0,0 +1,17 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let avatars = Avatars(client) + +let bytes = try await avatars.getBrowser( + code: .avantBrowser, + width: 0, // optional + height: 0, // optional + quality: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-credit-card.md new file mode 100644 index 0000000000..306ceb843a --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/avatars/get-credit-card.md @@ -0,0 +1,17 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let avatars = Avatars(client) + +let bytes = try await avatars.getCreditCard( + code: .americanExpress, + width: 0, // optional + height: 0, // optional + quality: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-favicon.md new file mode 100644 index 0000000000..9121f07043 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/avatars/get-favicon.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let avatars = Avatars(client) + +let bytes = try await avatars.getFavicon( + url: "https://example.com" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-flag.md new file mode 100644 index 0000000000..3c9bd75859 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/avatars/get-flag.md @@ -0,0 +1,17 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let avatars = Avatars(client) + +let bytes = try await avatars.getFlag( + code: .afghanistan, + width: 0, // optional + height: 0, // optional + quality: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-image.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-image.md new file mode 100644 index 0000000000..e32b51535d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/avatars/get-image.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let avatars = Avatars(client) + +let bytes = try await avatars.getImage( + url: "https://example.com", + width: 0, // optional + height: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-initials.md new file mode 100644 index 0000000000..bba05387d4 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/avatars/get-initials.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let avatars = Avatars(client) + +let bytes = try await avatars.getInitials( + name: "<NAME>", // optional + width: 0, // optional + height: 0, // optional + background: "" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-q-r.md new file mode 100644 index 0000000000..d84500b8de --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/avatars/get-q-r.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let avatars = Avatars(client) + +let bytes = try await avatars.getQR( + text: "<TEXT>", + size: 1, // optional + margin: 0, // optional + download: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-boolean-attribute.md new file mode 100644 index 0000000000..ac737f72f9 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-boolean-attribute.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeBoolean = try await databases.createBooleanAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: false, // optional + array: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-collection.md b/docs/examples/1.6.x/server-swift/examples/databases/create-collection.md new file mode 100644 index 0000000000..46984d4c5a --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-collection.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let collection = try await databases.createCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + name: "<NAME>", + permissions: ["read("any")"], // optional + documentSecurity: false, // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-datetime-attribute.md new file mode 100644 index 0000000000..e88ecbc759 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-datetime-attribute.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeDatetime = try await databases.createDatetimeAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "", // optional + array: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-document.md b/docs/examples/1.6.x/server-swift/examples/databases/create-document.md new file mode 100644 index 0000000000..78ea97b607 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-document.md @@ -0,0 +1,17 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let databases = Databases(client) + +let document = try await databases.createDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: [:], + permissions: ["read("any")"] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-email-attribute.md new file mode 100644 index 0000000000..f0325b83e1 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-email-attribute.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeEmail = try await databases.createEmailAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "email@example.com", // optional + array: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-enum-attribute.md new file mode 100644 index 0000000000..3773e7eff8 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-enum-attribute.md @@ -0,0 +1,19 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeEnum = try await databases.createEnumAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + elements: [], + required: false, + default: "<DEFAULT>", // optional + array: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-float-attribute.md new file mode 100644 index 0000000000..e303345c87 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-float-attribute.md @@ -0,0 +1,20 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeFloat = try await databases.createFloatAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, // optional + max: 0, // optional + default: 0, // optional + array: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-index.md b/docs/examples/1.6.x/server-swift/examples/databases/create-index.md new file mode 100644 index 0000000000..6f8d526bfe --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-index.md @@ -0,0 +1,19 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let index = try await databases.createIndex( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + type: .key, + attributes: [], + orders: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-integer-attribute.md new file mode 100644 index 0000000000..f51508c574 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-integer-attribute.md @@ -0,0 +1,20 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeInteger = try await databases.createIntegerAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, // optional + max: 0, // optional + default: 0, // optional + array: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-ip-attribute.md new file mode 100644 index 0000000000..57283b5179 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-ip-attribute.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeIp = try await databases.createIpAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "", // optional + array: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-relationship-attribute.md new file mode 100644 index 0000000000..8ed18bf84e --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-relationship-attribute.md @@ -0,0 +1,21 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeRelationship = try await databases.createRelationshipAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + relatedCollectionId: "<RELATED_COLLECTION_ID>", + type: .oneToOne, + twoWay: false, // optional + key: "", // optional + twoWayKey: "", // optional + onDelete: .cascade // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-string-attribute.md new file mode 100644 index 0000000000..eb6a42c176 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-string-attribute.md @@ -0,0 +1,20 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeString = try await databases.createStringAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + size: 1, + required: false, + default: "<DEFAULT>", // optional + array: false, // optional + encrypt: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-url-attribute.md new file mode 100644 index 0000000000..79773fed10 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create-url-attribute.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeUrl = try await databases.createUrlAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "https://example.com", // optional + array: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create.md b/docs/examples/1.6.x/server-swift/examples/databases/create.md new file mode 100644 index 0000000000..9ce32c48bc --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/create.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let database = try await databases.create( + databaseId: "<DATABASE_ID>", + name: "<NAME>", + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/delete-attribute.md new file mode 100644 index 0000000000..b2eeb4acb9 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/delete-attribute.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let result = try await databases.deleteAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-swift/examples/databases/delete-collection.md new file mode 100644 index 0000000000..987ecee9b5 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/delete-collection.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let result = try await databases.deleteCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/delete-document.md b/docs/examples/1.6.x/server-swift/examples/databases/delete-document.md new file mode 100644 index 0000000000..38a1ae2bb4 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/delete-document.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let databases = Databases(client) + +let result = try await databases.deleteDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/delete-index.md b/docs/examples/1.6.x/server-swift/examples/databases/delete-index.md new file mode 100644 index 0000000000..e07f1a9acc --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/delete-index.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let result = try await databases.deleteIndex( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/delete.md b/docs/examples/1.6.x/server-swift/examples/databases/delete.md new file mode 100644 index 0000000000..101fa3527f --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/delete.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let result = try await databases.delete( + databaseId: "<DATABASE_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/get-attribute.md new file mode 100644 index 0000000000..3395449166 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/get-attribute.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let result = try await databases.getAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/get-collection.md b/docs/examples/1.6.x/server-swift/examples/databases/get-collection.md new file mode 100644 index 0000000000..f99d553e2d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/get-collection.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let collection = try await databases.getCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/get-document.md b/docs/examples/1.6.x/server-swift/examples/databases/get-document.md new file mode 100644 index 0000000000..dee5699341 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/get-document.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let databases = Databases(client) + +let document = try await databases.getDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/get-index.md b/docs/examples/1.6.x/server-swift/examples/databases/get-index.md new file mode 100644 index 0000000000..1ab80c9bc9 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/get-index.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let index = try await databases.getIndex( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/get.md b/docs/examples/1.6.x/server-swift/examples/databases/get.md new file mode 100644 index 0000000000..ecddbc2c1d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/get.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let database = try await databases.get( + databaseId: "<DATABASE_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-swift/examples/databases/list-attributes.md new file mode 100644 index 0000000000..15393cb5ca --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/list-attributes.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeList = try await databases.listAttributes( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/list-collections.md b/docs/examples/1.6.x/server-swift/examples/databases/list-collections.md new file mode 100644 index 0000000000..96f68b6187 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/list-collections.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let collectionList = try await databases.listCollections( + databaseId: "<DATABASE_ID>", + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/list-documents.md b/docs/examples/1.6.x/server-swift/examples/databases/list-documents.md new file mode 100644 index 0000000000..8fc3698337 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/list-documents.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let databases = Databases(client) + +let documentList = try await databases.listDocuments( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-swift/examples/databases/list-indexes.md new file mode 100644 index 0000000000..cdfcca859c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/list-indexes.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let indexList = try await databases.listIndexes( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/list.md b/docs/examples/1.6.x/server-swift/examples/databases/list.md new file mode 100644 index 0000000000..8236f5d49c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/list.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let databaseList = try await databases.list( + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-boolean-attribute.md new file mode 100644 index 0000000000..354aaddcdd --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-boolean-attribute.md @@ -0,0 +1,17 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeBoolean = try await databases.updateBooleanAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: false +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-collection.md b/docs/examples/1.6.x/server-swift/examples/databases/update-collection.md new file mode 100644 index 0000000000..1d1d062017 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-collection.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let collection = try await databases.updateCollection( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + name: "<NAME>", + permissions: ["read("any")"], // optional + documentSecurity: false, // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-datetime-attribute.md new file mode 100644 index 0000000000..1bdcef6d27 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-datetime-attribute.md @@ -0,0 +1,17 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeDatetime = try await databases.updateDatetimeAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-document.md b/docs/examples/1.6.x/server-swift/examples/databases/update-document.md new file mode 100644 index 0000000000..d00bf5dad2 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-document.md @@ -0,0 +1,17 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let databases = Databases(client) + +let document = try await databases.updateDocument( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + documentId: "<DOCUMENT_ID>", + data: [:], // optional + permissions: ["read("any")"] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-email-attribute.md new file mode 100644 index 0000000000..8cc4630ae8 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-email-attribute.md @@ -0,0 +1,17 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeEmail = try await databases.updateEmailAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "email@example.com" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-enum-attribute.md new file mode 100644 index 0000000000..ac9f1bdb5d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-enum-attribute.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeEnum = try await databases.updateEnumAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + elements: [], + required: false, + default: "<DEFAULT>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-float-attribute.md new file mode 100644 index 0000000000..faee58b2ae --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-float-attribute.md @@ -0,0 +1,19 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeFloat = try await databases.updateFloatAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0 +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-integer-attribute.md new file mode 100644 index 0000000000..a91d97d3ce --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-integer-attribute.md @@ -0,0 +1,19 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeInteger = try await databases.updateIntegerAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + min: 0, + max: 0, + default: 0 +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-ip-attribute.md new file mode 100644 index 0000000000..895700a0a1 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-ip-attribute.md @@ -0,0 +1,17 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeIp = try await databases.updateIpAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-relationship-attribute.md new file mode 100644 index 0000000000..7b4f399d3b --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-relationship-attribute.md @@ -0,0 +1,17 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeRelationship = try await databases.updateRelationshipAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + onDelete: .cascade // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-string-attribute.md new file mode 100644 index 0000000000..102e4b7ace --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-string-attribute.md @@ -0,0 +1,17 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeString = try await databases.updateStringAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "<DEFAULT>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-url-attribute.md new file mode 100644 index 0000000000..bc081e08ee --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update-url-attribute.md @@ -0,0 +1,17 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let attributeUrl = try await databases.updateUrlAttribute( + databaseId: "<DATABASE_ID>", + collectionId: "<COLLECTION_ID>", + key: "", + required: false, + default: "https://example.com" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update.md b/docs/examples/1.6.x/server-swift/examples/databases/update.md new file mode 100644 index 0000000000..3b49ba065a --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/databases/update.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let databases = Databases(client) + +let database = try await databases.update( + databaseId: "<DATABASE_ID>", + name: "<NAME>", + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/create-build.md b/docs/examples/1.6.x/server-swift/examples/functions/create-build.md new file mode 100644 index 0000000000..bddaf6e361 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/create-build.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let result = try await functions.createBuild( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>", + buildId: "<BUILD_ID>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-swift/examples/functions/create-deployment.md new file mode 100644 index 0000000000..ea2e8dff76 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/create-deployment.md @@ -0,0 +1,17 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let deployment = try await functions.createDeployment( + functionId: "<FUNCTION_ID>", + code: InputFile.fromPath("file.png"), + activate: false, + entrypoint: "<ENTRYPOINT>", // optional + commands: "<COMMANDS>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/create-execution.md b/docs/examples/1.6.x/server-swift/examples/functions/create-execution.md new file mode 100644 index 0000000000..9acfdea4d7 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/create-execution.md @@ -0,0 +1,20 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let functions = Functions(client) + +let execution = try await functions.createExecution( + functionId: "<FUNCTION_ID>", + body: "<BODY>", // optional + async: false, // optional + path: "<PATH>", // optional + method: .gET, // optional + headers: [:], // optional + scheduledAt: "" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/create-variable.md b/docs/examples/1.6.x/server-swift/examples/functions/create-variable.md new file mode 100644 index 0000000000..e1cd7275fa --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/create-variable.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let variable = try await functions.createVariable( + functionId: "<FUNCTION_ID>", + key: "<KEY>", + value: "<VALUE>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/create.md b/docs/examples/1.6.x/server-swift/examples/functions/create.md new file mode 100644 index 0000000000..e508281f63 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/create.md @@ -0,0 +1,34 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let function = try await functions.create( + functionId: "<FUNCTION_ID>", + name: "<NAME>", + runtime: .node145, + execute: ["any"], // optional + events: [], // optional + schedule: "", // optional + timeout: 1, // optional + enabled: false, // optional + logging: false, // optional + entrypoint: "<ENTRYPOINT>", // optional + commands: "<COMMANDS>", // optional + scopes: [], // optional + installationId: "<INSTALLATION_ID>", // optional + providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", // optional + providerBranch: "<PROVIDER_BRANCH>", // optional + providerSilentMode: false, // optional + providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", // optional + templateRepository: "<TEMPLATE_REPOSITORY>", // optional + templateOwner: "<TEMPLATE_OWNER>", // optional + templateRootDirectory: "<TEMPLATE_ROOT_DIRECTORY>", // optional + templateBranch: "<TEMPLATE_BRANCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-swift/examples/functions/delete-deployment.md new file mode 100644 index 0000000000..177cc5e2fa --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/delete-deployment.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let result = try await functions.deleteDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-swift/examples/functions/delete-execution.md new file mode 100644 index 0000000000..8d04d87d78 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/delete-execution.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let result = try await functions.deleteExecution( + functionId: "<FUNCTION_ID>", + executionId: "<EXECUTION_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-swift/examples/functions/delete-variable.md new file mode 100644 index 0000000000..5f31d46d48 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/delete-variable.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let result = try await functions.deleteVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/delete.md b/docs/examples/1.6.x/server-swift/examples/functions/delete.md new file mode 100644 index 0000000000..1999a00645 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/delete.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let result = try await functions.delete( + functionId: "<FUNCTION_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-swift/examples/functions/download-deployment.md new file mode 100644 index 0000000000..5e50b6798d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/download-deployment.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let bytes = try await functions.downloadDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-swift/examples/functions/get-deployment.md new file mode 100644 index 0000000000..a4ce8a7ab2 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/get-deployment.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let deployment = try await functions.getDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/get-execution.md b/docs/examples/1.6.x/server-swift/examples/functions/get-execution.md new file mode 100644 index 0000000000..8358745800 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/get-execution.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let functions = Functions(client) + +let execution = try await functions.getExecution( + functionId: "<FUNCTION_ID>", + executionId: "<EXECUTION_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/get-variable.md b/docs/examples/1.6.x/server-swift/examples/functions/get-variable.md new file mode 100644 index 0000000000..25452ac852 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/get-variable.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let variable = try await functions.getVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/get.md b/docs/examples/1.6.x/server-swift/examples/functions/get.md new file mode 100644 index 0000000000..27721b7ca2 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/get.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let function = try await functions.get( + functionId: "<FUNCTION_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-swift/examples/functions/list-deployments.md new file mode 100644 index 0000000000..2f7c5e09df --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/list-deployments.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let deploymentList = try await functions.listDeployments( + functionId: "<FUNCTION_ID>", + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/list-executions.md b/docs/examples/1.6.x/server-swift/examples/functions/list-executions.md new file mode 100644 index 0000000000..ec12403095 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/list-executions.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let functions = Functions(client) + +let executionList = try await functions.listExecutions( + functionId: "<FUNCTION_ID>", + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-swift/examples/functions/list-runtimes.md new file mode 100644 index 0000000000..8c75286cd9 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/list-runtimes.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let runtimeList = try await functions.listRuntimes() + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/list-variables.md b/docs/examples/1.6.x/server-swift/examples/functions/list-variables.md new file mode 100644 index 0000000000..d82c9fda8c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/list-variables.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let variableList = try await functions.listVariables( + functionId: "<FUNCTION_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/list.md b/docs/examples/1.6.x/server-swift/examples/functions/list.md new file mode 100644 index 0000000000..6f5a848080 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/list.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let functionList = try await functions.list( + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-swift/examples/functions/update-deployment-build.md new file mode 100644 index 0000000000..4c96a5548e --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/update-deployment-build.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let build = try await functions.updateDeploymentBuild( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-swift/examples/functions/update-deployment.md new file mode 100644 index 0000000000..7e28c63b60 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/update-deployment.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let function = try await functions.updateDeployment( + functionId: "<FUNCTION_ID>", + deploymentId: "<DEPLOYMENT_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/update-variable.md b/docs/examples/1.6.x/server-swift/examples/functions/update-variable.md new file mode 100644 index 0000000000..8a72e387ed --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/update-variable.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let variable = try await functions.updateVariable( + functionId: "<FUNCTION_ID>", + variableId: "<VARIABLE_ID>", + key: "<KEY>", + value: "<VALUE>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/functions/update.md b/docs/examples/1.6.x/server-swift/examples/functions/update.md new file mode 100644 index 0000000000..61a0f00a45 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/functions/update.md @@ -0,0 +1,30 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let functions = Functions(client) + +let function = try await functions.update( + functionId: "<FUNCTION_ID>", + name: "<NAME>", + runtime: .node145, // optional + execute: ["any"], // optional + events: [], // optional + schedule: "", // optional + timeout: 1, // optional + enabled: false, // optional + logging: false, // optional + entrypoint: "<ENTRYPOINT>", // optional + commands: "<COMMANDS>", // optional + scopes: [], // optional + installationId: "<INSTALLATION_ID>", // optional + providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", // optional + providerBranch: "<PROVIDER_BRANCH>", // optional + providerSilentMode: false, // optional + providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/graphql/mutation.md b/docs/examples/1.6.x/server-swift/examples/graphql/mutation.md new file mode 100644 index 0000000000..808526faca --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/graphql/mutation.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let graphql = Graphql(client) + +let any = try await graphql.mutation( + query: [:] +) + diff --git a/docs/examples/1.6.x/server-swift/examples/graphql/query.md b/docs/examples/1.6.x/server-swift/examples/graphql/query.md new file mode 100644 index 0000000000..a528957dee --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/graphql/query.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let graphql = Graphql(client) + +let any = try await graphql.query( + query: [:] +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-swift/examples/health/get-antivirus.md new file mode 100644 index 0000000000..5ff9d324c8 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-antivirus.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthAntivirus = try await health.getAntivirus() + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-cache.md b/docs/examples/1.6.x/server-swift/examples/health/get-cache.md new file mode 100644 index 0000000000..74e304cf65 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-cache.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthStatus = try await health.getCache() + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-certificate.md b/docs/examples/1.6.x/server-swift/examples/health/get-certificate.md new file mode 100644 index 0000000000..5fcb837854 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-certificate.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthCertificate = try await health.getCertificate( + domain: "" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-d-b.md b/docs/examples/1.6.x/server-swift/examples/health/get-d-b.md new file mode 100644 index 0000000000..e3b7e50545 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-d-b.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthStatus = try await health.getDB() + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-swift/examples/health/get-failed-jobs.md new file mode 100644 index 0000000000..6727f0bd26 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-failed-jobs.md @@ -0,0 +1,15 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getFailedJobs( + name: .v1Database, + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-swift/examples/health/get-pub-sub.md new file mode 100644 index 0000000000..ef2cd3aac7 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-pub-sub.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthStatus = try await health.getPubSub() + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-builds.md new file mode 100644 index 0000000000..d583a7e218 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-builds.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueBuilds( + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-certificates.md new file mode 100644 index 0000000000..80b933ec9c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-certificates.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueCertificates( + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-databases.md new file mode 100644 index 0000000000..b45ab17ee7 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-databases.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueDatabases( + name: "<NAME>", // optional + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-deletes.md new file mode 100644 index 0000000000..611700f658 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-deletes.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueDeletes( + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-functions.md new file mode 100644 index 0000000000..6defa5064c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-functions.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueFunctions( + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-logs.md new file mode 100644 index 0000000000..e09daf2c43 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-logs.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueLogs( + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-mails.md new file mode 100644 index 0000000000..9e01f9a002 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-mails.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueMails( + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-messaging.md new file mode 100644 index 0000000000..b8c053a5b2 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-messaging.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueMessaging( + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-migrations.md new file mode 100644 index 0000000000..73a6e2585a --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-migrations.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueMigrations( + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage-dump.md new file mode 100644 index 0000000000..b17cf475cc --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage-dump.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueUsageDump( + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage.md new file mode 100644 index 0000000000..ce37f408af --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueUsage( + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-webhooks.md new file mode 100644 index 0000000000..f4ed9ec359 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue-webhooks.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthQueue = try await health.getQueueWebhooks( + threshold: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue.md new file mode 100644 index 0000000000..d36883534f --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-queue.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthStatus = try await health.getQueue() + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-swift/examples/health/get-storage-local.md new file mode 100644 index 0000000000..4044ba2a88 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-storage-local.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthStatus = try await health.getStorageLocal() + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-storage.md b/docs/examples/1.6.x/server-swift/examples/health/get-storage.md new file mode 100644 index 0000000000..761aace556 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-storage.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthStatus = try await health.getStorage() + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-time.md b/docs/examples/1.6.x/server-swift/examples/health/get-time.md new file mode 100644 index 0000000000..af085626d0 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get-time.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthTime = try await health.getTime() + diff --git a/docs/examples/1.6.x/server-swift/examples/health/get.md b/docs/examples/1.6.x/server-swift/examples/health/get.md new file mode 100644 index 0000000000..e63e18c0c7 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/health/get.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let health = Health(client) + +let healthStatus = try await health.get() + diff --git a/docs/examples/1.6.x/server-swift/examples/locale/get.md b/docs/examples/1.6.x/server-swift/examples/locale/get.md new file mode 100644 index 0000000000..b94af37813 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/locale/get.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let locale = Locale(client) + +let locale = try await locale.get() + diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-codes.md b/docs/examples/1.6.x/server-swift/examples/locale/list-codes.md new file mode 100644 index 0000000000..247f8f3b38 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/locale/list-codes.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let locale = Locale(client) + +let localeCodeList = try await locale.listCodes() + diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-continents.md b/docs/examples/1.6.x/server-swift/examples/locale/list-continents.md new file mode 100644 index 0000000000..481a205659 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/locale/list-continents.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let locale = Locale(client) + +let continentList = try await locale.listContinents() + diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-swift/examples/locale/list-countries-e-u.md new file mode 100644 index 0000000000..047877daca --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/locale/list-countries-e-u.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let locale = Locale(client) + +let countryList = try await locale.listCountriesEU() + diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-swift/examples/locale/list-countries-phones.md new file mode 100644 index 0000000000..c7e182af88 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/locale/list-countries-phones.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let locale = Locale(client) + +let phoneList = try await locale.listCountriesPhones() + diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-countries.md b/docs/examples/1.6.x/server-swift/examples/locale/list-countries.md new file mode 100644 index 0000000000..e0ec084114 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/locale/list-countries.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let locale = Locale(client) + +let countryList = try await locale.listCountries() + diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-swift/examples/locale/list-currencies.md new file mode 100644 index 0000000000..280909d482 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/locale/list-currencies.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let locale = Locale(client) + +let currencyList = try await locale.listCurrencies() + diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-languages.md b/docs/examples/1.6.x/server-swift/examples/locale/list-languages.md new file mode 100644 index 0000000000..1dcc6ddf56 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/locale/list-languages.md @@ -0,0 +1,11 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let locale = Locale(client) + +let languageList = try await locale.listLanguages() + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-apns-provider.md new file mode 100644 index 0000000000..f38b435371 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-apns-provider.md @@ -0,0 +1,20 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.createApnsProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + authKey: "<AUTH_KEY>", // optional + authKeyId: "<AUTH_KEY_ID>", // optional + teamId: "<TEAM_ID>", // optional + bundleId: "<BUNDLE_ID>", // optional + sandbox: false, // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-email.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-email.md new file mode 100644 index 0000000000..ede0a3b1b8 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-email.md @@ -0,0 +1,24 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let message = try await messaging.createEmail( + messageId: "<MESSAGE_ID>", + subject: "<SUBJECT>", + content: "<CONTENT>", + topics: [], // optional + users: [], // optional + targets: [], // optional + cc: [], // optional + bcc: [], // optional + attachments: [], // optional + draft: false, // optional + html: false, // optional + scheduledAt: "" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-fcm-provider.md new file mode 100644 index 0000000000..b4e8df3f6d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-fcm-provider.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.createFcmProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + serviceAccountJSON: [:], // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-mailgun-provider.md new file mode 100644 index 0000000000..c5f958bb52 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-mailgun-provider.md @@ -0,0 +1,22 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.createMailgunProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + apiKey: "<API_KEY>", // optional + domain: "<DOMAIN>", // optional + isEuRegion: false, // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "email@example.com", // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-msg91provider.md new file mode 100644 index 0000000000..8e3905160d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-msg91provider.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.createMsg91Provider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + templateId: "<TEMPLATE_ID>", // optional + senderId: "<SENDER_ID>", // optional + authKey: "<AUTH_KEY>", // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-push.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-push.md new file mode 100644 index 0000000000..7aed2b5792 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-push.md @@ -0,0 +1,28 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let message = try await messaging.createPush( + messageId: "<MESSAGE_ID>", + title: "<TITLE>", + body: "<BODY>", + topics: [], // optional + users: [], // optional + targets: [], // optional + data: [:], // optional + action: "<ACTION>", // optional + image: "[ID1:ID2]", // optional + icon: "<ICON>", // optional + sound: "<SOUND>", // optional + color: "<COLOR>", // optional + tag: "<TAG>", // optional + badge: "<BADGE>", // optional + draft: false, // optional + scheduledAt: "" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-sendgrid-provider.md new file mode 100644 index 0000000000..22d1f05e1d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-sendgrid-provider.md @@ -0,0 +1,20 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.createSendgridProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + apiKey: "<API_KEY>", // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "email@example.com", // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-sms.md new file mode 100644 index 0000000000..10936dbd66 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-sms.md @@ -0,0 +1,19 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let message = try await messaging.createSms( + messageId: "<MESSAGE_ID>", + content: "<CONTENT>", + topics: [], // optional + users: [], // optional + targets: [], // optional + draft: false, // optional + scheduledAt: "" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-smtp-provider.md new file mode 100644 index 0000000000..bd0d4c05a8 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-smtp-provider.md @@ -0,0 +1,27 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.createSmtpProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + host: "<HOST>", + port: 1, // optional + username: "<USERNAME>", // optional + password: "<PASSWORD>", // optional + encryption: .none, // optional + autoTLS: false, // optional + mailer: "<MAILER>", // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "email@example.com", // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-subscriber.md new file mode 100644 index 0000000000..170a3072c0 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-subscriber.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setJWT("<YOUR_JWT>") // Your secret JSON Web Token + +let messaging = Messaging(client) + +let subscriber = try await messaging.createSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>", + targetId: "<TARGET_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-telesign-provider.md new file mode 100644 index 0000000000..bc4ab89728 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-telesign-provider.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.createTelesignProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", // optional + customerId: "<CUSTOMER_ID>", // optional + apiKey: "<API_KEY>", // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-textmagic-provider.md new file mode 100644 index 0000000000..735bd57fa1 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-textmagic-provider.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.createTextmagicProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", // optional + username: "<USERNAME>", // optional + apiKey: "<API_KEY>", // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-topic.md new file mode 100644 index 0000000000..f44aa65d56 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-topic.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let topic = try await messaging.createTopic( + topicId: "<TOPIC_ID>", + name: "<NAME>", + subscribe: ["any"] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-twilio-provider.md new file mode 100644 index 0000000000..8a3594dcfb --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-twilio-provider.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.createTwilioProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", // optional + accountSid: "<ACCOUNT_SID>", // optional + authToken: "<AUTH_TOKEN>", // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-vonage-provider.md new file mode 100644 index 0000000000..0a932e599f --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/create-vonage-provider.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.createVonageProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", + from: "+12065550100", // optional + apiKey: "<API_KEY>", // optional + apiSecret: "<API_SECRET>", // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/delete-provider.md new file mode 100644 index 0000000000..2a8f049140 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/delete-provider.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let result = try await messaging.deleteProvider( + providerId: "<PROVIDER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-swift/examples/messaging/delete-subscriber.md new file mode 100644 index 0000000000..ea1f54641e --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/delete-subscriber.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setJWT("<YOUR_JWT>") // Your secret JSON Web Token + +let messaging = Messaging(client) + +let result = try await messaging.deleteSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-swift/examples/messaging/delete-topic.md new file mode 100644 index 0000000000..76c7c7b821 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/delete-topic.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let result = try await messaging.deleteTopic( + topicId: "<TOPIC_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/delete.md b/docs/examples/1.6.x/server-swift/examples/messaging/delete.md new file mode 100644 index 0000000000..e94f4b99f2 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/delete.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let result = try await messaging.delete( + messageId: "<MESSAGE_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/get-message.md b/docs/examples/1.6.x/server-swift/examples/messaging/get-message.md new file mode 100644 index 0000000000..27256d8f71 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/get-message.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let message = try await messaging.getMessage( + messageId: "<MESSAGE_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/get-provider.md new file mode 100644 index 0000000000..7647290df1 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/get-provider.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.getProvider( + providerId: "<PROVIDER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-swift/examples/messaging/get-subscriber.md new file mode 100644 index 0000000000..ebccc358c8 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/get-subscriber.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let subscriber = try await messaging.getSubscriber( + topicId: "<TOPIC_ID>", + subscriberId: "<SUBSCRIBER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-swift/examples/messaging/get-topic.md new file mode 100644 index 0000000000..421023cce4 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/get-topic.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let topic = try await messaging.getTopic( + topicId: "<TOPIC_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-message-logs.md new file mode 100644 index 0000000000..61d2ceccf1 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/list-message-logs.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let logList = try await messaging.listMessageLogs( + messageId: "<MESSAGE_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-messages.md new file mode 100644 index 0000000000..8912603782 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/list-messages.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let messageList = try await messaging.listMessages( + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-provider-logs.md new file mode 100644 index 0000000000..2ad9cd78df --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/list-provider-logs.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let logList = try await messaging.listProviderLogs( + providerId: "<PROVIDER_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-providers.md new file mode 100644 index 0000000000..0bce1e78a5 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/list-providers.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let providerList = try await messaging.listProviders( + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-subscriber-logs.md new file mode 100644 index 0000000000..78dea44090 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/list-subscriber-logs.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let logList = try await messaging.listSubscriberLogs( + subscriberId: "<SUBSCRIBER_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-subscribers.md new file mode 100644 index 0000000000..35b3daa16e --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/list-subscribers.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let subscriberList = try await messaging.listSubscribers( + topicId: "<TOPIC_ID>", + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-targets.md new file mode 100644 index 0000000000..e469da31b3 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/list-targets.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let targetList = try await messaging.listTargets( + messageId: "<MESSAGE_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-topic-logs.md new file mode 100644 index 0000000000..c8d13bf82b --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/list-topic-logs.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let logList = try await messaging.listTopicLogs( + topicId: "<TOPIC_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-topics.md new file mode 100644 index 0000000000..3a6ba4c5df --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/list-topics.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let topicList = try await messaging.listTopics( + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000000..7202530cc7 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-apns-provider.md @@ -0,0 +1,20 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.updateApnsProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + authKey: "<AUTH_KEY>", // optional + authKeyId: "<AUTH_KEY_ID>", // optional + teamId: "<TEAM_ID>", // optional + bundleId: "<BUNDLE_ID>", // optional + sandbox: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-email.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-email.md new file mode 100644 index 0000000000..e27c826281 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-email.md @@ -0,0 +1,24 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let message = try await messaging.updateEmail( + messageId: "<MESSAGE_ID>", + topics: [], // optional + users: [], // optional + targets: [], // optional + subject: "<SUBJECT>", // optional + content: "<CONTENT>", // optional + draft: false, // optional + html: false, // optional + cc: [], // optional + bcc: [], // optional + scheduledAt: "", // optional + attachments: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-fcm-provider.md new file mode 100644 index 0000000000..b62ba88f8f --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-fcm-provider.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.updateFcmProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + serviceAccountJSON: [:] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-mailgun-provider.md new file mode 100644 index 0000000000..d684a96ca8 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-mailgun-provider.md @@ -0,0 +1,22 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.updateMailgunProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + apiKey: "<API_KEY>", // optional + domain: "<DOMAIN>", // optional + isEuRegion: false, // optional + enabled: false, // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "<REPLY_TO_EMAIL>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-msg91provider.md new file mode 100644 index 0000000000..aac6942de4 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-msg91provider.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.updateMsg91Provider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + templateId: "<TEMPLATE_ID>", // optional + senderId: "<SENDER_ID>", // optional + authKey: "<AUTH_KEY>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-push.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-push.md new file mode 100644 index 0000000000..c793143610 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-push.md @@ -0,0 +1,28 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let message = try await messaging.updatePush( + messageId: "<MESSAGE_ID>", + topics: [], // optional + users: [], // optional + targets: [], // optional + title: "<TITLE>", // optional + body: "<BODY>", // optional + data: [:], // optional + action: "<ACTION>", // optional + image: "[ID1:ID2]", // optional + icon: "<ICON>", // optional + sound: "<SOUND>", // optional + color: "<COLOR>", // optional + tag: "<TAG>", // optional + badge: 0, // optional + draft: false, // optional + scheduledAt: "" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-sendgrid-provider.md new file mode 100644 index 0000000000..811fb05aca --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-sendgrid-provider.md @@ -0,0 +1,20 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.updateSendgridProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + apiKey: "<API_KEY>", // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "<REPLY_TO_EMAIL>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-sms.md new file mode 100644 index 0000000000..db1262ed81 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-sms.md @@ -0,0 +1,19 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let message = try await messaging.updateSms( + messageId: "<MESSAGE_ID>", + topics: [], // optional + users: [], // optional + targets: [], // optional + content: "<CONTENT>", // optional + draft: false, // optional + scheduledAt: "" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-smtp-provider.md new file mode 100644 index 0000000000..98f7a212e7 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-smtp-provider.md @@ -0,0 +1,27 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.updateSmtpProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + host: "<HOST>", // optional + port: 1, // optional + username: "<USERNAME>", // optional + password: "<PASSWORD>", // optional + encryption: .none, // optional + autoTLS: false, // optional + mailer: "<MAILER>", // optional + fromName: "<FROM_NAME>", // optional + fromEmail: "email@example.com", // optional + replyToName: "<REPLY_TO_NAME>", // optional + replyToEmail: "<REPLY_TO_EMAIL>", // optional + enabled: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-telesign-provider.md new file mode 100644 index 0000000000..cc3f0ea608 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-telesign-provider.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.updateTelesignProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + customerId: "<CUSTOMER_ID>", // optional + apiKey: "<API_KEY>", // optional + from: "<FROM>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-textmagic-provider.md new file mode 100644 index 0000000000..68961c41bc --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-textmagic-provider.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.updateTextmagicProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + username: "<USERNAME>", // optional + apiKey: "<API_KEY>", // optional + from: "<FROM>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-topic.md new file mode 100644 index 0000000000..5abbf7adcc --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-topic.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let topic = try await messaging.updateTopic( + topicId: "<TOPIC_ID>", + name: "<NAME>", // optional + subscribe: ["any"] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-twilio-provider.md new file mode 100644 index 0000000000..a48f18c0e1 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-twilio-provider.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.updateTwilioProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + accountSid: "<ACCOUNT_SID>", // optional + authToken: "<AUTH_TOKEN>", // optional + from: "<FROM>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-vonage-provider.md new file mode 100644 index 0000000000..1c8e47c26f --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/messaging/update-vonage-provider.md @@ -0,0 +1,18 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let messaging = Messaging(client) + +let provider = try await messaging.updateVonageProvider( + providerId: "<PROVIDER_ID>", + name: "<NAME>", // optional + enabled: false, // optional + apiKey: "<API_KEY>", // optional + apiSecret: "<API_SECRET>", // optional + from: "<FROM>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-swift/examples/storage/create-bucket.md new file mode 100644 index 0000000000..7c934ec8bd --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/create-bucket.md @@ -0,0 +1,23 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let storage = Storage(client) + +let bucket = try await storage.createBucket( + bucketId: "<BUCKET_ID>", + name: "<NAME>", + permissions: ["read("any")"], // optional + fileSecurity: false, // optional + enabled: false, // optional + maximumFileSize: 1, // optional + allowedFileExtensions: [], // optional + compression: .none, // optional + encryption: false, // optional + antivirus: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/create-file.md b/docs/examples/1.6.x/server-swift/examples/storage/create-file.md new file mode 100644 index 0000000000..7ce485ad50 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/create-file.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let storage = Storage(client) + +let file = try await storage.createFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + file: InputFile.fromPath("file.png"), + permissions: ["read("any")"] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-swift/examples/storage/delete-bucket.md new file mode 100644 index 0000000000..e85ce3b386 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/delete-bucket.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let storage = Storage(client) + +let result = try await storage.deleteBucket( + bucketId: "<BUCKET_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/delete-file.md b/docs/examples/1.6.x/server-swift/examples/storage/delete-file.md new file mode 100644 index 0000000000..8a9ceee18c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/delete-file.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let storage = Storage(client) + +let result = try await storage.deleteFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-swift/examples/storage/get-bucket.md new file mode 100644 index 0000000000..4e78e32c9d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/get-bucket.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let storage = Storage(client) + +let bucket = try await storage.getBucket( + bucketId: "<BUCKET_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-swift/examples/storage/get-file-download.md new file mode 100644 index 0000000000..be3db0c946 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/get-file-download.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let storage = Storage(client) + +let bytes = try await storage.getFileDownload( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-swift/examples/storage/get-file-preview.md new file mode 100644 index 0000000000..cab3fc67f4 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/get-file-preview.md @@ -0,0 +1,26 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let storage = Storage(client) + +let bytes = try await storage.getFilePreview( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + width: 0, // optional + height: 0, // optional + gravity: .center, // optional + quality: 0, // optional + borderWidth: 0, // optional + borderColor: "", // optional + borderRadius: 0, // optional + opacity: 0, // optional + rotation: -360, // optional + background: "", // optional + output: .jpg // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-swift/examples/storage/get-file-view.md new file mode 100644 index 0000000000..d1275a76b0 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/get-file-view.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let storage = Storage(client) + +let bytes = try await storage.getFileView( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/get-file.md b/docs/examples/1.6.x/server-swift/examples/storage/get-file.md new file mode 100644 index 0000000000..1f70f49543 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/get-file.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let storage = Storage(client) + +let file = try await storage.getFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-swift/examples/storage/list-buckets.md new file mode 100644 index 0000000000..9fb0b4ea46 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/list-buckets.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let storage = Storage(client) + +let bucketList = try await storage.listBuckets( + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/list-files.md b/docs/examples/1.6.x/server-swift/examples/storage/list-files.md new file mode 100644 index 0000000000..cb415b0b6c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/list-files.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let storage = Storage(client) + +let fileList = try await storage.listFiles( + bucketId: "<BUCKET_ID>", + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-swift/examples/storage/update-bucket.md new file mode 100644 index 0000000000..adb1c35673 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/update-bucket.md @@ -0,0 +1,23 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let storage = Storage(client) + +let bucket = try await storage.updateBucket( + bucketId: "<BUCKET_ID>", + name: "<NAME>", + permissions: ["read("any")"], // optional + fileSecurity: false, // optional + enabled: false, // optional + maximumFileSize: 1, // optional + allowedFileExtensions: [], // optional + compression: .none, // optional + encryption: false, // optional + antivirus: false // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/storage/update-file.md b/docs/examples/1.6.x/server-swift/examples/storage/update-file.md new file mode 100644 index 0000000000..068509959d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/storage/update-file.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let storage = Storage(client) + +let file = try await storage.updateFile( + bucketId: "<BUCKET_ID>", + fileId: "<FILE_ID>", + name: "<NAME>", // optional + permissions: ["read("any")"] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/create-membership.md b/docs/examples/1.6.x/server-swift/examples/teams/create-membership.md new file mode 100644 index 0000000000..f4d79427d6 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/create-membership.md @@ -0,0 +1,19 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let membership = try await teams.createMembership( + teamId: "<TEAM_ID>", + roles: [], + email: "email@example.com", // optional + userId: "<USER_ID>", // optional + phone: "+12065550100", // optional + url: "https://example.com", // optional + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/create.md b/docs/examples/1.6.x/server-swift/examples/teams/create.md new file mode 100644 index 0000000000..a3e2249aa8 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/create.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let team = try await teams.create( + teamId: "<TEAM_ID>", + name: "<NAME>", + roles: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-swift/examples/teams/delete-membership.md new file mode 100644 index 0000000000..dac308b836 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/delete-membership.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let result = try await teams.deleteMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/delete.md b/docs/examples/1.6.x/server-swift/examples/teams/delete.md new file mode 100644 index 0000000000..0014ac0f5e --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/delete.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let result = try await teams.delete( + teamId: "<TEAM_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/get-membership.md b/docs/examples/1.6.x/server-swift/examples/teams/get-membership.md new file mode 100644 index 0000000000..6d9627f417 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/get-membership.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let membership = try await teams.getMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-swift/examples/teams/get-prefs.md new file mode 100644 index 0000000000..00d2c94be6 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/get-prefs.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let preferences = try await teams.getPrefs( + teamId: "<TEAM_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/get.md b/docs/examples/1.6.x/server-swift/examples/teams/get.md new file mode 100644 index 0000000000..14da194222 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/get.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let team = try await teams.get( + teamId: "<TEAM_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-swift/examples/teams/list-memberships.md new file mode 100644 index 0000000000..14268f97ab --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/list-memberships.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let membershipList = try await teams.listMemberships( + teamId: "<TEAM_ID>", + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/list.md b/docs/examples/1.6.x/server-swift/examples/teams/list.md new file mode 100644 index 0000000000..c0ab352788 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/list.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let teamList = try await teams.list( + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-swift/examples/teams/update-membership-status.md new file mode 100644 index 0000000000..c6ea9590b5 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/update-membership-status.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let membership = try await teams.updateMembershipStatus( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + userId: "<USER_ID>", + secret: "<SECRET>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/update-membership.md b/docs/examples/1.6.x/server-swift/examples/teams/update-membership.md new file mode 100644 index 0000000000..234274000b --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/update-membership.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let membership = try await teams.updateMembership( + teamId: "<TEAM_ID>", + membershipId: "<MEMBERSHIP_ID>", + roles: [] +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/update-name.md b/docs/examples/1.6.x/server-swift/examples/teams/update-name.md new file mode 100644 index 0000000000..450884ba79 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/update-name.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let team = try await teams.updateName( + teamId: "<TEAM_ID>", + name: "<NAME>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-swift/examples/teams/update-prefs.md new file mode 100644 index 0000000000..4f5e1d1c6d --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/teams/update-prefs.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setSession("") // The user session to authenticate with + +let teams = Teams(client) + +let preferences = try await teams.updatePrefs( + teamId: "<TEAM_ID>", + prefs: [:] +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-swift/examples/users/create-argon2user.md new file mode 100644 index 0000000000..af9bc4b628 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-argon2user.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.createArgon2User( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-swift/examples/users/create-bcrypt-user.md new file mode 100644 index 0000000000..fa65ed9f5c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-bcrypt-user.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.createBcryptUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-swift/examples/users/create-j-w-t.md new file mode 100644 index 0000000000..4bb01a7041 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-j-w-t.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let jwt = try await users.createJWT( + userId: "<USER_ID>", + sessionId: "<SESSION_ID>", // optional + duration: 0 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-swift/examples/users/create-m-d5user.md new file mode 100644 index 0000000000..7dac068827 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-m-d5user.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.createMD5User( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/users/create-mfa-recovery-codes.md new file mode 100644 index 0000000000..d525d6acf0 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-mfa-recovery-codes.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let mfaRecoveryCodes = try await users.createMfaRecoveryCodes( + userId: "<USER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-swift/examples/users/create-p-h-pass-user.md new file mode 100644 index 0000000000..1c9f2dc373 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-p-h-pass-user.md @@ -0,0 +1,16 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.createPHPassUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-swift/examples/users/create-s-h-a-user.md new file mode 100644 index 0000000000..e05f420e51 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-s-h-a-user.md @@ -0,0 +1,18 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.createSHAUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordVersion: .sha1, // optional + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-modified-user.md new file mode 100644 index 0000000000..d994e8a85c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-modified-user.md @@ -0,0 +1,19 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.createScryptModifiedUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordSalt: "<PASSWORD_SALT>", + passwordSaltSeparator: "<PASSWORD_SALT_SEPARATOR>", + passwordSignerKey: "<PASSWORD_SIGNER_KEY>", + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-user.md new file mode 100644 index 0000000000..12790311cd --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-user.md @@ -0,0 +1,21 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.createScryptUser( + userId: "<USER_ID>", + email: "email@example.com", + password: "password", + passwordSalt: "<PASSWORD_SALT>", + passwordCpu: 0, + passwordMemory: 0, + passwordParallel: 0, + passwordLength: 0, + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-session.md b/docs/examples/1.6.x/server-swift/examples/users/create-session.md new file mode 100644 index 0000000000..f27717c401 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-session.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let session = try await users.createSession( + userId: "<USER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-target.md b/docs/examples/1.6.x/server-swift/examples/users/create-target.md new file mode 100644 index 0000000000..9eaf28d9fa --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-target.md @@ -0,0 +1,19 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let target = try await users.createTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>", + providerType: .email, + identifier: "<IDENTIFIER>", + providerId: "<PROVIDER_ID>", // optional + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-token.md b/docs/examples/1.6.x/server-swift/examples/users/create-token.md new file mode 100644 index 0000000000..bc5691bcae --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create-token.md @@ -0,0 +1,15 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let token = try await users.createToken( + userId: "<USER_ID>", + length: 4, // optional + expire: 60 // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/create.md b/docs/examples/1.6.x/server-swift/examples/users/create.md new file mode 100644 index 0000000000..4bd7474519 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/create.md @@ -0,0 +1,17 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.create( + userId: "<USER_ID>", + email: "email@example.com", // optional + phone: "+12065550100", // optional + password: "", // optional + name: "<NAME>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete-identity.md b/docs/examples/1.6.x/server-swift/examples/users/delete-identity.md new file mode 100644 index 0000000000..3003a4f514 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/delete-identity.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let result = try await users.deleteIdentity( + identityId: "<IDENTITY_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-swift/examples/users/delete-mfa-authenticator.md new file mode 100644 index 0000000000..b96ce46d16 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/delete-mfa-authenticator.md @@ -0,0 +1,15 @@ +import Appwrite +import AppwriteEnums + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.deleteMfaAuthenticator( + userId: "<USER_ID>", + type: .totp +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete-session.md b/docs/examples/1.6.x/server-swift/examples/users/delete-session.md new file mode 100644 index 0000000000..f9e4856bfb --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/delete-session.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let result = try await users.deleteSession( + userId: "<USER_ID>", + sessionId: "<SESSION_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-swift/examples/users/delete-sessions.md new file mode 100644 index 0000000000..87a73d5e13 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/delete-sessions.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let result = try await users.deleteSessions( + userId: "<USER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete-target.md b/docs/examples/1.6.x/server-swift/examples/users/delete-target.md new file mode 100644 index 0000000000..f628f39f4e --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/delete-target.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let result = try await users.deleteTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete.md b/docs/examples/1.6.x/server-swift/examples/users/delete.md new file mode 100644 index 0000000000..76aabd11f8 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/delete.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let result = try await users.delete( + userId: "<USER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/users/get-mfa-recovery-codes.md new file mode 100644 index 0000000000..db8a01d9f2 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/get-mfa-recovery-codes.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let mfaRecoveryCodes = try await users.getMfaRecoveryCodes( + userId: "<USER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/get-prefs.md b/docs/examples/1.6.x/server-swift/examples/users/get-prefs.md new file mode 100644 index 0000000000..732a00b65b --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/get-prefs.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let preferences = try await users.getPrefs( + userId: "<USER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/get-target.md b/docs/examples/1.6.x/server-swift/examples/users/get-target.md new file mode 100644 index 0000000000..8217a3ec43 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/get-target.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let target = try await users.getTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/get.md b/docs/examples/1.6.x/server-swift/examples/users/get.md new file mode 100644 index 0000000000..221d3c9338 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/get.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.get( + userId: "<USER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-identities.md b/docs/examples/1.6.x/server-swift/examples/users/list-identities.md new file mode 100644 index 0000000000..21ed27b106 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/list-identities.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let identityList = try await users.listIdentities( + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-logs.md b/docs/examples/1.6.x/server-swift/examples/users/list-logs.md new file mode 100644 index 0000000000..e078c2a2eb --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/list-logs.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let logList = try await users.listLogs( + userId: "<USER_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-memberships.md b/docs/examples/1.6.x/server-swift/examples/users/list-memberships.md new file mode 100644 index 0000000000..86fbf72326 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/list-memberships.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let membershipList = try await users.listMemberships( + userId: "<USER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-swift/examples/users/list-mfa-factors.md new file mode 100644 index 0000000000..87b123bc40 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/list-mfa-factors.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let mfaFactors = try await users.listMfaFactors( + userId: "<USER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-sessions.md b/docs/examples/1.6.x/server-swift/examples/users/list-sessions.md new file mode 100644 index 0000000000..3c494e35a8 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/list-sessions.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let sessionList = try await users.listSessions( + userId: "<USER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-targets.md b/docs/examples/1.6.x/server-swift/examples/users/list-targets.md new file mode 100644 index 0000000000..541715c2a4 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/list-targets.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let targetList = try await users.listTargets( + userId: "<USER_ID>", + queries: [] // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/list.md b/docs/examples/1.6.x/server-swift/examples/users/list.md new file mode 100644 index 0000000000..0bc4d85ed2 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/list.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let userList = try await users.list( + queries: [], // optional + search: "<SEARCH>" // optional +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-swift/examples/users/update-email-verification.md new file mode 100644 index 0000000000..de43107c44 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-email-verification.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.updateEmailVerification( + userId: "<USER_ID>", + emailVerification: false +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-email.md b/docs/examples/1.6.x/server-swift/examples/users/update-email.md new file mode 100644 index 0000000000..5cbf2ef6bf --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-email.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.updateEmail( + userId: "<USER_ID>", + email: "email@example.com" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-labels.md b/docs/examples/1.6.x/server-swift/examples/users/update-labels.md new file mode 100644 index 0000000000..37341941c4 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-labels.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.updateLabels( + userId: "<USER_ID>", + labels: [] +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/users/update-mfa-recovery-codes.md new file mode 100644 index 0000000000..48de0abe52 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-mfa-recovery-codes.md @@ -0,0 +1,13 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let mfaRecoveryCodes = try await users.updateMfaRecoveryCodes( + userId: "<USER_ID>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-mfa.md b/docs/examples/1.6.x/server-swift/examples/users/update-mfa.md new file mode 100644 index 0000000000..0612a31643 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-mfa.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.updateMfa( + userId: "<USER_ID>", + mfa: false +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-name.md b/docs/examples/1.6.x/server-swift/examples/users/update-name.md new file mode 100644 index 0000000000..03914f95a5 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-name.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.updateName( + userId: "<USER_ID>", + name: "<NAME>" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-password.md b/docs/examples/1.6.x/server-swift/examples/users/update-password.md new file mode 100644 index 0000000000..054875c23b --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-password.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.updatePassword( + userId: "<USER_ID>", + password: "" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-swift/examples/users/update-phone-verification.md new file mode 100644 index 0000000000..b0a3fe89f3 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-phone-verification.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.updatePhoneVerification( + userId: "<USER_ID>", + phoneVerification: false +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-phone.md b/docs/examples/1.6.x/server-swift/examples/users/update-phone.md new file mode 100644 index 0000000000..d29676f2b8 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-phone.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.updatePhone( + userId: "<USER_ID>", + number: "+12065550100" +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-prefs.md b/docs/examples/1.6.x/server-swift/examples/users/update-prefs.md new file mode 100644 index 0000000000..19d2aadaca --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-prefs.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let preferences = try await users.updatePrefs( + userId: "<USER_ID>", + prefs: [:] +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-status.md b/docs/examples/1.6.x/server-swift/examples/users/update-status.md new file mode 100644 index 0000000000..90ea4f6c25 --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-status.md @@ -0,0 +1,14 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let user = try await users.updateStatus( + userId: "<USER_ID>", + status: false +) + diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-target.md b/docs/examples/1.6.x/server-swift/examples/users/update-target.md new file mode 100644 index 0000000000..d06d616f3c --- /dev/null +++ b/docs/examples/1.6.x/server-swift/examples/users/update-target.md @@ -0,0 +1,17 @@ +import Appwrite + +let client = Client() + .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint + .setProject("<YOUR_PROJECT_ID>") // Your project ID + .setKey("<YOUR_API_KEY>") // Your secret API key + +let users = Users(client) + +let target = try await users.updateTarget( + userId: "<USER_ID>", + targetId: "<TARGET_ID>", + identifier: "<IDENTIFIER>", // optional + providerId: "<PROVIDER_ID>", // optional + name: "<NAME>" // optional +) + diff --git a/src/Appwrite/Platform/Tasks/SDKs.php b/src/Appwrite/Platform/Tasks/SDKs.php index 22b3234027..70a6ad163f 100644 --- a/src/Appwrite/Platform/Tasks/SDKs.php +++ b/src/Appwrite/Platform/Tasks/SDKs.php @@ -50,7 +50,7 @@ class SDKs extends Action $production = ($git) ? (Console::confirm('Type "Appwrite" to push code to production git repos') == 'Appwrite') : false; $message = ($git) ? Console::confirm('Please enter your commit message:') : ''; - if (!in_array($version, ['0.6.x', '0.7.x', '0.8.x', '0.9.x', '0.10.x', '0.11.x', '0.12.x', '0.13.x', '0.14.x', '0.15.x', '1.0.x', '1.1.x', '1.2.x', '1.3.x', '1.4.x', '1.5.x', 'latest'])) { + if (!in_array($version, ['0.6.x', '0.7.x', '0.8.x', '0.9.x', '0.10.x', '0.11.x', '0.12.x', '0.13.x', '0.14.x', '0.15.x', '1.0.x', '1.1.x', '1.2.x', '1.3.x', '1.4.x', '1.5.x', '1.6.x', 'latest'])) { throw new \Exception('Unknown version given'); } From a5ef5f3d7536b56a632e9391262d1c9aa96251e0 Mon Sep 17 00:00:00 2001 From: Bradley Schofield <ionicisere@gmail.com> Date: Wed, 10 Jul 2024 16:34:02 +0900 Subject: [PATCH 5/6] Fix Lock --- composer.lock | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/composer.lock b/composer.lock index e0e6628e43..cf3aaec13b 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "06f391b62842a79736fe3fe77ec82adf", + "content-hash": "f5f5f624d7edf2e0a405f4669ae8f672", "packages": [ { "name": "adhocore/jwt", @@ -3157,16 +3157,16 @@ }, { "name": "laravel/pint", - "version": "v1.16.1", + "version": "v1.16.2", "source": { "type": "git", "url": "https://github.com/laravel/pint.git", - "reference": "9266a47f1b9231b83e0cfd849009547329d871b1" + "reference": "51f1ba679a6afe0315621ad143d788bd7ded0eca" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/laravel/pint/zipball/9266a47f1b9231b83e0cfd849009547329d871b1", - "reference": "9266a47f1b9231b83e0cfd849009547329d871b1", + "url": "https://api.github.com/repos/laravel/pint/zipball/51f1ba679a6afe0315621ad143d788bd7ded0eca", + "reference": "51f1ba679a6afe0315621ad143d788bd7ded0eca", "shasum": "" }, "require": { @@ -3219,7 +3219,7 @@ "issues": "https://github.com/laravel/pint/issues", "source": "https://github.com/laravel/pint" }, - "time": "2024-06-18T16:50:05+00:00" + "time": "2024-07-09T15:58:08+00:00" }, { "name": "matthiasmullie/minify", From 801f22856ccbcf3d54975c85bc0a45c5b9ae69f2 Mon Sep 17 00:00:00 2001 From: Bradley Schofield <ionicisere@gmail.com> Date: Wed, 10 Jul 2024 16:34:41 +0900 Subject: [PATCH 6/6] Remove 1.6.x generated docs --- .../java/account/create-anonymous-session.md | 18 ------ .../account/create-email-password-session.md | 23 -------- .../java/account/create-email-token.md | 24 -------- .../java/account/create-j-w-t.md | 18 ------ .../java/account/create-magic-u-r-l-token.md | 25 -------- .../java/account/create-mfa-authenticator.md | 23 -------- .../java/account/create-mfa-challenge.md | 23 -------- .../java/account/create-mfa-recovery-codes.md | 18 ------ .../java/account/create-o-auth2session.md | 26 --------- .../java/account/create-o-auth2token.md | 26 --------- .../java/account/create-phone-token.md | 23 -------- .../java/account/create-phone-verification.md | 18 ------ .../java/account/create-push-target.md | 24 -------- .../java/account/create-recovery.md | 23 -------- .../java/account/create-session.md | 23 -------- .../java/account/create-verification.md | 22 ------- .../client-android/java/account/create.md | 25 -------- .../java/account/delete-identity.md | 22 ------- .../java/account/delete-mfa-authenticator.md | 23 -------- .../java/account/delete-push-target.md | 22 ------- .../java/account/delete-session.md | 22 ------- .../java/account/delete-sessions.md | 18 ------ .../java/account/get-mfa-recovery-codes.md | 18 ------ .../client-android/java/account/get-prefs.md | 18 ------ .../java/account/get-session.md | 22 ------- .../1.6.x/client-android/java/account/get.md | 18 ------ .../java/account/list-identities.md | 22 ------- .../client-android/java/account/list-logs.md | 22 ------- .../java/account/list-mfa-factors.md | 18 ------ .../java/account/list-sessions.md | 18 ------ .../java/account/update-email.md | 23 -------- .../java/account/update-m-f-a.md | 22 ------- .../account/update-magic-u-r-l-session.md | 23 -------- .../java/account/update-mfa-authenticator.md | 24 -------- .../java/account/update-mfa-challenge.md | 23 -------- .../java/account/update-mfa-recovery-codes.md | 18 ------ .../java/account/update-name.md | 22 ------- .../java/account/update-password.md | 23 -------- .../java/account/update-phone-session.md | 23 -------- .../java/account/update-phone-verification.md | 23 -------- .../java/account/update-phone.md | 23 -------- .../java/account/update-prefs.md | 22 ------- .../java/account/update-push-target.md | 23 -------- .../java/account/update-recovery.md | 24 -------- .../java/account/update-session.md | 22 ------- .../java/account/update-status.md | 18 ------ .../java/account/update-verification.md | 23 -------- .../java/avatars/get-browser.md | 26 --------- .../java/avatars/get-credit-card.md | 26 --------- .../java/avatars/get-favicon.md | 22 ------- .../client-android/java/avatars/get-flag.md | 26 --------- .../client-android/java/avatars/get-image.md | 24 -------- .../java/avatars/get-initials.md | 25 -------- .../client-android/java/avatars/get-q-r.md | 25 -------- .../java/databases/create-document.md | 26 --------- .../java/databases/delete-document.md | 24 -------- .../java/databases/get-document.md | 25 -------- .../java/databases/list-documents.md | 24 -------- .../java/databases/update-document.md | 26 --------- .../java/functions/create-execution.md | 28 --------- .../java/functions/get-execution.md | 23 -------- .../java/functions/list-executions.md | 24 -------- .../client-android/java/graphql/mutation.md | 22 ------- .../client-android/java/graphql/query.md | 22 ------- .../1.6.x/client-android/java/locale/get.md | 18 ------ .../client-android/java/locale/list-codes.md | 18 ------ .../java/locale/list-continents.md | 18 ------ .../java/locale/list-countries-e-u.md | 18 ------ .../java/locale/list-countries-phones.md | 18 ------ .../java/locale/list-countries.md | 18 ------ .../java/locale/list-currencies.md | 18 ------ .../java/locale/list-languages.md | 18 ------ .../java/messaging/create-subscriber.md | 24 -------- .../java/messaging/delete-subscriber.md | 23 -------- .../java/storage/create-file.md | 26 --------- .../java/storage/delete-file.md | 23 -------- .../java/storage/get-file-download.md | 23 -------- .../java/storage/get-file-preview.md | 34 ----------- .../java/storage/get-file-view.md | 23 -------- .../client-android/java/storage/get-file.md | 23 -------- .../client-android/java/storage/list-files.md | 24 -------- .../java/storage/update-file.md | 25 -------- .../java/teams/create-membership.md | 28 --------- .../1.6.x/client-android/java/teams/create.md | 24 -------- .../java/teams/delete-membership.md | 23 -------- .../1.6.x/client-android/java/teams/delete.md | 22 ------- .../java/teams/get-membership.md | 23 -------- .../client-android/java/teams/get-prefs.md | 22 ------- .../1.6.x/client-android/java/teams/get.md | 22 ------- .../java/teams/list-memberships.md | 24 -------- .../1.6.x/client-android/java/teams/list.md | 23 -------- .../java/teams/update-membership-status.md | 25 -------- .../java/teams/update-membership.md | 24 -------- .../client-android/java/teams/update-name.md | 23 -------- .../client-android/java/teams/update-prefs.md | 23 -------- .../account/create-anonymous-session.md | 11 ---- .../account/create-email-password-session.md | 14 ----- .../kotlin/account/create-email-token.md | 15 ----- .../kotlin/account/create-j-w-t.md | 11 ---- .../account/create-magic-u-r-l-token.md | 16 ------ .../account/create-mfa-authenticator.md | 14 ----- .../kotlin/account/create-mfa-challenge.md | 14 ----- .../account/create-mfa-recovery-codes.md | 11 ---- .../kotlin/account/create-o-auth2session.md | 17 ------ .../kotlin/account/create-o-auth2token.md | 17 ------ .../kotlin/account/create-phone-token.md | 14 ----- .../account/create-phone-verification.md | 11 ---- .../kotlin/account/create-push-target.md | 15 ----- .../kotlin/account/create-recovery.md | 14 ----- .../kotlin/account/create-session.md | 14 ----- .../kotlin/account/create-verification.md | 13 ----- .../client-android/kotlin/account/create.md | 16 ------ .../kotlin/account/delete-identity.md | 13 ----- .../account/delete-mfa-authenticator.md | 14 ----- .../kotlin/account/delete-push-target.md | 13 ----- .../kotlin/account/delete-session.md | 13 ----- .../kotlin/account/delete-sessions.md | 11 ---- .../kotlin/account/get-mfa-recovery-codes.md | 11 ---- .../kotlin/account/get-prefs.md | 11 ---- .../kotlin/account/get-session.md | 13 ----- .../client-android/kotlin/account/get.md | 11 ---- .../kotlin/account/list-identities.md | 13 ----- .../kotlin/account/list-logs.md | 13 ----- .../kotlin/account/list-mfa-factors.md | 11 ---- .../kotlin/account/list-sessions.md | 11 ---- .../kotlin/account/update-email.md | 14 ----- .../kotlin/account/update-m-f-a.md | 13 ----- .../account/update-magic-u-r-l-session.md | 14 ----- .../account/update-mfa-authenticator.md | 15 ----- .../kotlin/account/update-mfa-challenge.md | 14 ----- .../account/update-mfa-recovery-codes.md | 11 ---- .../kotlin/account/update-name.md | 13 ----- .../kotlin/account/update-password.md | 14 ----- .../kotlin/account/update-phone-session.md | 14 ----- .../account/update-phone-verification.md | 14 ----- .../kotlin/account/update-phone.md | 14 ----- .../kotlin/account/update-prefs.md | 13 ----- .../kotlin/account/update-push-target.md | 14 ----- .../kotlin/account/update-recovery.md | 15 ----- .../kotlin/account/update-session.md | 13 ----- .../kotlin/account/update-status.md | 11 ---- .../kotlin/account/update-verification.md | 14 ----- .../kotlin/avatars/get-browser.md | 17 ------ .../kotlin/avatars/get-credit-card.md | 17 ------ .../kotlin/avatars/get-favicon.md | 13 ----- .../client-android/kotlin/avatars/get-flag.md | 17 ------ .../kotlin/avatars/get-image.md | 15 ----- .../kotlin/avatars/get-initials.md | 16 ------ .../client-android/kotlin/avatars/get-q-r.md | 16 ------ .../kotlin/databases/create-document.md | 17 ------ .../kotlin/databases/delete-document.md | 15 ----- .../kotlin/databases/get-document.md | 16 ------ .../kotlin/databases/list-documents.md | 15 ----- .../kotlin/databases/update-document.md | 17 ------ .../kotlin/functions/create-execution.md | 19 ------- .../kotlin/functions/get-execution.md | 14 ----- .../kotlin/functions/list-executions.md | 15 ----- .../client-android/kotlin/graphql/mutation.md | 13 ----- .../client-android/kotlin/graphql/query.md | 13 ----- .../1.6.x/client-android/kotlin/locale/get.md | 11 ---- .../kotlin/locale/list-codes.md | 11 ---- .../kotlin/locale/list-continents.md | 11 ---- .../kotlin/locale/list-countries-e-u.md | 11 ---- .../kotlin/locale/list-countries-phones.md | 11 ---- .../kotlin/locale/list-countries.md | 11 ---- .../kotlin/locale/list-currencies.md | 11 ---- .../kotlin/locale/list-languages.md | 11 ---- .../kotlin/messaging/create-subscriber.md | 15 ----- .../kotlin/messaging/delete-subscriber.md | 14 ----- .../kotlin/storage/create-file.md | 17 ------ .../kotlin/storage/delete-file.md | 14 ----- .../kotlin/storage/get-file-download.md | 14 ----- .../kotlin/storage/get-file-preview.md | 25 -------- .../kotlin/storage/get-file-view.md | 14 ----- .../client-android/kotlin/storage/get-file.md | 14 ----- .../kotlin/storage/list-files.md | 15 ----- .../kotlin/storage/update-file.md | 16 ------ .../kotlin/teams/create-membership.md | 19 ------- .../client-android/kotlin/teams/create.md | 15 ----- .../kotlin/teams/delete-membership.md | 14 ----- .../client-android/kotlin/teams/delete.md | 13 ----- .../kotlin/teams/get-membership.md | 14 ----- .../client-android/kotlin/teams/get-prefs.md | 13 ----- .../1.6.x/client-android/kotlin/teams/get.md | 13 ----- .../kotlin/teams/list-memberships.md | 15 ----- .../1.6.x/client-android/kotlin/teams/list.md | 14 ----- .../kotlin/teams/update-membership-status.md | 16 ------ .../kotlin/teams/update-membership.md | 15 ----- .../kotlin/teams/update-name.md | 14 ----- .../kotlin/teams/update-prefs.md | 14 ----- .../account/create-anonymous-session.md | 10 ---- .../account/create-email-password-session.md | 13 ----- .../examples/account/create-email-token.md | 14 ----- .../examples/account/create-j-w-t.md | 10 ---- .../account/create-magic-u-r-l-token.md | 15 ----- .../account/create-mfa-authenticator.md | 13 ----- .../examples/account/create-mfa-challenge.md | 13 ----- .../account/create-mfa-recovery-codes.md | 10 ---- .../examples/account/create-o-auth2session.md | 16 ------ .../examples/account/create-o-auth2token.md | 16 ------ .../examples/account/create-phone-token.md | 13 ----- .../account/create-phone-verification.md | 10 ---- .../examples/account/create-push-target.md | 14 ----- .../examples/account/create-recovery.md | 13 ----- .../examples/account/create-session.md | 13 ----- .../examples/account/create-verification.md | 12 ---- .../client-apple/examples/account/create.md | 15 ----- .../examples/account/delete-identity.md | 12 ---- .../account/delete-mfa-authenticator.md | 13 ----- .../examples/account/delete-push-target.md | 12 ---- .../examples/account/delete-session.md | 12 ---- .../examples/account/delete-sessions.md | 10 ---- .../account/get-mfa-recovery-codes.md | 10 ---- .../examples/account/get-prefs.md | 10 ---- .../examples/account/get-session.md | 12 ---- .../client-apple/examples/account/get.md | 10 ---- .../examples/account/list-identities.md | 12 ---- .../examples/account/list-logs.md | 12 ---- .../examples/account/list-mfa-factors.md | 10 ---- .../examples/account/list-sessions.md | 10 ---- .../examples/account/update-email.md | 13 ----- .../examples/account/update-m-f-a.md | 12 ---- .../account/update-magic-u-r-l-session.md | 13 ----- .../account/update-mfa-authenticator.md | 14 ----- .../examples/account/update-mfa-challenge.md | 13 ----- .../account/update-mfa-recovery-codes.md | 10 ---- .../examples/account/update-name.md | 12 ---- .../examples/account/update-password.md | 13 ----- .../examples/account/update-phone-session.md | 13 ----- .../account/update-phone-verification.md | 13 ----- .../examples/account/update-phone.md | 13 ----- .../examples/account/update-prefs.md | 12 ---- .../examples/account/update-push-target.md | 13 ----- .../examples/account/update-recovery.md | 14 ----- .../examples/account/update-session.md | 12 ---- .../examples/account/update-status.md | 10 ---- .../examples/account/update-verification.md | 13 ----- .../examples/avatars/get-browser.md | 16 ------ .../examples/avatars/get-credit-card.md | 16 ------ .../examples/avatars/get-favicon.md | 12 ---- .../client-apple/examples/avatars/get-flag.md | 16 ------ .../examples/avatars/get-image.md | 14 ----- .../examples/avatars/get-initials.md | 15 ----- .../client-apple/examples/avatars/get-q-r.md | 15 ----- .../examples/databases/create-document.md | 16 ------ .../examples/databases/delete-document.md | 14 ----- .../examples/databases/get-document.md | 15 ----- .../examples/databases/list-documents.md | 14 ----- .../examples/databases/update-document.md | 16 ------ .../examples/functions/create-execution.md | 19 ------- .../examples/functions/get-execution.md | 13 ----- .../examples/functions/list-executions.md | 14 ----- .../client-apple/examples/graphql/mutation.md | 12 ---- .../client-apple/examples/graphql/query.md | 12 ---- .../1.6.x/client-apple/examples/locale/get.md | 10 ---- .../examples/locale/list-codes.md | 10 ---- .../examples/locale/list-continents.md | 10 ---- .../examples/locale/list-countries-e-u.md | 10 ---- .../examples/locale/list-countries-phones.md | 10 ---- .../examples/locale/list-countries.md | 10 ---- .../examples/locale/list-currencies.md | 10 ---- .../examples/locale/list-languages.md | 10 ---- .../examples/messaging/create-subscriber.md | 14 ----- .../examples/messaging/delete-subscriber.md | 13 ----- .../examples/storage/create-file.md | 15 ----- .../examples/storage/delete-file.md | 13 ----- .../examples/storage/get-file-download.md | 13 ----- .../examples/storage/get-file-preview.md | 25 -------- .../examples/storage/get-file-view.md | 13 ----- .../client-apple/examples/storage/get-file.md | 13 ----- .../examples/storage/list-files.md | 14 ----- .../examples/storage/update-file.md | 15 ----- .../examples/teams/create-membership.md | 18 ------ .../client-apple/examples/teams/create.md | 14 ----- .../examples/teams/delete-membership.md | 13 ----- .../client-apple/examples/teams/delete.md | 12 ---- .../examples/teams/get-membership.md | 13 ----- .../client-apple/examples/teams/get-prefs.md | 12 ---- .../1.6.x/client-apple/examples/teams/get.md | 12 ---- .../examples/teams/list-memberships.md | 14 ----- .../1.6.x/client-apple/examples/teams/list.md | 13 ----- .../teams/update-membership-status.md | 15 ----- .../examples/teams/update-membership.md | 14 ----- .../examples/teams/update-name.md | 13 ----- .../examples/teams/update-prefs.md | 13 ----- .../account/create-anonymous-session.md | 9 --- .../account/create-email-password-session.md | 12 ---- .../examples/account/create-email-token.md | 13 ----- .../examples/account/create-j-w-t.md | 9 --- .../account/create-magic-u-r-l-token.md | 14 ----- .../account/create-mfa-authenticator.md | 11 ---- .../examples/account/create-mfa-challenge.md | 11 ---- .../account/create-mfa-recovery-codes.md | 9 --- .../examples/account/create-o-auth2session.md | 14 ----- .../examples/account/create-o-auth2token.md | 14 ----- .../examples/account/create-phone-token.md | 12 ---- .../account/create-phone-verification.md | 9 --- .../examples/account/create-push-target.md | 13 ----- .../examples/account/create-recovery.md | 12 ---- .../examples/account/create-session.md | 12 ---- .../examples/account/create-verification.md | 11 ---- .../client-flutter/examples/account/create.md | 14 ----- .../examples/account/delete-identity.md | 11 ---- .../account/delete-mfa-authenticator.md | 11 ---- .../examples/account/delete-push-target.md | 11 ---- .../examples/account/delete-session.md | 11 ---- .../examples/account/delete-sessions.md | 9 --- .../account/get-mfa-recovery-codes.md | 9 --- .../examples/account/get-prefs.md | 9 --- .../examples/account/get-session.md | 11 ---- .../client-flutter/examples/account/get.md | 9 --- .../examples/account/list-identities.md | 11 ---- .../examples/account/list-logs.md | 11 ---- .../examples/account/list-mfa-factors.md | 9 --- .../examples/account/list-sessions.md | 9 --- .../examples/account/update-email.md | 12 ---- .../examples/account/update-m-f-a.md | 11 ---- .../account/update-magic-u-r-l-session.md | 12 ---- .../account/update-mfa-authenticator.md | 12 ---- .../examples/account/update-mfa-challenge.md | 12 ---- .../account/update-mfa-recovery-codes.md | 9 --- .../examples/account/update-name.md | 11 ---- .../examples/account/update-password.md | 12 ---- .../examples/account/update-phone-session.md | 12 ---- .../account/update-phone-verification.md | 12 ---- .../examples/account/update-phone.md | 12 ---- .../examples/account/update-prefs.md | 11 ---- .../examples/account/update-push-target.md | 12 ---- .../examples/account/update-recovery.md | 13 ----- .../examples/account/update-session.md | 11 ---- .../examples/account/update-status.md | 9 --- .../examples/account/update-verification.md | 12 ---- .../examples/avatars/get-browser.md | 33 ----------- .../examples/avatars/get-credit-card.md | 33 ----------- .../examples/avatars/get-favicon.md | 27 --------- .../examples/avatars/get-flag.md | 33 ----------- .../examples/avatars/get-image.md | 31 ---------- .../examples/avatars/get-initials.md | 33 ----------- .../examples/avatars/get-q-r.md | 33 ----------- .../examples/databases/create-document.md | 15 ----- .../examples/databases/delete-document.md | 13 ----- .../examples/databases/get-document.md | 14 ----- .../examples/databases/list-documents.md | 13 ----- .../examples/databases/update-document.md | 15 ----- .../examples/functions/create-execution.md | 17 ------ .../examples/functions/get-execution.md | 12 ---- .../examples/functions/list-executions.md | 13 ----- .../examples/graphql/mutation.md | 11 ---- .../client-flutter/examples/graphql/query.md | 11 ---- .../client-flutter/examples/locale/get.md | 9 --- .../examples/locale/list-codes.md | 9 --- .../examples/locale/list-continents.md | 9 --- .../examples/locale/list-countries-e-u.md | 9 --- .../examples/locale/list-countries-phones.md | 9 --- .../examples/locale/list-countries.md | 9 --- .../examples/locale/list-currencies.md | 9 --- .../examples/locale/list-languages.md | 9 --- .../examples/messaging/create-subscriber.md | 13 ----- .../examples/messaging/delete-subscriber.md | 12 ---- .../examples/storage/create-file.md | 15 ----- .../examples/storage/delete-file.md | 12 ---- .../examples/storage/get-file-download.md | 29 ---------- .../examples/storage/get-file-preview.md | 51 ----------------- .../examples/storage/get-file-view.md | 29 ---------- .../examples/storage/get-file.md | 12 ---- .../examples/storage/list-files.md | 13 ----- .../examples/storage/update-file.md | 14 ----- .../examples/teams/create-membership.md | 17 ------ .../client-flutter/examples/teams/create.md | 13 ----- .../examples/teams/delete-membership.md | 12 ---- .../client-flutter/examples/teams/delete.md | 11 ---- .../examples/teams/get-membership.md | 12 ---- .../examples/teams/get-prefs.md | 11 ---- .../client-flutter/examples/teams/get.md | 11 ---- .../examples/teams/list-memberships.md | 13 ----- .../client-flutter/examples/teams/list.md | 12 ---- .../teams/update-membership-status.md | 14 ----- .../examples/teams/update-membership.md | 13 ----- .../examples/teams/update-name.md | 12 ---- .../examples/teams/update-prefs.md | 12 ---- .../account/create-anonymous-session.md | 33 ----------- .../account/create-email-password-session.md | 36 ------------ .../examples/account/create-email-token.md | 14 ----- .../examples/account/create-j-w-t.md | 5 -- .../account/create-magic-u-r-l-token.md | 15 ----- .../account/create-mfa-authenticator.md | 8 --- .../examples/account/create-mfa-challenge.md | 10 ---- .../account/create-mfa-recovery-codes.md | 5 -- .../examples/account/create-phone-token.md | 13 ----- .../account/create-phone-verification.md | 10 ---- .../examples/account/create-push-target.md | 16 ------ .../examples/account/create-recovery.md | 13 ----- .../examples/account/create-session.md | 36 ------------ .../examples/account/create-verification.md | 12 ---- .../client-graphql/examples/account/create.md | 39 ------------- .../examples/account/delete-identity.md | 7 --- .../account/delete-mfa-authenticator.md | 7 --- .../examples/account/delete-push-target.md | 7 --- .../examples/account/delete-session.md | 7 --- .../examples/account/delete-sessions.md | 5 -- .../account/get-mfa-recovery-codes.md | 5 -- .../examples/account/get-prefs.md | 5 -- .../examples/account/get-session.md | 35 ------------ .../client-graphql/examples/account/get.md | 34 ----------- .../examples/account/list-identities.md | 19 ------- .../examples/account/list-logs.md | 30 ---------- .../examples/account/list-mfa-factors.md | 8 --- .../examples/account/list-sessions.md | 36 ------------ .../examples/account/update-email.md | 37 ------------ .../examples/account/update-m-f-a.md | 36 ------------ .../account/update-magic-u-r-l-session.md | 36 ------------ .../account/update-mfa-authenticator.md | 37 ------------ .../examples/account/update-mfa-challenge.md | 8 --- .../account/update-mfa-recovery-codes.md | 5 -- .../examples/account/update-name.md | 36 ------------ .../examples/account/update-password.md | 37 ------------ .../examples/account/update-phone-session.md | 36 ------------ .../account/update-phone-verification.md | 13 ----- .../examples/account/update-phone.md | 37 ------------ .../examples/account/update-prefs.md | 36 ------------ .../examples/account/update-push-target.md | 15 ----- .../examples/account/update-recovery.md | 14 ----- .../examples/account/update-session.md | 35 ------------ .../examples/account/update-status.md | 34 ----------- .../examples/account/update-verification.md | 13 ----- .../examples/avatars/get-browser.md | 10 ---- .../examples/avatars/get-credit-card.md | 10 ---- .../examples/avatars/get-favicon.md | 7 --- .../examples/avatars/get-flag.md | 10 ---- .../examples/avatars/get-image.md | 9 --- .../examples/avatars/get-initials.md | 10 ---- .../examples/avatars/get-q-r.md | 10 ---- .../examples/databases/create-document.md | 17 ------ .../examples/databases/delete-document.md | 9 --- .../examples/databases/get-document.md | 16 ------ .../examples/databases/list-documents.md | 18 ------ .../examples/databases/update-document.md | 17 ------ .../examples/functions/create-execution.md | 34 ----------- .../examples/functions/get-execution.md | 29 ---------- .../examples/functions/list-executions.md | 33 ----------- .../client-graphql/examples/locale/get.md | 11 ---- .../examples/locale/list-codes.md | 9 --- .../examples/locale/list-continents.md | 9 --- .../examples/locale/list-countries-e-u.md | 9 --- .../examples/locale/list-countries-phones.md | 10 ---- .../examples/locale/list-countries.md | 9 --- .../examples/locale/list-currencies.md | 14 ----- .../examples/locale/list-languages.md | 10 ---- .../examples/messaging/create-subscriber.md | 26 --------- .../examples/messaging/delete-subscriber.md | 8 --- .../examples/storage/create-file.md | 25 -------- .../examples/storage/delete-file.md | 8 --- .../examples/storage/get-file-download.md | 8 --- .../examples/storage/get-file-preview.md | 19 ------- .../examples/storage/get-file-view.md | 8 --- .../examples/storage/get-file.md | 18 ------ .../examples/storage/list-files.md | 22 ------- .../examples/storage/update-file.md | 20 ------- .../examples/teams/create-membership.md | 25 -------- .../client-graphql/examples/teams/create.md | 16 ------ .../examples/teams/delete-membership.md | 8 --- .../client-graphql/examples/teams/delete.md | 7 --- .../examples/teams/get-membership.md | 20 ------- .../examples/teams/get-prefs.md | 7 --- .../client-graphql/examples/teams/get.md | 14 ----- .../examples/teams/list-memberships.md | 24 -------- .../client-graphql/examples/teams/list.md | 18 ------ .../teams/update-membership-status.md | 22 ------- .../examples/teams/update-membership.md | 21 ------- .../examples/teams/update-name.md | 15 ----- .../examples/teams/update-prefs.md | 8 --- .../account/create-anonymous-session.md | 11 ---- .../account/create-email-password-session.md | 14 ----- .../examples/account/create-email-token.md | 15 ----- .../examples/account/create-j-w-t.md | 11 ---- .../account/create-magic-u-r-l-token.md | 16 ------ .../account/create-mfa-authenticator.md | 13 ----- .../examples/account/create-mfa-challenge.md | 13 ----- .../account/create-mfa-recovery-codes.md | 11 ---- .../examples/account/create-o-auth2session.md | 15 ----- .../examples/account/create-o-auth2token.md | 15 ----- .../examples/account/create-phone-token.md | 14 ----- .../account/create-phone-verification.md | 11 ---- .../examples/account/create-push-target.md | 15 ----- .../examples/account/create-recovery.md | 14 ----- .../examples/account/create-session.md | 14 ----- .../examples/account/create-verification.md | 13 ----- .../examples/account/create.md | 16 ------ .../examples/account/delete-identity.md | 13 ----- .../account/delete-mfa-authenticator.md | 13 ----- .../examples/account/delete-push-target.md | 13 ----- .../examples/account/delete-session.md | 13 ----- .../examples/account/delete-sessions.md | 11 ---- .../account/get-mfa-recovery-codes.md | 11 ---- .../examples/account/get-prefs.md | 11 ---- .../examples/account/get-session.md | 13 ----- .../examples/account/get.md | 11 ---- .../examples/account/list-identities.md | 13 ----- .../examples/account/list-logs.md | 13 ----- .../examples/account/list-mfa-factors.md | 11 ---- .../examples/account/list-sessions.md | 11 ---- .../examples/account/update-email.md | 14 ----- .../examples/account/update-m-f-a.md | 13 ----- .../account/update-magic-u-r-l-session.md | 14 ----- .../account/update-mfa-authenticator.md | 14 ----- .../examples/account/update-mfa-challenge.md | 14 ----- .../account/update-mfa-recovery-codes.md | 11 ---- .../examples/account/update-name.md | 13 ----- .../examples/account/update-password.md | 14 ----- .../examples/account/update-phone-session.md | 14 ----- .../account/update-phone-verification.md | 14 ----- .../examples/account/update-phone.md | 14 ----- .../examples/account/update-prefs.md | 13 ----- .../examples/account/update-push-target.md | 14 ----- .../examples/account/update-recovery.md | 15 ----- .../examples/account/update-session.md | 13 ----- .../examples/account/update-status.md | 11 ---- .../examples/account/update-verification.md | 14 ----- .../examples/avatars/get-browser.md | 16 ------ .../examples/avatars/get-credit-card.md | 16 ------ .../examples/avatars/get-favicon.md | 13 ----- .../examples/avatars/get-flag.md | 16 ------ .../examples/avatars/get-image.md | 15 ----- .../examples/avatars/get-initials.md | 16 ------ .../examples/avatars/get-q-r.md | 16 ------ .../examples/databases/create-document.md | 17 ------ .../examples/databases/delete-document.md | 15 ----- .../examples/databases/get-document.md | 16 ------ .../examples/databases/list-documents.md | 15 ----- .../examples/databases/update-document.md | 17 ------ .../examples/functions/create-execution.md | 19 ------- .../examples/functions/get-execution.md | 14 ----- .../examples/functions/list-executions.md | 15 ----- .../examples/graphql/mutation.md | 13 ----- .../examples/graphql/query.md | 13 ----- .../examples/locale/get.md | 11 ---- .../examples/locale/list-codes.md | 11 ---- .../examples/locale/list-continents.md | 11 ---- .../examples/locale/list-countries-e-u.md | 11 ---- .../examples/locale/list-countries-phones.md | 11 ---- .../examples/locale/list-countries.md | 11 ---- .../examples/locale/list-currencies.md | 11 ---- .../examples/locale/list-languages.md | 11 ---- .../examples/messaging/create-subscriber.md | 15 ----- .../examples/messaging/delete-subscriber.md | 14 ----- .../examples/storage/create-file.md | 16 ------ .../examples/storage/delete-file.md | 14 ----- .../examples/storage/get-file-download.md | 14 ----- .../examples/storage/get-file-preview.md | 25 -------- .../examples/storage/get-file-view.md | 14 ----- .../examples/storage/get-file.md | 14 ----- .../examples/storage/list-files.md | 15 ----- .../examples/storage/update-file.md | 16 ------ .../examples/teams/create-membership.md | 19 ------- .../examples/teams/create.md | 15 ----- .../examples/teams/delete-membership.md | 14 ----- .../examples/teams/delete.md | 13 ----- .../examples/teams/get-membership.md | 14 ----- .../examples/teams/get-prefs.md | 13 ----- .../client-react-native/examples/teams/get.md | 13 ----- .../examples/teams/list-memberships.md | 15 ----- .../examples/teams/list.md | 14 ----- .../teams/update-membership-status.md | 16 ------ .../examples/teams/update-membership.md | 15 ----- .../examples/teams/update-name.md | 14 ----- .../examples/teams/update-prefs.md | 14 ----- .../account/create-anonymous-session.md | 6 -- .../account/create-email-password-session.md | 10 ---- .../examples/account/create-email-token.md | 11 ---- .../examples/account/create-j-w-t.md | 6 -- .../account/create-magic-u-r-l-token.md | 12 ---- .../account/create-mfa-authenticator.md | 8 --- .../examples/account/create-mfa-challenge.md | 9 --- .../account/create-mfa-recovery-codes.md | 8 --- .../examples/account/create-o-auth2session.md | 6 -- .../examples/account/create-o-auth2token.md | 6 -- .../examples/account/create-phone-token.md | 10 ---- .../account/create-phone-verification.md | 8 --- .../examples/account/create-push-target.md | 12 ---- .../examples/account/create-recovery.md | 12 ---- .../examples/account/create-session.md | 10 ---- .../examples/account/create-verification.md | 11 ---- .../client-rest/examples/account/create.md | 12 ---- .../examples/account/delete-identity.md | 8 --- .../account/delete-mfa-authenticator.md | 8 --- .../examples/account/delete-push-target.md | 7 --- .../examples/account/delete-session.md | 8 --- .../examples/account/delete-sessions.md | 8 --- .../account/get-mfa-recovery-codes.md | 8 --- .../client-rest/examples/account/get-prefs.md | 8 --- .../examples/account/get-session.md | 8 --- .../1.6.x/client-rest/examples/account/get.md | 8 --- .../examples/account/list-identities.md | 8 --- .../client-rest/examples/account/list-logs.md | 8 --- .../examples/account/list-mfa-factors.md | 8 --- .../examples/account/list-sessions.md | 8 --- .../examples/account/update-email.md | 12 ---- .../examples/account/update-m-f-a.md | 11 ---- .../account/update-magic-u-r-l-session.md | 10 ---- .../account/update-mfa-authenticator.md | 11 ---- .../examples/account/update-mfa-challenge.md | 12 ---- .../account/update-mfa-recovery-codes.md | 8 --- .../examples/account/update-name.md | 11 ---- .../examples/account/update-password.md | 12 ---- .../examples/account/update-phone-session.md | 10 ---- .../account/update-phone-verification.md | 12 ---- .../examples/account/update-phone.md | 12 ---- .../examples/account/update-prefs.md | 11 ---- .../examples/account/update-push-target.md | 10 ---- .../examples/account/update-recovery.md | 13 ----- .../examples/account/update-session.md | 8 --- .../examples/account/update-status.md | 8 --- .../examples/account/update-verification.md | 12 ---- .../examples/avatars/get-browser.md | 8 --- .../examples/avatars/get-credit-card.md | 8 --- .../examples/avatars/get-favicon.md | 8 --- .../client-rest/examples/avatars/get-flag.md | 8 --- .../client-rest/examples/avatars/get-image.md | 8 --- .../examples/avatars/get-initials.md | 8 --- .../client-rest/examples/avatars/get-q-r.md | 8 --- .../examples/databases/create-document.md | 13 ----- .../examples/databases/delete-document.md | 8 --- .../examples/databases/get-document.md | 8 --- .../examples/databases/list-documents.md | 8 --- .../examples/databases/update-document.md | 12 ---- .../examples/functions/create-execution.md | 16 ------ .../examples/functions/get-execution.md | 8 --- .../examples/functions/list-executions.md | 8 --- .../client-rest/examples/graphql/mutation.md | 12 ---- .../client-rest/examples/graphql/query.md | 12 ---- .../1.6.x/client-rest/examples/locale/get.md | 8 --- .../client-rest/examples/locale/list-codes.md | 8 --- .../examples/locale/list-continents.md | 8 --- .../examples/locale/list-countries-e-u.md | 8 --- .../examples/locale/list-countries-phones.md | 8 --- .../examples/locale/list-countries.md | 8 --- .../examples/locale/list-currencies.md | 8 --- .../examples/locale/list-languages.md | 8 --- .../examples/messaging/create-subscriber.md | 12 ---- .../examples/messaging/delete-subscriber.md | 8 --- .../examples/storage/create-file.md | 26 --------- .../examples/storage/delete-file.md | 8 --- .../examples/storage/get-file-download.md | 8 --- .../examples/storage/get-file-preview.md | 8 --- .../examples/storage/get-file-view.md | 8 --- .../client-rest/examples/storage/get-file.md | 8 --- .../examples/storage/list-files.md | 8 --- .../examples/storage/update-file.md | 12 ---- .../examples/teams/create-membership.md | 16 ------ .../client-rest/examples/teams/create.md | 13 ----- .../examples/teams/delete-membership.md | 8 --- .../client-rest/examples/teams/delete.md | 8 --- .../examples/teams/get-membership.md | 8 --- .../client-rest/examples/teams/get-prefs.md | 8 --- .../1.6.x/client-rest/examples/teams/get.md | 8 --- .../examples/teams/list-memberships.md | 8 --- .../1.6.x/client-rest/examples/teams/list.md | 8 --- .../teams/update-membership-status.md | 12 ---- .../examples/teams/update-membership.md | 11 ---- .../client-rest/examples/teams/update-name.md | 11 ---- .../examples/teams/update-prefs.md | 11 ---- .../account/create-anonymous-session.md | 11 ---- .../account/create-email-password-session.md | 14 ----- .../examples/account/create-email-token.md | 15 ----- .../examples/account/create-j-w-t.md | 11 ---- .../account/create-magic-u-r-l-token.md | 16 ------ .../account/create-mfa-authenticator.md | 13 ----- .../examples/account/create-mfa-challenge.md | 13 ----- .../account/create-mfa-recovery-codes.md | 11 ---- .../examples/account/create-o-auth2session.md | 15 ----- .../examples/account/create-o-auth2token.md | 15 ----- .../examples/account/create-phone-token.md | 14 ----- .../account/create-phone-verification.md | 11 ---- .../examples/account/create-push-target.md | 15 ----- .../examples/account/create-recovery.md | 14 ----- .../examples/account/create-session.md | 14 ----- .../examples/account/create-verification.md | 13 ----- .../client-web/examples/account/create.md | 16 ------ .../examples/account/delete-identity.md | 13 ----- .../account/delete-mfa-authenticator.md | 13 ----- .../examples/account/delete-push-target.md | 13 ----- .../examples/account/delete-session.md | 13 ----- .../examples/account/delete-sessions.md | 11 ---- .../account/get-mfa-recovery-codes.md | 11 ---- .../client-web/examples/account/get-prefs.md | 11 ---- .../examples/account/get-session.md | 13 ----- .../1.6.x/client-web/examples/account/get.md | 11 ---- .../examples/account/list-identities.md | 13 ----- .../client-web/examples/account/list-logs.md | 13 ----- .../examples/account/list-mfa-factors.md | 11 ---- .../examples/account/list-sessions.md | 11 ---- .../examples/account/update-email.md | 14 ----- .../examples/account/update-m-f-a.md | 13 ----- .../account/update-magic-u-r-l-session.md | 14 ----- .../account/update-mfa-authenticator.md | 14 ----- .../examples/account/update-mfa-challenge.md | 14 ----- .../account/update-mfa-recovery-codes.md | 11 ---- .../examples/account/update-name.md | 13 ----- .../examples/account/update-password.md | 14 ----- .../examples/account/update-phone-session.md | 14 ----- .../account/update-phone-verification.md | 14 ----- .../examples/account/update-phone.md | 14 ----- .../examples/account/update-prefs.md | 13 ----- .../examples/account/update-push-target.md | 14 ----- .../examples/account/update-recovery.md | 15 ----- .../examples/account/update-session.md | 13 ----- .../examples/account/update-status.md | 11 ---- .../examples/account/update-verification.md | 14 ----- .../examples/avatars/get-browser.md | 16 ------ .../examples/avatars/get-credit-card.md | 16 ------ .../examples/avatars/get-favicon.md | 13 ----- .../client-web/examples/avatars/get-flag.md | 16 ------ .../client-web/examples/avatars/get-image.md | 15 ----- .../examples/avatars/get-initials.md | 16 ------ .../client-web/examples/avatars/get-q-r.md | 16 ------ .../examples/databases/create-document.md | 17 ------ .../examples/databases/delete-document.md | 15 ----- .../examples/databases/get-document.md | 16 ------ .../examples/databases/list-documents.md | 15 ----- .../examples/databases/update-document.md | 17 ------ .../examples/functions/create-execution.md | 19 ------- .../examples/functions/get-execution.md | 14 ----- .../examples/functions/list-executions.md | 15 ----- .../client-web/examples/graphql/mutation.md | 13 ----- .../client-web/examples/graphql/query.md | 13 ----- .../1.6.x/client-web/examples/locale/get.md | 11 ---- .../client-web/examples/locale/list-codes.md | 11 ---- .../examples/locale/list-continents.md | 11 ---- .../examples/locale/list-countries-e-u.md | 11 ---- .../examples/locale/list-countries-phones.md | 11 ---- .../examples/locale/list-countries.md | 11 ---- .../examples/locale/list-currencies.md | 11 ---- .../examples/locale/list-languages.md | 11 ---- .../examples/messaging/create-subscriber.md | 15 ----- .../examples/messaging/delete-subscriber.md | 14 ----- .../examples/storage/create-file.md | 16 ------ .../examples/storage/delete-file.md | 14 ----- .../examples/storage/get-file-download.md | 14 ----- .../examples/storage/get-file-preview.md | 25 -------- .../examples/storage/get-file-view.md | 14 ----- .../client-web/examples/storage/get-file.md | 14 ----- .../client-web/examples/storage/list-files.md | 15 ----- .../examples/storage/update-file.md | 16 ------ .../examples/teams/create-membership.md | 19 ------- .../1.6.x/client-web/examples/teams/create.md | 15 ----- .../examples/teams/delete-membership.md | 14 ----- .../1.6.x/client-web/examples/teams/delete.md | 13 ----- .../examples/teams/get-membership.md | 14 ----- .../client-web/examples/teams/get-prefs.md | 13 ----- .../1.6.x/client-web/examples/teams/get.md | 13 ----- .../examples/teams/list-memberships.md | 15 ----- .../1.6.x/client-web/examples/teams/list.md | 14 ----- .../teams/update-membership-status.md | 16 ------ .../examples/teams/update-membership.md | 15 ----- .../client-web/examples/teams/update-name.md | 14 ----- .../client-web/examples/teams/update-prefs.md | 14 ----- .../account/create-anonymous-session.md | 1 - .../account/create-email-password-session.md | 3 - .../examples/account/create-email-token.md | 4 -- .../examples/account/create-j-w-t.md | 1 - .../account/create-magic-u-r-l-token.md | 5 -- .../account/create-mfa-authenticator.md | 2 - .../examples/account/create-mfa-challenge.md | 2 - .../account/create-mfa-recovery-codes.md | 1 - .../examples/account/create-o-auth2session.md | 5 -- .../examples/account/create-o-auth2token.md | 5 -- .../examples/account/create-phone-token.md | 3 - .../account/create-phone-verification.md | 1 - .../examples/account/create-push-target.md | 4 -- .../examples/account/create-recovery.md | 3 - .../examples/account/create-session.md | 3 - .../examples/account/create-verification.md | 2 - .../console-cli/examples/account/create.md | 5 -- .../examples/account/delete-identity.md | 2 - .../account/delete-mfa-authenticator.md | 2 - .../examples/account/delete-push-target.md | 2 - .../examples/account/delete-session.md | 2 - .../examples/account/delete-sessions.md | 1 - .../console-cli/examples/account/delete.md | 1 - .../account/get-mfa-recovery-codes.md | 1 - .../console-cli/examples/account/get-prefs.md | 1 - .../examples/account/get-session.md | 2 - .../1.6.x/console-cli/examples/account/get.md | 1 - .../examples/account/list-identities.md | 2 - .../console-cli/examples/account/list-logs.md | 2 - .../examples/account/list-mfa-factors.md | 1 - .../examples/account/list-sessions.md | 1 - .../examples/account/update-email.md | 3 - .../examples/account/update-m-f-a.md | 2 - .../account/update-magic-u-r-l-session.md | 3 - .../account/update-mfa-authenticator.md | 3 - .../examples/account/update-mfa-challenge.md | 3 - .../account/update-mfa-recovery-codes.md | 1 - .../examples/account/update-name.md | 2 - .../examples/account/update-password.md | 3 - .../examples/account/update-phone-session.md | 3 - .../account/update-phone-verification.md | 3 - .../examples/account/update-phone.md | 3 - .../examples/account/update-prefs.md | 2 - .../examples/account/update-push-target.md | 3 - .../examples/account/update-recovery.md | 4 -- .../examples/account/update-session.md | 2 - .../examples/account/update-status.md | 1 - .../examples/account/update-verification.md | 3 - .../console-cli/examples/assistant/chat.md | 2 - .../examples/avatars/get-browser.md | 5 -- .../examples/avatars/get-credit-card.md | 5 -- .../examples/avatars/get-favicon.md | 2 - .../console-cli/examples/avatars/get-flag.md | 5 -- .../console-cli/examples/avatars/get-image.md | 4 -- .../examples/avatars/get-initials.md | 5 -- .../console-cli/examples/avatars/get-q-r.md | 5 -- .../console-cli/examples/console/variables.md | 1 - .../databases/create-boolean-attribute.md | 7 --- .../examples/databases/create-collection.md | 7 --- .../databases/create-datetime-attribute.md | 7 --- .../examples/databases/create-document.md | 6 -- .../databases/create-email-attribute.md | 7 --- .../databases/create-enum-attribute.md | 8 --- .../databases/create-float-attribute.md | 9 --- .../examples/databases/create-index.md | 7 --- .../databases/create-integer-attribute.md | 9 --- .../examples/databases/create-ip-attribute.md | 7 --- .../create-relationship-attribute.md | 9 --- .../databases/create-string-attribute.md | 9 --- .../databases/create-url-attribute.md | 7 --- .../console-cli/examples/databases/create.md | 4 -- .../examples/databases/delete-attribute.md | 4 -- .../examples/databases/delete-collection.md | 3 - .../examples/databases/delete-document.md | 4 -- .../examples/databases/delete-index.md | 4 -- .../console-cli/examples/databases/delete.md | 2 - .../examples/databases/get-attribute.md | 4 -- .../databases/get-collection-usage.md | 4 -- .../examples/databases/get-collection.md | 3 - .../examples/databases/get-database-usage.md | 3 - .../examples/databases/get-document.md | 5 -- .../examples/databases/get-index.md | 4 -- .../examples/databases/get-usage.md | 2 - .../console-cli/examples/databases/get.md | 2 - .../examples/databases/list-attributes.md | 4 -- .../databases/list-collection-logs.md | 4 -- .../examples/databases/list-collections.md | 4 -- .../examples/databases/list-document-logs.md | 5 -- .../examples/databases/list-documents.md | 4 -- .../examples/databases/list-indexes.md | 4 -- .../examples/databases/list-logs.md | 3 - .../console-cli/examples/databases/list.md | 3 - .../databases/update-boolean-attribute.md | 6 -- .../examples/databases/update-collection.md | 7 --- .../databases/update-datetime-attribute.md | 6 -- .../examples/databases/update-document.md | 6 -- .../databases/update-email-attribute.md | 6 -- .../databases/update-enum-attribute.md | 7 --- .../databases/update-float-attribute.md | 8 --- .../databases/update-integer-attribute.md | 8 --- .../examples/databases/update-ip-attribute.md | 6 -- .../update-relationship-attribute.md | 5 -- .../databases/update-string-attribute.md | 6 -- .../databases/update-url-attribute.md | 6 -- .../console-cli/examples/databases/update.md | 4 -- .../examples/functions/create-build.md | 4 -- .../examples/functions/create-deployment.md | 6 -- .../examples/functions/create-execution.md | 8 --- .../examples/functions/create-variable.md | 4 -- .../console-cli/examples/functions/create.md | 22 ------- .../examples/functions/delete-deployment.md | 3 - .../examples/functions/delete-execution.md | 3 - .../examples/functions/delete-variable.md | 3 - .../console-cli/examples/functions/delete.md | 2 - .../examples/functions/download-deployment.md | 3 - .../examples/functions/get-deployment.md | 3 - .../examples/functions/get-execution.md | 3 - .../examples/functions/get-function-usage.md | 3 - .../examples/functions/get-usage.md | 2 - .../examples/functions/get-variable.md | 3 - .../console-cli/examples/functions/get.md | 2 - .../examples/functions/list-deployments.md | 4 -- .../examples/functions/list-executions.md | 4 -- .../examples/functions/list-runtimes.md | 1 - .../examples/functions/list-variables.md | 2 - .../console-cli/examples/functions/list.md | 3 - .../functions/update-deployment-build.md | 3 - .../examples/functions/update-deployment.md | 3 - .../examples/functions/update-variable.md | 5 -- .../console-cli/examples/functions/update.md | 18 ------ .../console-cli/examples/graphql/mutation.md | 2 - .../console-cli/examples/graphql/query.md | 2 - .../examples/health/get-antivirus.md | 1 - .../console-cli/examples/health/get-cache.md | 1 - .../examples/health/get-certificate.md | 2 - .../console-cli/examples/health/get-d-b.md | 1 - .../examples/health/get-failed-jobs.md | 3 - .../examples/health/get-pub-sub.md | 1 - .../examples/health/get-queue-builds.md | 2 - .../examples/health/get-queue-certificates.md | 2 - .../examples/health/get-queue-databases.md | 3 - .../examples/health/get-queue-deletes.md | 2 - .../examples/health/get-queue-functions.md | 2 - .../examples/health/get-queue-logs.md | 2 - .../examples/health/get-queue-mails.md | 2 - .../examples/health/get-queue-messaging.md | 2 - .../examples/health/get-queue-migrations.md | 2 - .../examples/health/get-queue-usage-dump.md | 2 - .../examples/health/get-queue-usage.md | 2 - .../examples/health/get-queue-webhooks.md | 2 - .../console-cli/examples/health/get-queue.md | 1 - .../examples/health/get-storage-local.md | 1 - .../examples/health/get-storage.md | 1 - .../console-cli/examples/health/get-time.md | 1 - .../1.6.x/console-cli/examples/health/get.md | 1 - .../1.6.x/console-cli/examples/locale/get.md | 1 - .../console-cli/examples/locale/list-codes.md | 1 - .../examples/locale/list-continents.md | 1 - .../examples/locale/list-countries-e-u.md | 1 - .../examples/locale/list-countries-phones.md | 1 - .../examples/locale/list-countries.md | 1 - .../examples/locale/list-currencies.md | 1 - .../examples/locale/list-languages.md | 1 - .../messaging/create-apns-provider.md | 9 --- .../examples/messaging/create-email.md | 13 ----- .../examples/messaging/create-fcm-provider.md | 5 -- .../messaging/create-mailgun-provider.md | 11 ---- .../messaging/create-msg91provider.md | 7 --- .../examples/messaging/create-push.md | 17 ------ .../messaging/create-sendgrid-provider.md | 9 --- .../examples/messaging/create-sms.md | 8 --- .../messaging/create-smtp-provider.md | 15 ----- .../examples/messaging/create-subscriber.md | 4 -- .../messaging/create-telesign-provider.md | 7 --- .../messaging/create-textmagic-provider.md | 7 --- .../examples/messaging/create-topic.md | 4 -- .../messaging/create-twilio-provider.md | 7 --- .../messaging/create-vonage-provider.md | 7 --- .../examples/messaging/delete-provider.md | 2 - .../examples/messaging/delete-subscriber.md | 3 - .../examples/messaging/delete-topic.md | 2 - .../console-cli/examples/messaging/delete.md | 2 - .../examples/messaging/get-message.md | 2 - .../examples/messaging/get-provider.md | 2 - .../examples/messaging/get-subscriber.md | 3 - .../examples/messaging/get-topic.md | 2 - .../examples/messaging/list-message-logs.md | 3 - .../examples/messaging/list-messages.md | 3 - .../examples/messaging/list-provider-logs.md | 3 - .../examples/messaging/list-providers.md | 3 - .../messaging/list-subscriber-logs.md | 3 - .../examples/messaging/list-subscribers.md | 4 -- .../examples/messaging/list-targets.md | 3 - .../examples/messaging/list-topic-logs.md | 3 - .../examples/messaging/list-topics.md | 3 - .../messaging/update-apns-provider.md | 9 --- .../examples/messaging/update-email.md | 13 ----- .../examples/messaging/update-fcm-provider.md | 5 -- .../messaging/update-mailgun-provider.md | 11 ---- .../messaging/update-msg91provider.md | 7 --- .../examples/messaging/update-push.md | 17 ------ .../messaging/update-sendgrid-provider.md | 9 --- .../examples/messaging/update-sms.md | 8 --- .../messaging/update-smtp-provider.md | 15 ----- .../messaging/update-telesign-provider.md | 7 --- .../messaging/update-textmagic-provider.md | 7 --- .../examples/messaging/update-topic.md | 4 -- .../messaging/update-twilio-provider.md | 7 --- .../messaging/update-vonage-provider.md | 7 --- .../migrations/create-appwrite-migration.md | 5 -- .../migrations/create-firebase-migration.md | 3 - .../create-firebase-o-auth-migration.md | 3 - .../migrations/create-n-host-migration.md | 9 --- .../migrations/create-supabase-migration.md | 8 --- .../migrations/delete-firebase-auth.md | 1 - .../console-cli/examples/migrations/delete.md | 2 - .../migrations/get-appwrite-report.md | 5 -- .../migrations/get-firebase-report-o-auth.md | 3 - .../migrations/get-firebase-report.md | 3 - .../examples/migrations/get-n-host-report.md | 9 --- .../migrations/get-supabase-report.md | 8 --- .../console-cli/examples/migrations/get.md | 2 - .../migrations/list-firebase-projects.md | 1 - .../console-cli/examples/migrations/list.md | 3 - .../console-cli/examples/migrations/retry.md | 2 - .../examples/project/create-variable.md | 3 - .../examples/project/delete-variable.md | 2 - .../console-cli/examples/project/get-usage.md | 4 -- .../examples/project/get-variable.md | 2 - .../examples/project/list-variables.md | 1 - .../examples/project/update-variable.md | 4 -- .../examples/projects/create-j-w-t.md | 4 -- .../examples/projects/create-key.md | 5 -- .../examples/projects/create-platform.md | 7 --- .../examples/projects/create-smtp-test.md | 11 ---- .../examples/projects/create-webhook.md | 9 --- .../console-cli/examples/projects/create.md | 14 ----- .../projects/delete-email-template.md | 4 -- .../examples/projects/delete-key.md | 3 - .../examples/projects/delete-platform.md | 3 - .../examples/projects/delete-sms-template.md | 4 -- .../examples/projects/delete-webhook.md | 3 - .../console-cli/examples/projects/delete.md | 2 - .../examples/projects/get-email-template.md | 4 -- .../console-cli/examples/projects/get-key.md | 3 - .../examples/projects/get-platform.md | 3 - .../examples/projects/get-sms-template.md | 4 -- .../examples/projects/get-webhook.md | 3 - .../console-cli/examples/projects/get.md | 2 - .../examples/projects/list-keys.md | 2 - .../examples/projects/list-platforms.md | 2 - .../examples/projects/list-webhooks.md | 2 - .../console-cli/examples/projects/list.md | 3 - .../projects/update-api-status-all.md | 3 - .../examples/projects/update-api-status.md | 4 -- .../examples/projects/update-auth-duration.md | 3 - .../examples/projects/update-auth-limit.md | 3 - .../update-auth-password-dictionary.md | 3 - .../projects/update-auth-password-history.md | 3 - .../projects/update-auth-sessions-limit.md | 3 - .../examples/projects/update-auth-status.md | 4 -- .../projects/update-email-template.md | 9 --- .../examples/projects/update-key.md | 6 -- .../examples/projects/update-mock-numbers.md | 3 - .../examples/projects/update-o-auth2.md | 6 -- .../projects/update-personal-data-check.md | 3 - .../examples/projects/update-platform.md | 7 --- .../projects/update-service-status-all.md | 3 - .../projects/update-service-status.md | 4 -- .../projects/update-session-alerts.md | 3 - .../examples/projects/update-sms-template.md | 5 -- .../examples/projects/update-smtp.md | 11 ---- .../examples/projects/update-team.md | 3 - .../projects/update-webhook-signature.md | 3 - .../examples/projects/update-webhook.md | 10 ---- .../console-cli/examples/projects/update.md | 12 ---- .../console-cli/examples/proxy/create-rule.md | 4 -- .../console-cli/examples/proxy/delete-rule.md | 2 - .../console-cli/examples/proxy/get-rule.md | 2 - .../console-cli/examples/proxy/list-rules.md | 3 - .../proxy/update-rule-verification.md | 2 - .../examples/storage/create-bucket.md | 11 ---- .../examples/storage/create-file.md | 5 -- .../examples/storage/delete-bucket.md | 2 - .../examples/storage/delete-file.md | 3 - .../examples/storage/get-bucket-usage.md | 3 - .../examples/storage/get-bucket.md | 2 - .../examples/storage/get-file-download.md | 3 - .../examples/storage/get-file-preview.md | 14 ----- .../examples/storage/get-file-view.md | 3 - .../console-cli/examples/storage/get-file.md | 3 - .../console-cli/examples/storage/get-usage.md | 2 - .../examples/storage/list-buckets.md | 3 - .../examples/storage/list-files.md | 4 -- .../examples/storage/update-bucket.md | 11 ---- .../examples/storage/update-file.md | 5 -- .../examples/teams/create-membership.md | 8 --- .../console-cli/examples/teams/create.md | 4 -- .../examples/teams/delete-membership.md | 3 - .../console-cli/examples/teams/delete.md | 2 - .../examples/teams/get-membership.md | 3 - .../console-cli/examples/teams/get-prefs.md | 2 - .../1.6.x/console-cli/examples/teams/get.md | 2 - .../console-cli/examples/teams/list-logs.md | 3 - .../examples/teams/list-memberships.md | 4 -- .../1.6.x/console-cli/examples/teams/list.md | 3 - .../teams/update-membership-status.md | 5 -- .../examples/teams/update-membership.md | 4 -- .../console-cli/examples/teams/update-name.md | 3 - .../examples/teams/update-prefs.md | 3 - .../examples/users/create-argon2user.md | 5 -- .../examples/users/create-bcrypt-user.md | 5 -- .../examples/users/create-j-w-t.md | 4 -- .../examples/users/create-m-d5user.md | 5 -- .../users/create-mfa-recovery-codes.md | 2 - .../examples/users/create-p-h-pass-user.md | 5 -- .../examples/users/create-s-h-a-user.md | 6 -- .../users/create-scrypt-modified-user.md | 8 --- .../examples/users/create-scrypt-user.md | 10 ---- .../examples/users/create-session.md | 2 - .../examples/users/create-target.md | 7 --- .../examples/users/create-token.md | 4 -- .../console-cli/examples/users/create.md | 6 -- .../examples/users/delete-identity.md | 2 - .../users/delete-mfa-authenticator.md | 3 - .../examples/users/delete-session.md | 3 - .../examples/users/delete-sessions.md | 2 - .../examples/users/delete-target.md | 3 - .../console-cli/examples/users/delete.md | 2 - .../examples/users/get-mfa-recovery-codes.md | 2 - .../console-cli/examples/users/get-prefs.md | 2 - .../console-cli/examples/users/get-target.md | 3 - .../console-cli/examples/users/get-usage.md | 2 - .../1.6.x/console-cli/examples/users/get.md | 2 - .../examples/users/list-identities.md | 3 - .../console-cli/examples/users/list-logs.md | 3 - .../examples/users/list-memberships.md | 2 - .../examples/users/list-mfa-factors.md | 2 - .../examples/users/list-sessions.md | 2 - .../examples/users/list-targets.md | 3 - .../1.6.x/console-cli/examples/users/list.md | 3 - .../users/update-email-verification.md | 3 - .../examples/users/update-email.md | 3 - .../examples/users/update-labels.md | 3 - .../users/update-mfa-recovery-codes.md | 2 - .../console-cli/examples/users/update-mfa.md | 3 - .../console-cli/examples/users/update-name.md | 3 - .../examples/users/update-password.md | 3 - .../users/update-phone-verification.md | 3 - .../examples/users/update-phone.md | 3 - .../examples/users/update-prefs.md | 3 - .../examples/users/update-status.md | 3 - .../examples/users/update-target.md | 6 -- .../vcs/create-repository-detection.md | 4 -- .../examples/vcs/create-repository.md | 4 -- .../examples/vcs/delete-installation.md | 2 - .../examples/vcs/get-installation.md | 2 - .../examples/vcs/get-repository-contents.md | 4 -- .../examples/vcs/get-repository.md | 3 - .../examples/vcs/list-installations.md | 3 - .../examples/vcs/list-repositories.md | 3 - .../examples/vcs/list-repository-branches.md | 3 - .../vcs/update-external-deployments.md | 4 -- .../account/create-anonymous-session.md | 11 ---- .../account/create-email-password-session.md | 14 ----- .../examples/account/create-email-token.md | 15 ----- .../examples/account/create-j-w-t.md | 11 ---- .../account/create-magic-u-r-l-token.md | 16 ------ .../account/create-mfa-authenticator.md | 13 ----- .../examples/account/create-mfa-challenge.md | 13 ----- .../account/create-mfa-recovery-codes.md | 11 ---- .../examples/account/create-o-auth2session.md | 15 ----- .../examples/account/create-o-auth2token.md | 15 ----- .../examples/account/create-phone-token.md | 14 ----- .../account/create-phone-verification.md | 11 ---- .../examples/account/create-push-target.md | 15 ----- .../examples/account/create-recovery.md | 14 ----- .../examples/account/create-session.md | 14 ----- .../examples/account/create-verification.md | 13 ----- .../console-web/examples/account/create.md | 16 ------ .../examples/account/delete-identity.md | 13 ----- .../account/delete-mfa-authenticator.md | 13 ----- .../examples/account/delete-push-target.md | 13 ----- .../examples/account/delete-session.md | 13 ----- .../examples/account/delete-sessions.md | 11 ---- .../console-web/examples/account/delete.md | 11 ---- .../account/get-mfa-recovery-codes.md | 11 ---- .../console-web/examples/account/get-prefs.md | 11 ---- .../examples/account/get-session.md | 13 ----- .../1.6.x/console-web/examples/account/get.md | 11 ---- .../examples/account/list-identities.md | 13 ----- .../console-web/examples/account/list-logs.md | 13 ----- .../examples/account/list-mfa-factors.md | 11 ---- .../examples/account/list-sessions.md | 11 ---- .../examples/account/update-email.md | 14 ----- .../examples/account/update-m-f-a.md | 13 ----- .../account/update-magic-u-r-l-session.md | 14 ----- .../account/update-mfa-authenticator.md | 14 ----- .../examples/account/update-mfa-challenge.md | 14 ----- .../account/update-mfa-recovery-codes.md | 11 ---- .../examples/account/update-name.md | 13 ----- .../examples/account/update-password.md | 14 ----- .../examples/account/update-phone-session.md | 14 ----- .../account/update-phone-verification.md | 14 ----- .../examples/account/update-phone.md | 14 ----- .../examples/account/update-prefs.md | 13 ----- .../examples/account/update-push-target.md | 14 ----- .../examples/account/update-recovery.md | 15 ----- .../examples/account/update-session.md | 13 ----- .../examples/account/update-status.md | 11 ---- .../examples/account/update-verification.md | 14 ----- .../console-web/examples/assistant/chat.md | 13 ----- .../examples/avatars/get-browser.md | 16 ------ .../examples/avatars/get-credit-card.md | 16 ------ .../examples/avatars/get-favicon.md | 13 ----- .../console-web/examples/avatars/get-flag.md | 16 ------ .../console-web/examples/avatars/get-image.md | 15 ----- .../examples/avatars/get-initials.md | 16 ------ .../console-web/examples/avatars/get-q-r.md | 16 ------ .../console-web/examples/console/variables.md | 11 ---- .../databases/create-boolean-attribute.md | 18 ------ .../examples/databases/create-collection.md | 18 ------ .../databases/create-datetime-attribute.md | 18 ------ .../examples/databases/create-document.md | 17 ------ .../databases/create-email-attribute.md | 18 ------ .../databases/create-enum-attribute.md | 19 ------- .../databases/create-float-attribute.md | 20 ------- .../examples/databases/create-index.md | 18 ------ .../databases/create-integer-attribute.md | 20 ------- .../examples/databases/create-ip-attribute.md | 18 ------ .../create-relationship-attribute.md | 20 ------- .../databases/create-string-attribute.md | 20 ------- .../databases/create-url-attribute.md | 18 ------ .../console-web/examples/databases/create.md | 15 ----- .../examples/databases/delete-attribute.md | 15 ----- .../examples/databases/delete-collection.md | 14 ----- .../examples/databases/delete-document.md | 15 ----- .../examples/databases/delete-index.md | 15 ----- .../console-web/examples/databases/delete.md | 13 ----- .../examples/databases/get-attribute.md | 15 ----- .../databases/get-collection-usage.md | 15 ----- .../examples/databases/get-collection.md | 14 ----- .../examples/databases/get-database-usage.md | 14 ----- .../examples/databases/get-document.md | 16 ------ .../examples/databases/get-index.md | 15 ----- .../examples/databases/get-usage.md | 13 ----- .../console-web/examples/databases/get.md | 13 ----- .../examples/databases/list-attributes.md | 15 ----- .../databases/list-collection-logs.md | 15 ----- .../examples/databases/list-collections.md | 15 ----- .../examples/databases/list-document-logs.md | 16 ------ .../examples/databases/list-documents.md | 15 ----- .../examples/databases/list-indexes.md | 15 ----- .../examples/databases/list-logs.md | 14 ----- .../console-web/examples/databases/list.md | 14 ----- .../databases/update-boolean-attribute.md | 17 ------ .../examples/databases/update-collection.md | 18 ------ .../databases/update-datetime-attribute.md | 17 ------ .../examples/databases/update-document.md | 17 ------ .../databases/update-email-attribute.md | 17 ------ .../databases/update-enum-attribute.md | 18 ------ .../databases/update-float-attribute.md | 19 ------- .../databases/update-integer-attribute.md | 19 ------- .../examples/databases/update-ip-attribute.md | 17 ------ .../update-relationship-attribute.md | 16 ------ .../databases/update-string-attribute.md | 17 ------ .../databases/update-url-attribute.md | 17 ------ .../console-web/examples/databases/update.md | 15 ----- .../examples/functions/create-build.md | 15 ----- .../examples/functions/create-deployment.md | 17 ------ .../examples/functions/create-execution.md | 19 ------- .../examples/functions/create-variable.md | 15 ----- .../console-web/examples/functions/create.md | 33 ----------- .../examples/functions/delete-deployment.md | 14 ----- .../examples/functions/delete-execution.md | 14 ----- .../examples/functions/delete-variable.md | 14 ----- .../console-web/examples/functions/delete.md | 13 ----- .../examples/functions/download-deployment.md | 14 ----- .../examples/functions/get-deployment.md | 14 ----- .../examples/functions/get-execution.md | 14 ----- .../examples/functions/get-function-usage.md | 14 ----- .../examples/functions/get-usage.md | 13 ----- .../examples/functions/get-variable.md | 14 ----- .../console-web/examples/functions/get.md | 13 ----- .../examples/functions/list-deployments.md | 15 ----- .../examples/functions/list-executions.md | 15 ----- .../examples/functions/list-runtimes.md | 11 ---- .../examples/functions/list-variables.md | 13 ----- .../console-web/examples/functions/list.md | 14 ----- .../functions/update-deployment-build.md | 14 ----- .../examples/functions/update-deployment.md | 14 ----- .../examples/functions/update-variable.md | 16 ------ .../console-web/examples/functions/update.md | 29 ---------- .../console-web/examples/graphql/mutation.md | 13 ----- .../console-web/examples/graphql/query.md | 13 ----- .../examples/health/get-antivirus.md | 11 ---- .../console-web/examples/health/get-cache.md | 11 ---- .../examples/health/get-certificate.md | 13 ----- .../console-web/examples/health/get-d-b.md | 11 ---- .../examples/health/get-failed-jobs.md | 14 ----- .../examples/health/get-pub-sub.md | 11 ---- .../examples/health/get-queue-builds.md | 13 ----- .../examples/health/get-queue-certificates.md | 13 ----- .../examples/health/get-queue-databases.md | 14 ----- .../examples/health/get-queue-deletes.md | 13 ----- .../examples/health/get-queue-functions.md | 13 ----- .../examples/health/get-queue-logs.md | 13 ----- .../examples/health/get-queue-mails.md | 13 ----- .../examples/health/get-queue-messaging.md | 13 ----- .../examples/health/get-queue-migrations.md | 13 ----- .../examples/health/get-queue-usage-dump.md | 13 ----- .../examples/health/get-queue-usage.md | 13 ----- .../examples/health/get-queue-webhooks.md | 13 ----- .../console-web/examples/health/get-queue.md | 11 ---- .../examples/health/get-storage-local.md | 11 ---- .../examples/health/get-storage.md | 11 ---- .../console-web/examples/health/get-time.md | 11 ---- .../1.6.x/console-web/examples/health/get.md | 11 ---- .../1.6.x/console-web/examples/locale/get.md | 11 ---- .../console-web/examples/locale/list-codes.md | 11 ---- .../examples/locale/list-continents.md | 11 ---- .../examples/locale/list-countries-e-u.md | 11 ---- .../examples/locale/list-countries-phones.md | 11 ---- .../examples/locale/list-countries.md | 11 ---- .../examples/locale/list-currencies.md | 11 ---- .../examples/locale/list-languages.md | 11 ---- .../messaging/create-apns-provider.md | 20 ------- .../examples/messaging/create-email.md | 24 -------- .../examples/messaging/create-fcm-provider.md | 16 ------ .../messaging/create-mailgun-provider.md | 22 ------- .../messaging/create-msg91provider.md | 18 ------ .../examples/messaging/create-push.md | 28 --------- .../messaging/create-sendgrid-provider.md | 20 ------- .../examples/messaging/create-sms.md | 19 ------- .../messaging/create-smtp-provider.md | 26 --------- .../examples/messaging/create-subscriber.md | 15 ----- .../messaging/create-telesign-provider.md | 18 ------ .../messaging/create-textmagic-provider.md | 18 ------ .../examples/messaging/create-topic.md | 15 ----- .../messaging/create-twilio-provider.md | 18 ------ .../messaging/create-vonage-provider.md | 18 ------ .../examples/messaging/delete-provider.md | 13 ----- .../examples/messaging/delete-subscriber.md | 14 ----- .../examples/messaging/delete-topic.md | 13 ----- .../console-web/examples/messaging/delete.md | 13 ----- .../examples/messaging/get-message.md | 13 ----- .../examples/messaging/get-provider.md | 13 ----- .../examples/messaging/get-subscriber.md | 14 ----- .../examples/messaging/get-topic.md | 13 ----- .../examples/messaging/list-message-logs.md | 14 ----- .../examples/messaging/list-messages.md | 14 ----- .../examples/messaging/list-provider-logs.md | 14 ----- .../examples/messaging/list-providers.md | 14 ----- .../messaging/list-subscriber-logs.md | 14 ----- .../examples/messaging/list-subscribers.md | 15 ----- .../examples/messaging/list-targets.md | 14 ----- .../examples/messaging/list-topic-logs.md | 14 ----- .../examples/messaging/list-topics.md | 14 ----- .../messaging/update-apns-provider.md | 20 ------- .../examples/messaging/update-email.md | 24 -------- .../examples/messaging/update-fcm-provider.md | 16 ------ .../messaging/update-mailgun-provider.md | 22 ------- .../messaging/update-msg91provider.md | 18 ------ .../examples/messaging/update-push.md | 28 --------- .../messaging/update-sendgrid-provider.md | 20 ------- .../examples/messaging/update-sms.md | 19 ------- .../messaging/update-smtp-provider.md | 26 --------- .../messaging/update-telesign-provider.md | 18 ------ .../messaging/update-textmagic-provider.md | 18 ------ .../examples/messaging/update-topic.md | 15 ----- .../messaging/update-twilio-provider.md | 18 ------ .../messaging/update-vonage-provider.md | 18 ------ .../migrations/create-appwrite-migration.md | 16 ------ .../migrations/create-firebase-migration.md | 14 ----- .../create-firebase-o-auth-migration.md | 14 ----- .../migrations/create-n-host-migration.md | 20 ------- .../migrations/create-supabase-migration.md | 19 ------- .../migrations/delete-firebase-auth.md | 11 ---- .../console-web/examples/migrations/delete.md | 13 ----- .../migrations/get-appwrite-report.md | 16 ------ .../migrations/get-firebase-report-o-auth.md | 14 ----- .../migrations/get-firebase-report.md | 14 ----- .../examples/migrations/get-n-host-report.md | 20 ------- .../migrations/get-supabase-report.md | 19 ------- .../console-web/examples/migrations/get.md | 13 ----- .../migrations/list-firebase-projects.md | 11 ---- .../console-web/examples/migrations/list.md | 14 ----- .../console-web/examples/migrations/retry.md | 13 ----- .../examples/project/create-variable.md | 14 ----- .../examples/project/delete-variable.md | 13 ----- .../console-web/examples/project/get-usage.md | 15 ----- .../examples/project/get-variable.md | 13 ----- .../examples/project/list-variables.md | 11 ---- .../examples/project/update-variable.md | 15 ----- .../examples/projects/create-j-w-t.md | 15 ----- .../examples/projects/create-key.md | 16 ------ .../examples/projects/create-platform.md | 18 ------ .../examples/projects/create-smtp-test.md | 22 ------- .../examples/projects/create-webhook.md | 20 ------- .../console-web/examples/projects/create.md | 25 -------- .../projects/delete-email-template.md | 15 ----- .../examples/projects/delete-key.md | 14 ----- .../examples/projects/delete-platform.md | 14 ----- .../examples/projects/delete-sms-template.md | 15 ----- .../examples/projects/delete-webhook.md | 14 ----- .../console-web/examples/projects/delete.md | 13 ----- .../examples/projects/get-email-template.md | 15 ----- .../console-web/examples/projects/get-key.md | 14 ----- .../examples/projects/get-platform.md | 14 ----- .../examples/projects/get-sms-template.md | 15 ----- .../examples/projects/get-webhook.md | 14 ----- .../console-web/examples/projects/get.md | 13 ----- .../examples/projects/list-keys.md | 13 ----- .../examples/projects/list-platforms.md | 13 ----- .../examples/projects/list-webhooks.md | 13 ----- .../console-web/examples/projects/list.md | 14 ----- .../projects/update-api-status-all.md | 14 ----- .../examples/projects/update-api-status.md | 15 ----- .../examples/projects/update-auth-duration.md | 14 ----- .../examples/projects/update-auth-limit.md | 14 ----- .../update-auth-password-dictionary.md | 14 ----- .../projects/update-auth-password-history.md | 14 ----- .../projects/update-auth-sessions-limit.md | 14 ----- .../examples/projects/update-auth-status.md | 15 ----- .../projects/update-email-template.md | 20 ------- .../examples/projects/update-key.md | 17 ------ .../examples/projects/update-mock-numbers.md | 14 ----- .../examples/projects/update-o-auth2.md | 17 ------ .../projects/update-personal-data-check.md | 14 ----- .../examples/projects/update-platform.md | 18 ------ .../projects/update-service-status-all.md | 14 ----- .../projects/update-service-status.md | 15 ----- .../projects/update-session-alerts.md | 14 ----- .../examples/projects/update-sms-template.md | 16 ------ .../examples/projects/update-smtp.md | 22 ------- .../examples/projects/update-team.md | 14 ----- .../projects/update-webhook-signature.md | 14 ----- .../examples/projects/update-webhook.md | 21 ------- .../console-web/examples/projects/update.md | 23 -------- .../console-web/examples/proxy/create-rule.md | 15 ----- .../console-web/examples/proxy/delete-rule.md | 13 ----- .../console-web/examples/proxy/get-rule.md | 13 ----- .../console-web/examples/proxy/list-rules.md | 14 ----- .../proxy/update-rule-verification.md | 13 ----- .../examples/storage/create-bucket.md | 22 ------- .../examples/storage/create-file.md | 16 ------ .../examples/storage/delete-bucket.md | 13 ----- .../examples/storage/delete-file.md | 14 ----- .../examples/storage/get-bucket-usage.md | 14 ----- .../examples/storage/get-bucket.md | 13 ----- .../examples/storage/get-file-download.md | 14 ----- .../examples/storage/get-file-preview.md | 25 -------- .../examples/storage/get-file-view.md | 14 ----- .../console-web/examples/storage/get-file.md | 14 ----- .../console-web/examples/storage/get-usage.md | 13 ----- .../examples/storage/list-buckets.md | 14 ----- .../examples/storage/list-files.md | 15 ----- .../examples/storage/update-bucket.md | 22 ------- .../examples/storage/update-file.md | 16 ------ .../examples/teams/create-membership.md | 19 ------- .../console-web/examples/teams/create.md | 15 ----- .../examples/teams/delete-membership.md | 14 ----- .../console-web/examples/teams/delete.md | 13 ----- .../examples/teams/get-membership.md | 14 ----- .../console-web/examples/teams/get-prefs.md | 13 ----- .../1.6.x/console-web/examples/teams/get.md | 13 ----- .../console-web/examples/teams/list-logs.md | 14 ----- .../examples/teams/list-memberships.md | 15 ----- .../1.6.x/console-web/examples/teams/list.md | 14 ----- .../teams/update-membership-status.md | 16 ------ .../examples/teams/update-membership.md | 15 ----- .../console-web/examples/teams/update-name.md | 14 ----- .../examples/teams/update-prefs.md | 14 ----- .../examples/users/create-argon2user.md | 16 ------ .../examples/users/create-bcrypt-user.md | 16 ------ .../examples/users/create-j-w-t.md | 15 ----- .../examples/users/create-m-d5user.md | 16 ------ .../users/create-mfa-recovery-codes.md | 13 ----- .../examples/users/create-p-h-pass-user.md | 16 ------ .../examples/users/create-s-h-a-user.md | 17 ------ .../users/create-scrypt-modified-user.md | 19 ------- .../examples/users/create-scrypt-user.md | 21 ------- .../examples/users/create-session.md | 13 ----- .../examples/users/create-target.md | 18 ------ .../examples/users/create-token.md | 15 ----- .../console-web/examples/users/create.md | 17 ------ .../examples/users/delete-identity.md | 13 ----- .../users/delete-mfa-authenticator.md | 14 ----- .../examples/users/delete-session.md | 14 ----- .../examples/users/delete-sessions.md | 13 ----- .../examples/users/delete-target.md | 14 ----- .../console-web/examples/users/delete.md | 13 ----- .../examples/users/get-mfa-recovery-codes.md | 13 ----- .../console-web/examples/users/get-prefs.md | 13 ----- .../console-web/examples/users/get-target.md | 14 ----- .../console-web/examples/users/get-usage.md | 13 ----- .../1.6.x/console-web/examples/users/get.md | 13 ----- .../examples/users/list-identities.md | 14 ----- .../console-web/examples/users/list-logs.md | 14 ----- .../examples/users/list-memberships.md | 13 ----- .../examples/users/list-mfa-factors.md | 13 ----- .../examples/users/list-sessions.md | 13 ----- .../examples/users/list-targets.md | 14 ----- .../1.6.x/console-web/examples/users/list.md | 14 ----- .../users/update-email-verification.md | 14 ----- .../examples/users/update-email.md | 14 ----- .../examples/users/update-labels.md | 14 ----- .../users/update-mfa-recovery-codes.md | 13 ----- .../console-web/examples/users/update-mfa.md | 14 ----- .../console-web/examples/users/update-name.md | 14 ----- .../examples/users/update-password.md | 14 ----- .../users/update-phone-verification.md | 14 ----- .../examples/users/update-phone.md | 14 ----- .../examples/users/update-prefs.md | 14 ----- .../examples/users/update-status.md | 14 ----- .../examples/users/update-target.md | 17 ------ .../vcs/create-repository-detection.md | 15 ----- .../examples/vcs/create-repository.md | 15 ----- .../examples/vcs/delete-installation.md | 13 ----- .../examples/vcs/get-installation.md | 13 ----- .../examples/vcs/get-repository-contents.md | 15 ----- .../examples/vcs/get-repository.md | 14 ----- .../examples/vcs/list-installations.md | 14 ----- .../examples/vcs/list-repositories.md | 14 ----- .../examples/vcs/list-repository-branches.md | 14 ----- .../vcs/update-external-deployments.md | 15 ----- .../account/create-anonymous-session.md | 9 --- .../account/create-email-password-session.md | 12 ---- .../examples/account/create-email-token.md | 13 ----- .../examples/account/create-j-w-t.md | 9 --- .../account/create-magic-u-r-l-token.md | 14 ----- .../account/create-mfa-authenticator.md | 12 ---- .../examples/account/create-mfa-challenge.md | 11 ---- .../account/create-mfa-recovery-codes.md | 10 ---- .../examples/account/create-o-auth2token.md | 14 ----- .../examples/account/create-phone-token.md | 12 ---- .../account/create-phone-verification.md | 10 ---- .../examples/account/create-recovery.md | 13 ----- .../examples/account/create-session.md | 12 ---- .../examples/account/create-verification.md | 12 ---- .../server-dart/examples/account/create.md | 14 ----- .../examples/account/delete-identity.md | 12 ---- .../account/delete-mfa-authenticator.md | 12 ---- .../examples/account/delete-session.md | 12 ---- .../examples/account/delete-sessions.md | 10 ---- .../account/get-mfa-recovery-codes.md | 10 ---- .../server-dart/examples/account/get-prefs.md | 10 ---- .../examples/account/get-session.md | 12 ---- .../1.6.x/server-dart/examples/account/get.md | 10 ---- .../examples/account/list-identities.md | 12 ---- .../server-dart/examples/account/list-logs.md | 12 ---- .../examples/account/list-mfa-factors.md | 10 ---- .../examples/account/list-sessions.md | 10 ---- .../examples/account/update-email.md | 13 ----- .../examples/account/update-m-f-a.md | 12 ---- .../account/update-magic-u-r-l-session.md | 12 ---- .../account/update-mfa-authenticator.md | 13 ----- .../examples/account/update-mfa-challenge.md | 13 ----- .../account/update-mfa-recovery-codes.md | 10 ---- .../examples/account/update-name.md | 12 ---- .../examples/account/update-password.md | 13 ----- .../examples/account/update-phone-session.md | 12 ---- .../account/update-phone-verification.md | 13 ----- .../examples/account/update-phone.md | 13 ----- .../examples/account/update-prefs.md | 12 ---- .../examples/account/update-recovery.md | 14 ----- .../examples/account/update-session.md | 12 ---- .../examples/account/update-status.md | 10 ---- .../examples/account/update-verification.md | 13 ----- .../examples/avatars/get-browser.md | 15 ----- .../examples/avatars/get-credit-card.md | 15 ----- .../examples/avatars/get-favicon.md | 12 ---- .../server-dart/examples/avatars/get-flag.md | 15 ----- .../server-dart/examples/avatars/get-image.md | 14 ----- .../examples/avatars/get-initials.md | 15 ----- .../server-dart/examples/avatars/get-q-r.md | 15 ----- .../databases/create-boolean-attribute.md | 17 ------ .../examples/databases/create-collection.md | 17 ------ .../databases/create-datetime-attribute.md | 17 ------ .../examples/databases/create-document.md | 16 ------ .../databases/create-email-attribute.md | 17 ------ .../databases/create-enum-attribute.md | 18 ------ .../databases/create-float-attribute.md | 19 ------- .../examples/databases/create-index.md | 17 ------ .../databases/create-integer-attribute.md | 19 ------- .../examples/databases/create-ip-attribute.md | 17 ------ .../create-relationship-attribute.md | 19 ------- .../databases/create-string-attribute.md | 19 ------- .../databases/create-url-attribute.md | 17 ------ .../server-dart/examples/databases/create.md | 14 ----- .../examples/databases/delete-attribute.md | 14 ----- .../examples/databases/delete-collection.md | 13 ----- .../examples/databases/delete-document.md | 14 ----- .../examples/databases/delete-index.md | 14 ----- .../server-dart/examples/databases/delete.md | 12 ---- .../examples/databases/get-attribute.md | 14 ----- .../examples/databases/get-collection.md | 13 ----- .../examples/databases/get-document.md | 15 ----- .../examples/databases/get-index.md | 14 ----- .../server-dart/examples/databases/get.md | 12 ---- .../examples/databases/list-attributes.md | 14 ----- .../examples/databases/list-collections.md | 14 ----- .../examples/databases/list-documents.md | 14 ----- .../examples/databases/list-indexes.md | 14 ----- .../server-dart/examples/databases/list.md | 13 ----- .../databases/update-boolean-attribute.md | 16 ------ .../examples/databases/update-collection.md | 17 ------ .../databases/update-datetime-attribute.md | 16 ------ .../examples/databases/update-document.md | 16 ------ .../databases/update-email-attribute.md | 16 ------ .../databases/update-enum-attribute.md | 17 ------ .../databases/update-float-attribute.md | 18 ------ .../databases/update-integer-attribute.md | 18 ------ .../examples/databases/update-ip-attribute.md | 16 ------ .../update-relationship-attribute.md | 15 ----- .../databases/update-string-attribute.md | 16 ------ .../databases/update-url-attribute.md | 16 ------ .../server-dart/examples/databases/update.md | 14 ----- .../examples/functions/create-build.md | 14 ----- .../examples/functions/create-deployment.md | 16 ------ .../examples/functions/create-execution.md | 18 ------ .../examples/functions/create-variable.md | 14 ----- .../server-dart/examples/functions/create.md | 32 ----------- .../examples/functions/delete-deployment.md | 13 ----- .../examples/functions/delete-execution.md | 13 ----- .../examples/functions/delete-variable.md | 13 ----- .../server-dart/examples/functions/delete.md | 12 ---- .../examples/functions/download-deployment.md | 13 ----- .../examples/functions/get-deployment.md | 13 ----- .../examples/functions/get-execution.md | 13 ----- .../examples/functions/get-variable.md | 13 ----- .../server-dart/examples/functions/get.md | 12 ---- .../examples/functions/list-deployments.md | 14 ----- .../examples/functions/list-executions.md | 14 ----- .../examples/functions/list-runtimes.md | 10 ---- .../examples/functions/list-variables.md | 12 ---- .../server-dart/examples/functions/list.md | 13 ----- .../functions/update-deployment-build.md | 13 ----- .../examples/functions/update-deployment.md | 13 ----- .../examples/functions/update-variable.md | 15 ----- .../server-dart/examples/functions/update.md | 28 --------- .../server-dart/examples/graphql/mutation.md | 12 ---- .../server-dart/examples/graphql/query.md | 12 ---- .../examples/health/get-antivirus.md | 10 ---- .../server-dart/examples/health/get-cache.md | 10 ---- .../examples/health/get-certificate.md | 12 ---- .../server-dart/examples/health/get-d-b.md | 10 ---- .../examples/health/get-failed-jobs.md | 13 ----- .../examples/health/get-pub-sub.md | 10 ---- .../examples/health/get-queue-builds.md | 12 ---- .../examples/health/get-queue-certificates.md | 12 ---- .../examples/health/get-queue-databases.md | 13 ----- .../examples/health/get-queue-deletes.md | 12 ---- .../examples/health/get-queue-functions.md | 12 ---- .../examples/health/get-queue-logs.md | 12 ---- .../examples/health/get-queue-mails.md | 12 ---- .../examples/health/get-queue-messaging.md | 12 ---- .../examples/health/get-queue-migrations.md | 12 ---- .../examples/health/get-queue-usage-dump.md | 12 ---- .../examples/health/get-queue-usage.md | 12 ---- .../examples/health/get-queue-webhooks.md | 12 ---- .../server-dart/examples/health/get-queue.md | 10 ---- .../examples/health/get-storage-local.md | 10 ---- .../examples/health/get-storage.md | 10 ---- .../server-dart/examples/health/get-time.md | 10 ---- .../1.6.x/server-dart/examples/health/get.md | 10 ---- .../1.6.x/server-dart/examples/locale/get.md | 10 ---- .../server-dart/examples/locale/list-codes.md | 10 ---- .../examples/locale/list-continents.md | 10 ---- .../examples/locale/list-countries-e-u.md | 10 ---- .../examples/locale/list-countries-phones.md | 10 ---- .../examples/locale/list-countries.md | 10 ---- .../examples/locale/list-currencies.md | 10 ---- .../examples/locale/list-languages.md | 10 ---- .../messaging/create-apns-provider.md | 19 ------- .../examples/messaging/create-email.md | 23 -------- .../examples/messaging/create-fcm-provider.md | 15 ----- .../messaging/create-mailgun-provider.md | 21 ------- .../messaging/create-msg91provider.md | 17 ------ .../examples/messaging/create-push.md | 27 --------- .../messaging/create-sendgrid-provider.md | 19 ------- .../examples/messaging/create-sms.md | 18 ------ .../messaging/create-smtp-provider.md | 25 -------- .../examples/messaging/create-subscriber.md | 14 ----- .../messaging/create-telesign-provider.md | 17 ------ .../messaging/create-textmagic-provider.md | 17 ------ .../examples/messaging/create-topic.md | 14 ----- .../messaging/create-twilio-provider.md | 17 ------ .../messaging/create-vonage-provider.md | 17 ------ .../examples/messaging/delete-provider.md | 12 ---- .../examples/messaging/delete-subscriber.md | 13 ----- .../examples/messaging/delete-topic.md | 12 ---- .../server-dart/examples/messaging/delete.md | 12 ---- .../examples/messaging/get-message.md | 12 ---- .../examples/messaging/get-provider.md | 12 ---- .../examples/messaging/get-subscriber.md | 13 ----- .../examples/messaging/get-topic.md | 12 ---- .../examples/messaging/list-message-logs.md | 13 ----- .../examples/messaging/list-messages.md | 13 ----- .../examples/messaging/list-provider-logs.md | 13 ----- .../examples/messaging/list-providers.md | 13 ----- .../messaging/list-subscriber-logs.md | 13 ----- .../examples/messaging/list-subscribers.md | 14 ----- .../examples/messaging/list-targets.md | 13 ----- .../examples/messaging/list-topic-logs.md | 13 ----- .../examples/messaging/list-topics.md | 13 ----- .../messaging/update-apns-provider.md | 19 ------- .../examples/messaging/update-email.md | 23 -------- .../examples/messaging/update-fcm-provider.md | 15 ----- .../messaging/update-mailgun-provider.md | 21 ------- .../messaging/update-msg91provider.md | 17 ------ .../examples/messaging/update-push.md | 27 --------- .../messaging/update-sendgrid-provider.md | 19 ------- .../examples/messaging/update-sms.md | 18 ------ .../messaging/update-smtp-provider.md | 25 -------- .../messaging/update-telesign-provider.md | 17 ------ .../messaging/update-textmagic-provider.md | 17 ------ .../examples/messaging/update-topic.md | 14 ----- .../messaging/update-twilio-provider.md | 17 ------ .../messaging/update-vonage-provider.md | 17 ------ .../examples/storage/create-bucket.md | 21 ------- .../examples/storage/create-file.md | 16 ------ .../examples/storage/delete-bucket.md | 12 ---- .../examples/storage/delete-file.md | 13 ----- .../examples/storage/get-bucket.md | 12 ---- .../examples/storage/get-file-download.md | 13 ----- .../examples/storage/get-file-preview.md | 24 -------- .../examples/storage/get-file-view.md | 13 ----- .../server-dart/examples/storage/get-file.md | 13 ----- .../examples/storage/list-buckets.md | 13 ----- .../examples/storage/list-files.md | 14 ----- .../examples/storage/update-bucket.md | 21 ------- .../examples/storage/update-file.md | 15 ----- .../examples/teams/create-membership.md | 18 ------ .../server-dart/examples/teams/create.md | 14 ----- .../examples/teams/delete-membership.md | 13 ----- .../server-dart/examples/teams/delete.md | 12 ---- .../examples/teams/get-membership.md | 13 ----- .../server-dart/examples/teams/get-prefs.md | 12 ---- .../1.6.x/server-dart/examples/teams/get.md | 12 ---- .../examples/teams/list-memberships.md | 14 ----- .../1.6.x/server-dart/examples/teams/list.md | 13 ----- .../teams/update-membership-status.md | 15 ----- .../examples/teams/update-membership.md | 14 ----- .../server-dart/examples/teams/update-name.md | 13 ----- .../examples/teams/update-prefs.md | 13 ----- .../examples/users/create-argon2user.md | 15 ----- .../examples/users/create-bcrypt-user.md | 15 ----- .../examples/users/create-j-w-t.md | 14 ----- .../examples/users/create-m-d5user.md | 15 ----- .../users/create-mfa-recovery-codes.md | 12 ---- .../examples/users/create-p-h-pass-user.md | 15 ----- .../examples/users/create-s-h-a-user.md | 16 ------ .../users/create-scrypt-modified-user.md | 18 ------ .../examples/users/create-scrypt-user.md | 20 ------- .../examples/users/create-session.md | 12 ---- .../examples/users/create-target.md | 17 ------ .../examples/users/create-token.md | 14 ----- .../server-dart/examples/users/create.md | 16 ------ .../examples/users/delete-identity.md | 12 ---- .../users/delete-mfa-authenticator.md | 13 ----- .../examples/users/delete-session.md | 13 ----- .../examples/users/delete-sessions.md | 12 ---- .../examples/users/delete-target.md | 13 ----- .../server-dart/examples/users/delete.md | 12 ---- .../examples/users/get-mfa-recovery-codes.md | 12 ---- .../server-dart/examples/users/get-prefs.md | 12 ---- .../server-dart/examples/users/get-target.md | 13 ----- .../1.6.x/server-dart/examples/users/get.md | 12 ---- .../examples/users/list-identities.md | 13 ----- .../server-dart/examples/users/list-logs.md | 13 ----- .../examples/users/list-memberships.md | 12 ---- .../examples/users/list-mfa-factors.md | 12 ---- .../examples/users/list-sessions.md | 12 ---- .../examples/users/list-targets.md | 13 ----- .../1.6.x/server-dart/examples/users/list.md | 13 ----- .../users/update-email-verification.md | 13 ----- .../examples/users/update-email.md | 13 ----- .../examples/users/update-labels.md | 13 ----- .../users/update-mfa-recovery-codes.md | 12 ---- .../server-dart/examples/users/update-mfa.md | 13 ----- .../server-dart/examples/users/update-name.md | 13 ----- .../examples/users/update-password.md | 13 ----- .../users/update-phone-verification.md | 13 ----- .../examples/users/update-phone.md | 13 ----- .../examples/users/update-prefs.md | 13 ----- .../examples/users/update-status.md | 13 ----- .../examples/users/update-target.md | 16 ------ .../account/create-anonymous-session.md | 9 --- .../account/create-email-password-session.md | 12 ---- .../examples/account/create-email-token.md | 13 ----- .../examples/account/create-j-w-t.md | 9 --- .../account/create-magic-u-r-l-token.md | 14 ----- .../account/create-mfa-authenticator.md | 12 ---- .../examples/account/create-mfa-challenge.md | 11 ---- .../account/create-mfa-recovery-codes.md | 10 ---- .../examples/account/create-o-auth2token.md | 14 ----- .../examples/account/create-phone-token.md | 12 ---- .../account/create-phone-verification.md | 10 ---- .../examples/account/create-recovery.md | 13 ----- .../examples/account/create-session.md | 12 ---- .../examples/account/create-verification.md | 12 ---- .../server-deno/examples/account/create.md | 14 ----- .../examples/account/delete-identity.md | 12 ---- .../account/delete-mfa-authenticator.md | 12 ---- .../examples/account/delete-session.md | 12 ---- .../examples/account/delete-sessions.md | 10 ---- .../account/get-mfa-recovery-codes.md | 10 ---- .../server-deno/examples/account/get-prefs.md | 10 ---- .../examples/account/get-session.md | 12 ---- .../1.6.x/server-deno/examples/account/get.md | 10 ---- .../examples/account/list-identities.md | 12 ---- .../server-deno/examples/account/list-logs.md | 12 ---- .../examples/account/list-mfa-factors.md | 10 ---- .../examples/account/list-sessions.md | 10 ---- .../examples/account/update-email.md | 13 ----- .../examples/account/update-m-f-a.md | 12 ---- .../account/update-magic-u-r-l-session.md | 12 ---- .../account/update-mfa-authenticator.md | 13 ----- .../examples/account/update-mfa-challenge.md | 13 ----- .../account/update-mfa-recovery-codes.md | 10 ---- .../examples/account/update-name.md | 12 ---- .../examples/account/update-password.md | 13 ----- .../examples/account/update-phone-session.md | 12 ---- .../account/update-phone-verification.md | 13 ----- .../examples/account/update-phone.md | 13 ----- .../examples/account/update-prefs.md | 12 ---- .../examples/account/update-recovery.md | 14 ----- .../examples/account/update-session.md | 12 ---- .../examples/account/update-status.md | 10 ---- .../examples/account/update-verification.md | 13 ----- .../examples/avatars/get-browser.md | 15 ----- .../examples/avatars/get-credit-card.md | 15 ----- .../examples/avatars/get-favicon.md | 12 ---- .../server-deno/examples/avatars/get-flag.md | 15 ----- .../server-deno/examples/avatars/get-image.md | 14 ----- .../examples/avatars/get-initials.md | 15 ----- .../server-deno/examples/avatars/get-q-r.md | 15 ----- .../databases/create-boolean-attribute.md | 17 ------ .../examples/databases/create-collection.md | 17 ------ .../databases/create-datetime-attribute.md | 17 ------ .../examples/databases/create-document.md | 16 ------ .../databases/create-email-attribute.md | 17 ------ .../databases/create-enum-attribute.md | 18 ------ .../databases/create-float-attribute.md | 19 ------- .../examples/databases/create-index.md | 17 ------ .../databases/create-integer-attribute.md | 19 ------- .../examples/databases/create-ip-attribute.md | 17 ------ .../create-relationship-attribute.md | 19 ------- .../databases/create-string-attribute.md | 19 ------- .../databases/create-url-attribute.md | 17 ------ .../server-deno/examples/databases/create.md | 14 ----- .../examples/databases/delete-attribute.md | 14 ----- .../examples/databases/delete-collection.md | 13 ----- .../examples/databases/delete-document.md | 14 ----- .../examples/databases/delete-index.md | 14 ----- .../server-deno/examples/databases/delete.md | 12 ---- .../examples/databases/get-attribute.md | 14 ----- .../examples/databases/get-collection.md | 13 ----- .../examples/databases/get-document.md | 15 ----- .../examples/databases/get-index.md | 14 ----- .../server-deno/examples/databases/get.md | 12 ---- .../examples/databases/list-attributes.md | 14 ----- .../examples/databases/list-collections.md | 14 ----- .../examples/databases/list-documents.md | 14 ----- .../examples/databases/list-indexes.md | 14 ----- .../server-deno/examples/databases/list.md | 13 ----- .../databases/update-boolean-attribute.md | 16 ------ .../examples/databases/update-collection.md | 17 ------ .../databases/update-datetime-attribute.md | 16 ------ .../examples/databases/update-document.md | 16 ------ .../databases/update-email-attribute.md | 16 ------ .../databases/update-enum-attribute.md | 17 ------ .../databases/update-float-attribute.md | 18 ------ .../databases/update-integer-attribute.md | 18 ------ .../examples/databases/update-ip-attribute.md | 16 ------ .../update-relationship-attribute.md | 15 ----- .../databases/update-string-attribute.md | 16 ------ .../databases/update-url-attribute.md | 16 ------ .../server-deno/examples/databases/update.md | 14 ----- .../examples/functions/create-build.md | 14 ----- .../examples/functions/create-deployment.md | 16 ------ .../examples/functions/create-execution.md | 18 ------ .../examples/functions/create-variable.md | 14 ----- .../server-deno/examples/functions/create.md | 32 ----------- .../examples/functions/delete-deployment.md | 13 ----- .../examples/functions/delete-execution.md | 13 ----- .../examples/functions/delete-variable.md | 13 ----- .../server-deno/examples/functions/delete.md | 12 ---- .../examples/functions/download-deployment.md | 13 ----- .../examples/functions/get-deployment.md | 13 ----- .../examples/functions/get-execution.md | 13 ----- .../examples/functions/get-variable.md | 13 ----- .../server-deno/examples/functions/get.md | 12 ---- .../examples/functions/list-deployments.md | 14 ----- .../examples/functions/list-executions.md | 14 ----- .../examples/functions/list-runtimes.md | 10 ---- .../examples/functions/list-variables.md | 12 ---- .../server-deno/examples/functions/list.md | 13 ----- .../functions/update-deployment-build.md | 13 ----- .../examples/functions/update-deployment.md | 13 ----- .../examples/functions/update-variable.md | 15 ----- .../server-deno/examples/functions/update.md | 28 --------- .../server-deno/examples/graphql/mutation.md | 12 ---- .../server-deno/examples/graphql/query.md | 12 ---- .../examples/health/get-antivirus.md | 10 ---- .../server-deno/examples/health/get-cache.md | 10 ---- .../examples/health/get-certificate.md | 12 ---- .../server-deno/examples/health/get-d-b.md | 10 ---- .../examples/health/get-failed-jobs.md | 13 ----- .../examples/health/get-pub-sub.md | 10 ---- .../examples/health/get-queue-builds.md | 12 ---- .../examples/health/get-queue-certificates.md | 12 ---- .../examples/health/get-queue-databases.md | 13 ----- .../examples/health/get-queue-deletes.md | 12 ---- .../examples/health/get-queue-functions.md | 12 ---- .../examples/health/get-queue-logs.md | 12 ---- .../examples/health/get-queue-mails.md | 12 ---- .../examples/health/get-queue-messaging.md | 12 ---- .../examples/health/get-queue-migrations.md | 12 ---- .../examples/health/get-queue-usage-dump.md | 12 ---- .../examples/health/get-queue-usage.md | 12 ---- .../examples/health/get-queue-webhooks.md | 12 ---- .../server-deno/examples/health/get-queue.md | 10 ---- .../examples/health/get-storage-local.md | 10 ---- .../examples/health/get-storage.md | 10 ---- .../server-deno/examples/health/get-time.md | 10 ---- .../1.6.x/server-deno/examples/health/get.md | 10 ---- .../1.6.x/server-deno/examples/locale/get.md | 10 ---- .../server-deno/examples/locale/list-codes.md | 10 ---- .../examples/locale/list-continents.md | 10 ---- .../examples/locale/list-countries-e-u.md | 10 ---- .../examples/locale/list-countries-phones.md | 10 ---- .../examples/locale/list-countries.md | 10 ---- .../examples/locale/list-currencies.md | 10 ---- .../examples/locale/list-languages.md | 10 ---- .../messaging/create-apns-provider.md | 19 ------- .../examples/messaging/create-email.md | 23 -------- .../examples/messaging/create-fcm-provider.md | 15 ----- .../messaging/create-mailgun-provider.md | 21 ------- .../messaging/create-msg91provider.md | 17 ------ .../examples/messaging/create-push.md | 27 --------- .../messaging/create-sendgrid-provider.md | 19 ------- .../examples/messaging/create-sms.md | 18 ------ .../messaging/create-smtp-provider.md | 25 -------- .../examples/messaging/create-subscriber.md | 14 ----- .../messaging/create-telesign-provider.md | 17 ------ .../messaging/create-textmagic-provider.md | 17 ------ .../examples/messaging/create-topic.md | 14 ----- .../messaging/create-twilio-provider.md | 17 ------ .../messaging/create-vonage-provider.md | 17 ------ .../examples/messaging/delete-provider.md | 12 ---- .../examples/messaging/delete-subscriber.md | 13 ----- .../examples/messaging/delete-topic.md | 12 ---- .../server-deno/examples/messaging/delete.md | 12 ---- .../examples/messaging/get-message.md | 12 ---- .../examples/messaging/get-provider.md | 12 ---- .../examples/messaging/get-subscriber.md | 13 ----- .../examples/messaging/get-topic.md | 12 ---- .../examples/messaging/list-message-logs.md | 13 ----- .../examples/messaging/list-messages.md | 13 ----- .../examples/messaging/list-provider-logs.md | 13 ----- .../examples/messaging/list-providers.md | 13 ----- .../messaging/list-subscriber-logs.md | 13 ----- .../examples/messaging/list-subscribers.md | 14 ----- .../examples/messaging/list-targets.md | 13 ----- .../examples/messaging/list-topic-logs.md | 13 ----- .../examples/messaging/list-topics.md | 13 ----- .../messaging/update-apns-provider.md | 19 ------- .../examples/messaging/update-email.md | 23 -------- .../examples/messaging/update-fcm-provider.md | 15 ----- .../messaging/update-mailgun-provider.md | 21 ------- .../messaging/update-msg91provider.md | 17 ------ .../examples/messaging/update-push.md | 27 --------- .../messaging/update-sendgrid-provider.md | 19 ------- .../examples/messaging/update-sms.md | 18 ------ .../messaging/update-smtp-provider.md | 25 -------- .../messaging/update-telesign-provider.md | 17 ------ .../messaging/update-textmagic-provider.md | 17 ------ .../examples/messaging/update-topic.md | 14 ----- .../messaging/update-twilio-provider.md | 17 ------ .../messaging/update-vonage-provider.md | 17 ------ .../examples/storage/create-bucket.md | 21 ------- .../examples/storage/create-file.md | 15 ----- .../examples/storage/delete-bucket.md | 12 ---- .../examples/storage/delete-file.md | 13 ----- .../examples/storage/get-bucket.md | 12 ---- .../examples/storage/get-file-download.md | 13 ----- .../examples/storage/get-file-preview.md | 24 -------- .../examples/storage/get-file-view.md | 13 ----- .../server-deno/examples/storage/get-file.md | 13 ----- .../examples/storage/list-buckets.md | 13 ----- .../examples/storage/list-files.md | 14 ----- .../examples/storage/update-bucket.md | 21 ------- .../examples/storage/update-file.md | 15 ----- .../examples/teams/create-membership.md | 18 ------ .../server-deno/examples/teams/create.md | 14 ----- .../examples/teams/delete-membership.md | 13 ----- .../server-deno/examples/teams/delete.md | 12 ---- .../examples/teams/get-membership.md | 13 ----- .../server-deno/examples/teams/get-prefs.md | 12 ---- .../1.6.x/server-deno/examples/teams/get.md | 12 ---- .../examples/teams/list-memberships.md | 14 ----- .../1.6.x/server-deno/examples/teams/list.md | 13 ----- .../teams/update-membership-status.md | 15 ----- .../examples/teams/update-membership.md | 14 ----- .../server-deno/examples/teams/update-name.md | 13 ----- .../examples/teams/update-prefs.md | 13 ----- .../examples/users/create-argon2user.md | 15 ----- .../examples/users/create-bcrypt-user.md | 15 ----- .../examples/users/create-j-w-t.md | 14 ----- .../examples/users/create-m-d5user.md | 15 ----- .../users/create-mfa-recovery-codes.md | 12 ---- .../examples/users/create-p-h-pass-user.md | 15 ----- .../examples/users/create-s-h-a-user.md | 16 ------ .../users/create-scrypt-modified-user.md | 18 ------ .../examples/users/create-scrypt-user.md | 20 ------- .../examples/users/create-session.md | 12 ---- .../examples/users/create-target.md | 17 ------ .../examples/users/create-token.md | 14 ----- .../server-deno/examples/users/create.md | 16 ------ .../examples/users/delete-identity.md | 12 ---- .../users/delete-mfa-authenticator.md | 13 ----- .../examples/users/delete-session.md | 13 ----- .../examples/users/delete-sessions.md | 12 ---- .../examples/users/delete-target.md | 13 ----- .../server-deno/examples/users/delete.md | 12 ---- .../examples/users/get-mfa-recovery-codes.md | 12 ---- .../server-deno/examples/users/get-prefs.md | 12 ---- .../server-deno/examples/users/get-target.md | 13 ----- .../1.6.x/server-deno/examples/users/get.md | 12 ---- .../examples/users/list-identities.md | 13 ----- .../server-deno/examples/users/list-logs.md | 13 ----- .../examples/users/list-memberships.md | 12 ---- .../examples/users/list-mfa-factors.md | 12 ---- .../examples/users/list-sessions.md | 12 ---- .../examples/users/list-targets.md | 13 ----- .../1.6.x/server-deno/examples/users/list.md | 13 ----- .../users/update-email-verification.md | 13 ----- .../examples/users/update-email.md | 13 ----- .../examples/users/update-labels.md | 13 ----- .../users/update-mfa-recovery-codes.md | 12 ---- .../server-deno/examples/users/update-mfa.md | 13 ----- .../server-deno/examples/users/update-name.md | 13 ----- .../examples/users/update-password.md | 13 ----- .../users/update-phone-verification.md | 13 ----- .../examples/users/update-phone.md | 13 ----- .../examples/users/update-prefs.md | 13 ----- .../examples/users/update-status.md | 13 ----- .../examples/users/update-target.md | 16 ------ .../account/create-anonymous-session.md | 11 ---- .../account/create-email-password-session.md | 14 ----- .../examples/account/create-email-token.md | 15 ----- .../examples/account/create-j-w-t.md | 11 ---- .../account/create-magic-u-r-l-token.md | 16 ------ .../account/create-mfa-authenticator.md | 15 ----- .../examples/account/create-mfa-challenge.md | 14 ----- .../account/create-mfa-recovery-codes.md | 12 ---- .../examples/account/create-o-auth2token.md | 17 ------ .../examples/account/create-phone-token.md | 14 ----- .../account/create-phone-verification.md | 12 ---- .../examples/account/create-recovery.md | 15 ----- .../examples/account/create-session.md | 14 ----- .../examples/account/create-verification.md | 14 ----- .../server-dotnet/examples/account/create.md | 16 ------ .../examples/account/delete-identity.md | 14 ----- .../account/delete-mfa-authenticator.md | 15 ----- .../examples/account/delete-session.md | 14 ----- .../examples/account/delete-sessions.md | 12 ---- .../account/get-mfa-recovery-codes.md | 12 ---- .../examples/account/get-prefs.md | 12 ---- .../examples/account/get-session.md | 14 ----- .../server-dotnet/examples/account/get.md | 12 ---- .../examples/account/list-identities.md | 14 ----- .../examples/account/list-logs.md | 14 ----- .../examples/account/list-mfa-factors.md | 12 ---- .../examples/account/list-sessions.md | 12 ---- .../examples/account/update-email.md | 15 ----- .../examples/account/update-m-f-a.md | 14 ----- .../account/update-magic-u-r-l-session.md | 14 ----- .../account/update-mfa-authenticator.md | 16 ------ .../examples/account/update-mfa-challenge.md | 15 ----- .../account/update-mfa-recovery-codes.md | 12 ---- .../examples/account/update-name.md | 14 ----- .../examples/account/update-password.md | 15 ----- .../examples/account/update-phone-session.md | 14 ----- .../account/update-phone-verification.md | 15 ----- .../examples/account/update-phone.md | 15 ----- .../examples/account/update-prefs.md | 14 ----- .../examples/account/update-recovery.md | 16 ------ .../examples/account/update-session.md | 14 ----- .../examples/account/update-status.md | 12 ---- .../examples/account/update-verification.md | 15 ----- .../examples/avatars/get-browser.md | 18 ------ .../examples/avatars/get-credit-card.md | 18 ------ .../examples/avatars/get-favicon.md | 14 ----- .../examples/avatars/get-flag.md | 18 ------ .../examples/avatars/get-image.md | 16 ------ .../examples/avatars/get-initials.md | 17 ------ .../server-dotnet/examples/avatars/get-q-r.md | 17 ------ .../databases/create-boolean-attribute.md | 19 ------- .../examples/databases/create-collection.md | 19 ------- .../databases/create-datetime-attribute.md | 19 ------- .../examples/databases/create-document.md | 18 ------ .../databases/create-email-attribute.md | 19 ------- .../databases/create-enum-attribute.md | 20 ------- .../databases/create-float-attribute.md | 21 ------- .../examples/databases/create-index.md | 20 ------- .../databases/create-integer-attribute.md | 21 ------- .../examples/databases/create-ip-attribute.md | 19 ------- .../create-relationship-attribute.md | 22 ------- .../databases/create-string-attribute.md | 21 ------- .../databases/create-url-attribute.md | 19 ------- .../examples/databases/create.md | 16 ------ .../examples/databases/delete-attribute.md | 16 ------ .../examples/databases/delete-collection.md | 15 ----- .../examples/databases/delete-document.md | 16 ------ .../examples/databases/delete-index.md | 16 ------ .../examples/databases/delete.md | 14 ----- .../examples/databases/get-attribute.md | 16 ------ .../examples/databases/get-collection.md | 15 ----- .../examples/databases/get-document.md | 17 ------ .../examples/databases/get-index.md | 16 ------ .../server-dotnet/examples/databases/get.md | 14 ----- .../examples/databases/list-attributes.md | 16 ------ .../examples/databases/list-collections.md | 16 ------ .../examples/databases/list-documents.md | 16 ------ .../examples/databases/list-indexes.md | 16 ------ .../server-dotnet/examples/databases/list.md | 15 ----- .../databases/update-boolean-attribute.md | 18 ------ .../examples/databases/update-collection.md | 19 ------- .../databases/update-datetime-attribute.md | 18 ------ .../examples/databases/update-document.md | 18 ------ .../databases/update-email-attribute.md | 18 ------ .../databases/update-enum-attribute.md | 19 ------- .../databases/update-float-attribute.md | 20 ------- .../databases/update-integer-attribute.md | 20 ------- .../examples/databases/update-ip-attribute.md | 18 ------ .../update-relationship-attribute.md | 18 ------ .../databases/update-string-attribute.md | 18 ------ .../databases/update-url-attribute.md | 18 ------ .../examples/databases/update.md | 16 ------ .../examples/functions/create-build.md | 16 ------ .../examples/functions/create-deployment.md | 18 ------ .../examples/functions/create-execution.md | 21 ------- .../examples/functions/create-variable.md | 16 ------ .../examples/functions/create.md | 35 ------------ .../examples/functions/delete-deployment.md | 15 ----- .../examples/functions/delete-execution.md | 15 ----- .../examples/functions/delete-variable.md | 15 ----- .../examples/functions/delete.md | 14 ----- .../examples/functions/download-deployment.md | 15 ----- .../examples/functions/get-deployment.md | 15 ----- .../examples/functions/get-execution.md | 15 ----- .../examples/functions/get-variable.md | 15 ----- .../server-dotnet/examples/functions/get.md | 14 ----- .../examples/functions/list-deployments.md | 16 ------ .../examples/functions/list-executions.md | 16 ------ .../examples/functions/list-runtimes.md | 12 ---- .../examples/functions/list-variables.md | 14 ----- .../server-dotnet/examples/functions/list.md | 15 ----- .../functions/update-deployment-build.md | 15 ----- .../examples/functions/update-deployment.md | 15 ----- .../examples/functions/update-variable.md | 17 ------ .../examples/functions/update.md | 31 ---------- .../examples/graphql/mutation.md | 14 ----- .../server-dotnet/examples/graphql/query.md | 14 ----- .../examples/health/get-antivirus.md | 12 ---- .../examples/health/get-cache.md | 12 ---- .../examples/health/get-certificate.md | 14 ----- .../server-dotnet/examples/health/get-d-b.md | 12 ---- .../examples/health/get-failed-jobs.md | 16 ------ .../examples/health/get-pub-sub.md | 12 ---- .../examples/health/get-queue-builds.md | 14 ----- .../examples/health/get-queue-certificates.md | 14 ----- .../examples/health/get-queue-databases.md | 15 ----- .../examples/health/get-queue-deletes.md | 14 ----- .../examples/health/get-queue-functions.md | 14 ----- .../examples/health/get-queue-logs.md | 14 ----- .../examples/health/get-queue-mails.md | 14 ----- .../examples/health/get-queue-messaging.md | 14 ----- .../examples/health/get-queue-migrations.md | 14 ----- .../examples/health/get-queue-usage-dump.md | 14 ----- .../examples/health/get-queue-usage.md | 14 ----- .../examples/health/get-queue-webhooks.md | 14 ----- .../examples/health/get-queue.md | 12 ---- .../examples/health/get-storage-local.md | 12 ---- .../examples/health/get-storage.md | 12 ---- .../server-dotnet/examples/health/get-time.md | 12 ---- .../server-dotnet/examples/health/get.md | 12 ---- .../server-dotnet/examples/locale/get.md | 12 ---- .../examples/locale/list-codes.md | 12 ---- .../examples/locale/list-continents.md | 12 ---- .../examples/locale/list-countries-e-u.md | 12 ---- .../examples/locale/list-countries-phones.md | 12 ---- .../examples/locale/list-countries.md | 12 ---- .../examples/locale/list-currencies.md | 12 ---- .../examples/locale/list-languages.md | 12 ---- .../messaging/create-apns-provider.md | 21 ------- .../examples/messaging/create-email.md | 25 -------- .../examples/messaging/create-fcm-provider.md | 17 ------ .../messaging/create-mailgun-provider.md | 23 -------- .../messaging/create-msg91provider.md | 19 ------- .../examples/messaging/create-push.md | 29 ---------- .../messaging/create-sendgrid-provider.md | 21 ------- .../examples/messaging/create-sms.md | 20 ------- .../messaging/create-smtp-provider.md | 28 --------- .../examples/messaging/create-subscriber.md | 16 ------ .../messaging/create-telesign-provider.md | 19 ------- .../messaging/create-textmagic-provider.md | 19 ------- .../examples/messaging/create-topic.md | 16 ------ .../messaging/create-twilio-provider.md | 19 ------- .../messaging/create-vonage-provider.md | 19 ------- .../examples/messaging/delete-provider.md | 14 ----- .../examples/messaging/delete-subscriber.md | 15 ----- .../examples/messaging/delete-topic.md | 14 ----- .../examples/messaging/delete.md | 14 ----- .../examples/messaging/get-message.md | 14 ----- .../examples/messaging/get-provider.md | 14 ----- .../examples/messaging/get-subscriber.md | 15 ----- .../examples/messaging/get-topic.md | 14 ----- .../examples/messaging/list-message-logs.md | 15 ----- .../examples/messaging/list-messages.md | 15 ----- .../examples/messaging/list-provider-logs.md | 15 ----- .../examples/messaging/list-providers.md | 15 ----- .../messaging/list-subscriber-logs.md | 15 ----- .../examples/messaging/list-subscribers.md | 16 ------ .../examples/messaging/list-targets.md | 15 ----- .../examples/messaging/list-topic-logs.md | 15 ----- .../examples/messaging/list-topics.md | 15 ----- .../messaging/update-apns-provider.md | 21 ------- .../examples/messaging/update-email.md | 25 -------- .../examples/messaging/update-fcm-provider.md | 17 ------ .../messaging/update-mailgun-provider.md | 23 -------- .../messaging/update-msg91provider.md | 19 ------- .../examples/messaging/update-push.md | 29 ---------- .../messaging/update-sendgrid-provider.md | 21 ------- .../examples/messaging/update-sms.md | 20 ------- .../messaging/update-smtp-provider.md | 28 --------- .../messaging/update-telesign-provider.md | 19 ------- .../messaging/update-textmagic-provider.md | 19 ------- .../examples/messaging/update-topic.md | 16 ------ .../messaging/update-twilio-provider.md | 19 ------- .../messaging/update-vonage-provider.md | 19 ------- .../examples/storage/create-bucket.md | 24 -------- .../examples/storage/create-file.md | 17 ------ .../examples/storage/delete-bucket.md | 14 ----- .../examples/storage/delete-file.md | 15 ----- .../examples/storage/get-bucket.md | 14 ----- .../examples/storage/get-file-download.md | 15 ----- .../examples/storage/get-file-preview.md | 27 --------- .../examples/storage/get-file-view.md | 15 ----- .../examples/storage/get-file.md | 15 ----- .../examples/storage/list-buckets.md | 15 ----- .../examples/storage/list-files.md | 16 ------ .../examples/storage/update-bucket.md | 24 -------- .../examples/storage/update-file.md | 17 ------ .../examples/teams/create-membership.md | 20 ------- .../server-dotnet/examples/teams/create.md | 16 ------ .../examples/teams/delete-membership.md | 15 ----- .../server-dotnet/examples/teams/delete.md | 14 ----- .../examples/teams/get-membership.md | 15 ----- .../server-dotnet/examples/teams/get-prefs.md | 14 ----- .../1.6.x/server-dotnet/examples/teams/get.md | 14 ----- .../examples/teams/list-memberships.md | 16 ------ .../server-dotnet/examples/teams/list.md | 15 ----- .../teams/update-membership-status.md | 17 ------ .../examples/teams/update-membership.md | 16 ------ .../examples/teams/update-name.md | 15 ----- .../examples/teams/update-prefs.md | 15 ----- .../examples/users/create-argon2user.md | 17 ------ .../examples/users/create-bcrypt-user.md | 17 ------ .../examples/users/create-j-w-t.md | 16 ------ .../examples/users/create-m-d5user.md | 17 ------ .../users/create-mfa-recovery-codes.md | 14 ----- .../examples/users/create-p-h-pass-user.md | 17 ------ .../examples/users/create-s-h-a-user.md | 19 ------- .../users/create-scrypt-modified-user.md | 20 ------- .../examples/users/create-scrypt-user.md | 22 ------- .../examples/users/create-session.md | 14 ----- .../examples/users/create-target.md | 20 ------- .../examples/users/create-token.md | 16 ------ .../server-dotnet/examples/users/create.md | 18 ------ .../examples/users/delete-identity.md | 14 ----- .../users/delete-mfa-authenticator.md | 16 ------ .../examples/users/delete-session.md | 15 ----- .../examples/users/delete-sessions.md | 14 ----- .../examples/users/delete-target.md | 15 ----- .../server-dotnet/examples/users/delete.md | 14 ----- .../examples/users/get-mfa-recovery-codes.md | 14 ----- .../server-dotnet/examples/users/get-prefs.md | 14 ----- .../examples/users/get-target.md | 15 ----- .../1.6.x/server-dotnet/examples/users/get.md | 14 ----- .../examples/users/list-identities.md | 15 ----- .../server-dotnet/examples/users/list-logs.md | 15 ----- .../examples/users/list-memberships.md | 14 ----- .../examples/users/list-mfa-factors.md | 14 ----- .../examples/users/list-sessions.md | 14 ----- .../examples/users/list-targets.md | 15 ----- .../server-dotnet/examples/users/list.md | 15 ----- .../users/update-email-verification.md | 15 ----- .../examples/users/update-email.md | 15 ----- .../examples/users/update-labels.md | 15 ----- .../users/update-mfa-recovery-codes.md | 14 ----- .../examples/users/update-mfa.md | 15 ----- .../examples/users/update-name.md | 15 ----- .../examples/users/update-password.md | 15 ----- .../users/update-phone-verification.md | 15 ----- .../examples/users/update-phone.md | 15 ----- .../examples/users/update-prefs.md | 15 ----- .../examples/users/update-status.md | 15 ----- .../examples/users/update-target.md | 18 ------ .../account/create-anonymous-session.md | 33 ----------- .../account/create-email-password-session.md | 36 ------------ .../examples/account/create-email-token.md | 14 ----- .../examples/account/create-j-w-t.md | 5 -- .../account/create-magic-u-r-l-token.md | 15 ----- .../account/create-mfa-authenticator.md | 8 --- .../examples/account/create-mfa-challenge.md | 10 ---- .../account/create-mfa-recovery-codes.md | 5 -- .../examples/account/create-phone-token.md | 13 ----- .../account/create-phone-verification.md | 10 ---- .../examples/account/create-recovery.md | 13 ----- .../examples/account/create-session.md | 36 ------------ .../examples/account/create-verification.md | 12 ---- .../server-graphql/examples/account/create.md | 39 ------------- .../examples/account/delete-identity.md | 7 --- .../account/delete-mfa-authenticator.md | 7 --- .../examples/account/delete-session.md | 7 --- .../examples/account/delete-sessions.md | 5 -- .../account/get-mfa-recovery-codes.md | 5 -- .../examples/account/get-prefs.md | 5 -- .../examples/account/get-session.md | 35 ------------ .../server-graphql/examples/account/get.md | 34 ----------- .../examples/account/list-identities.md | 19 ------- .../examples/account/list-logs.md | 30 ---------- .../examples/account/list-mfa-factors.md | 8 --- .../examples/account/list-sessions.md | 36 ------------ .../examples/account/update-email.md | 37 ------------ .../examples/account/update-m-f-a.md | 36 ------------ .../account/update-magic-u-r-l-session.md | 36 ------------ .../account/update-mfa-authenticator.md | 37 ------------ .../examples/account/update-mfa-challenge.md | 8 --- .../account/update-mfa-recovery-codes.md | 5 -- .../examples/account/update-name.md | 36 ------------ .../examples/account/update-password.md | 37 ------------ .../examples/account/update-phone-session.md | 36 ------------ .../account/update-phone-verification.md | 13 ----- .../examples/account/update-phone.md | 37 ------------ .../examples/account/update-prefs.md | 36 ------------ .../examples/account/update-recovery.md | 14 ----- .../examples/account/update-session.md | 35 ------------ .../examples/account/update-status.md | 34 ----------- .../examples/account/update-verification.md | 13 ----- .../examples/avatars/get-browser.md | 10 ---- .../examples/avatars/get-credit-card.md | 10 ---- .../examples/avatars/get-favicon.md | 7 --- .../examples/avatars/get-flag.md | 10 ---- .../examples/avatars/get-image.md | 9 --- .../examples/avatars/get-initials.md | 10 ---- .../examples/avatars/get-q-r.md | 10 ---- .../databases/create-boolean-attribute.md | 18 ------ .../examples/databases/create-collection.md | 28 --------- .../databases/create-datetime-attribute.md | 19 ------- .../examples/databases/create-document.md | 17 ------ .../databases/create-email-attribute.md | 19 ------- .../databases/create-enum-attribute.md | 21 ------- .../databases/create-float-attribute.md | 22 ------- .../examples/databases/create-index.md | 17 ------ .../databases/create-integer-attribute.md | 22 ------- .../examples/databases/create-ip-attribute.md | 19 ------- .../create-relationship-attribute.md | 25 -------- .../databases/create-string-attribute.md | 21 ------- .../databases/create-url-attribute.md | 19 ------- .../examples/databases/create.md | 13 ----- .../examples/databases/delete-attribute.md | 9 --- .../examples/databases/delete-collection.md | 8 --- .../examples/databases/delete-document.md | 9 --- .../examples/databases/delete-index.md | 9 --- .../examples/databases/delete.md | 7 --- .../examples/databases/get-attribute.md | 9 --- .../examples/databases/get-collection.md | 24 -------- .../examples/databases/get-document.md | 16 ------ .../examples/databases/get-index.md | 14 ----- .../server-graphql/examples/databases/get.md | 11 ---- .../examples/databases/list-attributes.md | 10 ---- .../examples/databases/list-collections.md | 28 --------- .../examples/databases/list-documents.md | 18 ------ .../examples/databases/list-indexes.md | 17 ------ .../server-graphql/examples/databases/list.md | 15 ----- .../databases/update-boolean-attribute.md | 17 ------ .../examples/databases/update-collection.md | 28 --------- .../databases/update-datetime-attribute.md | 18 ------ .../examples/databases/update-document.md | 17 ------ .../databases/update-email-attribute.md | 18 ------ .../databases/update-enum-attribute.md | 20 ------- .../databases/update-float-attribute.md | 21 ------- .../databases/update-integer-attribute.md | 21 ------- .../examples/databases/update-ip-attribute.md | 18 ------ .../update-relationship-attribute.md | 21 ------- .../databases/update-string-attribute.md | 18 ------ .../databases/update-url-attribute.md | 18 ------ .../examples/databases/update.md | 13 ----- .../examples/functions/create-build.md | 9 --- .../examples/functions/create-deployment.md | 24 -------- .../examples/functions/create-execution.md | 34 ----------- .../examples/functions/create-variable.md | 15 ----- .../examples/functions/create.md | 57 ------------------- .../examples/functions/delete-deployment.md | 8 --- .../examples/functions/delete-execution.md | 8 --- .../examples/functions/delete-variable.md | 8 --- .../examples/functions/delete.md | 7 --- .../examples/functions/download-deployment.md | 8 --- .../examples/functions/get-deployment.md | 30 ---------- .../examples/functions/get-execution.md | 29 ---------- .../examples/functions/get-variable.md | 14 ----- .../server-graphql/examples/functions/get.md | 37 ------------ .../examples/functions/list-deployments.md | 34 ----------- .../examples/functions/list-executions.md | 33 ----------- .../examples/functions/list-runtimes.md | 14 ----- .../examples/functions/list-variables.md | 16 ------ .../server-graphql/examples/functions/list.md | 41 ------------- .../functions/update-deployment-build.md | 16 ------ .../examples/functions/update-deployment.md | 38 ------------- .../examples/functions/update-variable.md | 16 ------ .../examples/functions/update.md | 53 ----------------- .../examples/health/get-antivirus.md | 6 -- .../examples/health/get-cache.md | 7 --- .../examples/health/get-certificate.md | 12 ---- .../server-graphql/examples/health/get-d-b.md | 7 --- .../examples/health/get-failed-jobs.md | 8 --- .../examples/health/get-pub-sub.md | 7 --- .../examples/health/get-queue-builds.md | 7 --- .../examples/health/get-queue-certificates.md | 7 --- .../examples/health/get-queue-databases.md | 8 --- .../examples/health/get-queue-deletes.md | 7 --- .../examples/health/get-queue-functions.md | 7 --- .../examples/health/get-queue-logs.md | 7 --- .../examples/health/get-queue-mails.md | 7 --- .../examples/health/get-queue-messaging.md | 7 --- .../examples/health/get-queue-migrations.md | 7 --- .../examples/health/get-queue-usage-dump.md | 7 --- .../examples/health/get-queue-usage.md | 7 --- .../examples/health/get-queue-webhooks.md | 7 --- .../examples/health/get-queue.md | 7 --- .../examples/health/get-storage-local.md | 7 --- .../examples/health/get-storage.md | 7 --- .../examples/health/get-time.md | 7 --- .../server-graphql/examples/health/get.md | 7 --- .../server-graphql/examples/locale/get.md | 11 ---- .../examples/locale/list-codes.md | 9 --- .../examples/locale/list-continents.md | 9 --- .../examples/locale/list-countries-e-u.md | 9 --- .../examples/locale/list-countries-phones.md | 10 ---- .../examples/locale/list-countries.md | 9 --- .../examples/locale/list-currencies.md | 14 ----- .../examples/locale/list-languages.md | 10 ---- .../messaging/create-apns-provider.md | 22 ------- .../examples/messaging/create-email.md | 30 ---------- .../examples/messaging/create-fcm-provider.md | 18 ------ .../messaging/create-mailgun-provider.md | 24 -------- .../messaging/create-msg91provider.md | 20 ------- .../examples/messaging/create-push.md | 34 ----------- .../messaging/create-sendgrid-provider.md | 22 ------- .../examples/messaging/create-sms.md | 25 -------- .../messaging/create-smtp-provider.md | 28 --------- .../examples/messaging/create-subscriber.md | 26 --------- .../messaging/create-telesign-provider.md | 20 ------- .../messaging/create-textmagic-provider.md | 20 ------- .../examples/messaging/create-topic.md | 16 ------ .../messaging/create-twilio-provider.md | 20 ------- .../messaging/create-vonage-provider.md | 20 ------- .../examples/messaging/delete-provider.md | 7 --- .../examples/messaging/delete-subscriber.md | 8 --- .../examples/messaging/delete-topic.md | 7 --- .../examples/messaging/delete.md | 7 --- .../examples/messaging/get-message.md | 19 ------- .../examples/messaging/get-provider.md | 15 ----- .../examples/messaging/get-subscriber.md | 25 -------- .../examples/messaging/get-topic.md | 14 ----- .../examples/messaging/list-message-logs.md | 31 ---------- .../examples/messaging/list-messages.md | 23 -------- .../examples/messaging/list-provider-logs.md | 31 ---------- .../examples/messaging/list-providers.md | 19 ------- .../messaging/list-subscriber-logs.md | 31 ---------- .../examples/messaging/list-subscribers.md | 29 ---------- .../examples/messaging/list-targets.md | 18 ------ .../examples/messaging/list-topic-logs.md | 31 ---------- .../examples/messaging/list-topics.md | 18 ------ .../messaging/update-apns-provider.md | 22 ------- .../examples/messaging/update-email.md | 30 ---------- .../examples/messaging/update-fcm-provider.md | 18 ------ .../messaging/update-mailgun-provider.md | 24 -------- .../messaging/update-msg91provider.md | 20 ------- .../examples/messaging/update-push.md | 34 ----------- .../messaging/update-sendgrid-provider.md | 22 ------- .../examples/messaging/update-sms.md | 25 -------- .../messaging/update-smtp-provider.md | 28 --------- .../messaging/update-telesign-provider.md | 20 ------- .../messaging/update-textmagic-provider.md | 20 ------- .../examples/messaging/update-topic.md | 16 ------ .../messaging/update-twilio-provider.md | 20 ------- .../messaging/update-vonage-provider.md | 20 ------- .../examples/storage/create-bucket.md | 27 --------- .../examples/storage/create-file.md | 26 --------- .../examples/storage/delete-bucket.md | 7 --- .../examples/storage/delete-file.md | 8 --- .../examples/storage/get-bucket.md | 18 ------ .../examples/storage/get-file-download.md | 8 --- .../examples/storage/get-file-preview.md | 19 ------- .../examples/storage/get-file-view.md | 8 --- .../examples/storage/get-file.md | 18 ------ .../examples/storage/list-buckets.md | 22 ------- .../examples/storage/list-files.md | 22 ------- .../examples/storage/update-bucket.md | 27 --------- .../examples/storage/update-file.md | 20 ------- .../examples/teams/create-membership.md | 25 -------- .../server-graphql/examples/teams/create.md | 16 ------ .../examples/teams/delete-membership.md | 8 --- .../server-graphql/examples/teams/delete.md | 7 --- .../examples/teams/get-membership.md | 20 ------- .../examples/teams/get-prefs.md | 7 --- .../server-graphql/examples/teams/get.md | 14 ----- .../examples/teams/list-memberships.md | 24 -------- .../server-graphql/examples/teams/list.md | 18 ------ .../teams/update-membership-status.md | 22 ------- .../examples/teams/update-membership.md | 21 ------- .../examples/teams/update-name.md | 15 ----- .../examples/teams/update-prefs.md | 8 --- .../examples/users/create-argon2user.md | 39 ------------- .../examples/users/create-bcrypt-user.md | 39 ------------- .../examples/users/create-j-w-t.md | 9 --- .../examples/users/create-m-d5user.md | 39 ------------- .../users/create-mfa-recovery-codes.md | 7 --- .../examples/users/create-p-h-pass-user.md | 39 ------------- .../examples/users/create-s-h-a-user.md | 40 ------------- .../users/create-scrypt-modified-user.md | 42 -------------- .../examples/users/create-scrypt-user.md | 44 -------------- .../examples/users/create-session.md | 35 ------------ .../examples/users/create-target.md | 19 ------- .../examples/users/create-token.md | 14 ----- .../server-graphql/examples/users/create.md | 40 ------------- .../examples/users/delete-identity.md | 7 --- .../users/delete-mfa-authenticator.md | 37 ------------ .../examples/users/delete-session.md | 8 --- .../examples/users/delete-sessions.md | 7 --- .../examples/users/delete-target.md | 8 --- .../server-graphql/examples/users/delete.md | 7 --- .../examples/users/get-mfa-recovery-codes.md | 7 --- .../examples/users/get-prefs.md | 7 --- .../examples/users/get-target.md | 15 ----- .../server-graphql/examples/users/get.md | 36 ------------ .../examples/users/list-identities.md | 20 ------- .../examples/users/list-logs.md | 31 ---------- .../examples/users/list-memberships.md | 22 ------- .../examples/users/list-mfa-factors.md | 10 ---- .../examples/users/list-sessions.md | 38 ------------- .../examples/users/list-targets.md | 18 ------ .../server-graphql/examples/users/list.md | 40 ------------- .../users/update-email-verification.md | 37 ------------ .../examples/users/update-email.md | 37 ------------ .../examples/users/update-labels.md | 37 ------------ .../users/update-mfa-recovery-codes.md | 7 --- .../examples/users/update-mfa.md | 37 ------------ .../examples/users/update-name.md | 37 ------------ .../examples/users/update-password.md | 37 ------------ .../users/update-phone-verification.md | 37 ------------ .../examples/users/update-phone.md | 37 ------------ .../examples/users/update-prefs.md | 8 --- .../examples/users/update-status.md | 37 ------------ .../examples/users/update-target.md | 18 ------ .../java/account/create-anonymous-session.md | 18 ------ .../account/create-email-password-session.md | 23 -------- .../java/account/create-email-token.md | 24 -------- .../java/account/create-j-w-t.md | 18 ------ .../java/account/create-magic-u-r-l-token.md | 25 -------- .../java/account/create-mfa-authenticator.md | 24 -------- .../java/account/create-mfa-challenge.md | 23 -------- .../java/account/create-mfa-recovery-codes.md | 19 ------- .../java/account/create-o-auth2token.md | 26 --------- .../java/account/create-phone-token.md | 23 -------- .../java/account/create-phone-verification.md | 19 ------- .../java/account/create-recovery.md | 24 -------- .../java/account/create-session.md | 23 -------- .../java/account/create-verification.md | 23 -------- .../server-kotlin/java/account/create.md | 25 -------- .../java/account/delete-identity.md | 23 -------- .../java/account/delete-mfa-authenticator.md | 24 -------- .../java/account/delete-session.md | 23 -------- .../java/account/delete-sessions.md | 19 ------- .../java/account/get-mfa-recovery-codes.md | 19 ------- .../server-kotlin/java/account/get-prefs.md | 19 ------- .../server-kotlin/java/account/get-session.md | 23 -------- .../1.6.x/server-kotlin/java/account/get.md | 19 ------- .../java/account/list-identities.md | 23 -------- .../server-kotlin/java/account/list-logs.md | 23 -------- .../java/account/list-mfa-factors.md | 19 ------- .../java/account/list-sessions.md | 19 ------- .../java/account/update-email.md | 24 -------- .../java/account/update-m-f-a.md | 23 -------- .../account/update-magic-u-r-l-session.md | 23 -------- .../java/account/update-mfa-authenticator.md | 25 -------- .../java/account/update-mfa-challenge.md | 24 -------- .../java/account/update-mfa-recovery-codes.md | 19 ------- .../server-kotlin/java/account/update-name.md | 23 -------- .../java/account/update-password.md | 24 -------- .../java/account/update-phone-session.md | 23 -------- .../java/account/update-phone-verification.md | 24 -------- .../java/account/update-phone.md | 24 -------- .../java/account/update-prefs.md | 23 -------- .../java/account/update-recovery.md | 25 -------- .../java/account/update-session.md | 23 -------- .../java/account/update-status.md | 19 ------- .../java/account/update-verification.md | 24 -------- .../server-kotlin/java/avatars/get-browser.md | 27 --------- .../java/avatars/get-credit-card.md | 27 --------- .../server-kotlin/java/avatars/get-favicon.md | 23 -------- .../server-kotlin/java/avatars/get-flag.md | 27 --------- .../server-kotlin/java/avatars/get-image.md | 25 -------- .../java/avatars/get-initials.md | 26 --------- .../server-kotlin/java/avatars/get-q-r.md | 26 --------- .../databases/create-boolean-attribute.md | 28 --------- .../java/databases/create-collection.md | 28 --------- .../databases/create-datetime-attribute.md | 28 --------- .../java/databases/create-document.md | 27 --------- .../java/databases/create-email-attribute.md | 28 --------- .../java/databases/create-enum-attribute.md | 29 ---------- .../java/databases/create-float-attribute.md | 30 ---------- .../java/databases/create-index.md | 29 ---------- .../databases/create-integer-attribute.md | 30 ---------- .../java/databases/create-ip-attribute.md | 28 --------- .../create-relationship-attribute.md | 31 ---------- .../java/databases/create-string-attribute.md | 30 ---------- .../java/databases/create-url-attribute.md | 28 --------- .../server-kotlin/java/databases/create.md | 25 -------- .../java/databases/delete-attribute.md | 25 -------- .../java/databases/delete-collection.md | 24 -------- .../java/databases/delete-document.md | 25 -------- .../java/databases/delete-index.md | 25 -------- .../server-kotlin/java/databases/delete.md | 23 -------- .../java/databases/get-attribute.md | 25 -------- .../java/databases/get-collection.md | 24 -------- .../java/databases/get-document.md | 26 --------- .../server-kotlin/java/databases/get-index.md | 25 -------- .../1.6.x/server-kotlin/java/databases/get.md | 23 -------- .../java/databases/list-attributes.md | 25 -------- .../java/databases/list-collections.md | 25 -------- .../java/databases/list-documents.md | 25 -------- .../java/databases/list-indexes.md | 25 -------- .../server-kotlin/java/databases/list.md | 24 -------- .../databases/update-boolean-attribute.md | 27 --------- .../java/databases/update-collection.md | 28 --------- .../databases/update-datetime-attribute.md | 27 --------- .../java/databases/update-document.md | 27 --------- .../java/databases/update-email-attribute.md | 27 --------- .../java/databases/update-enum-attribute.md | 28 --------- .../java/databases/update-float-attribute.md | 29 ---------- .../databases/update-integer-attribute.md | 29 ---------- .../java/databases/update-ip-attribute.md | 27 --------- .../update-relationship-attribute.md | 26 --------- .../java/databases/update-string-attribute.md | 27 --------- .../java/databases/update-url-attribute.md | 27 --------- .../server-kotlin/java/databases/update.md | 25 -------- .../java/functions/create-build.md | 25 -------- .../java/functions/create-deployment.md | 28 --------- .../java/functions/create-execution.md | 29 ---------- .../java/functions/create-variable.md | 25 -------- .../server-kotlin/java/functions/create.md | 44 -------------- .../java/functions/delete-deployment.md | 24 -------- .../java/functions/delete-execution.md | 24 -------- .../java/functions/delete-variable.md | 24 -------- .../server-kotlin/java/functions/delete.md | 23 -------- .../java/functions/download-deployment.md | 24 -------- .../java/functions/get-deployment.md | 24 -------- .../java/functions/get-execution.md | 24 -------- .../java/functions/get-variable.md | 24 -------- .../1.6.x/server-kotlin/java/functions/get.md | 23 -------- .../java/functions/list-deployments.md | 25 -------- .../java/functions/list-executions.md | 25 -------- .../java/functions/list-runtimes.md | 19 ------- .../java/functions/list-variables.md | 23 -------- .../server-kotlin/java/functions/list.md | 24 -------- .../java/functions/update-deployment-build.md | 24 -------- .../java/functions/update-deployment.md | 24 -------- .../java/functions/update-variable.md | 26 --------- .../server-kotlin/java/functions/update.md | 39 ------------- .../server-kotlin/java/graphql/mutation.md | 23 -------- .../1.6.x/server-kotlin/java/graphql/query.md | 23 -------- .../java/health/get-antivirus.md | 19 ------- .../server-kotlin/java/health/get-cache.md | 19 ------- .../java/health/get-certificate.md | 23 -------- .../server-kotlin/java/health/get-d-b.md | 19 ------- .../java/health/get-failed-jobs.md | 25 -------- .../server-kotlin/java/health/get-pub-sub.md | 19 ------- .../java/health/get-queue-builds.md | 23 -------- .../java/health/get-queue-certificates.md | 23 -------- .../java/health/get-queue-databases.md | 24 -------- .../java/health/get-queue-deletes.md | 23 -------- .../java/health/get-queue-functions.md | 23 -------- .../java/health/get-queue-logs.md | 23 -------- .../java/health/get-queue-mails.md | 23 -------- .../java/health/get-queue-messaging.md | 23 -------- .../java/health/get-queue-migrations.md | 23 -------- .../java/health/get-queue-usage-dump.md | 23 -------- .../java/health/get-queue-usage.md | 23 -------- .../java/health/get-queue-webhooks.md | 23 -------- .../server-kotlin/java/health/get-queue.md | 19 ------- .../java/health/get-storage-local.md | 19 ------- .../server-kotlin/java/health/get-storage.md | 19 ------- .../server-kotlin/java/health/get-time.md | 19 ------- .../1.6.x/server-kotlin/java/health/get.md | 19 ------- .../1.6.x/server-kotlin/java/locale/get.md | 19 ------- .../server-kotlin/java/locale/list-codes.md | 19 ------- .../java/locale/list-continents.md | 19 ------- .../java/locale/list-countries-e-u.md | 19 ------- .../java/locale/list-countries-phones.md | 19 ------- .../java/locale/list-countries.md | 19 ------- .../java/locale/list-currencies.md | 19 ------- .../java/locale/list-languages.md | 19 ------- .../java/messaging/create-apns-provider.md | 30 ---------- .../java/messaging/create-email.md | 34 ----------- .../java/messaging/create-fcm-provider.md | 26 --------- .../java/messaging/create-mailgun-provider.md | 32 ----------- .../java/messaging/create-msg91provider.md | 28 --------- .../java/messaging/create-push.md | 38 ------------- .../messaging/create-sendgrid-provider.md | 30 ---------- .../java/messaging/create-sms.md | 29 ---------- .../java/messaging/create-smtp-provider.md | 36 ------------ .../java/messaging/create-subscriber.md | 25 -------- .../messaging/create-telesign-provider.md | 28 --------- .../messaging/create-textmagic-provider.md | 28 --------- .../java/messaging/create-topic.md | 25 -------- .../java/messaging/create-twilio-provider.md | 28 --------- .../java/messaging/create-vonage-provider.md | 28 --------- .../java/messaging/delete-provider.md | 23 -------- .../java/messaging/delete-subscriber.md | 24 -------- .../java/messaging/delete-topic.md | 23 -------- .../server-kotlin/java/messaging/delete.md | 23 -------- .../java/messaging/get-message.md | 23 -------- .../java/messaging/get-provider.md | 23 -------- .../java/messaging/get-subscriber.md | 24 -------- .../server-kotlin/java/messaging/get-topic.md | 23 -------- .../java/messaging/list-message-logs.md | 24 -------- .../java/messaging/list-messages.md | 24 -------- .../java/messaging/list-provider-logs.md | 24 -------- .../java/messaging/list-providers.md | 24 -------- .../java/messaging/list-subscriber-logs.md | 24 -------- .../java/messaging/list-subscribers.md | 25 -------- .../java/messaging/list-targets.md | 24 -------- .../java/messaging/list-topic-logs.md | 24 -------- .../java/messaging/list-topics.md | 24 -------- .../java/messaging/update-apns-provider.md | 30 ---------- .../java/messaging/update-email.md | 34 ----------- .../java/messaging/update-fcm-provider.md | 26 --------- .../java/messaging/update-mailgun-provider.md | 32 ----------- .../java/messaging/update-msg91provider.md | 28 --------- .../java/messaging/update-push.md | 38 ------------- .../messaging/update-sendgrid-provider.md | 30 ---------- .../java/messaging/update-sms.md | 29 ---------- .../java/messaging/update-smtp-provider.md | 36 ------------ .../messaging/update-telesign-provider.md | 28 --------- .../messaging/update-textmagic-provider.md | 28 --------- .../java/messaging/update-topic.md | 25 -------- .../java/messaging/update-twilio-provider.md | 28 --------- .../java/messaging/update-vonage-provider.md | 28 --------- .../java/storage/create-bucket.md | 32 ----------- .../server-kotlin/java/storage/create-file.md | 27 --------- .../java/storage/delete-bucket.md | 23 -------- .../server-kotlin/java/storage/delete-file.md | 24 -------- .../server-kotlin/java/storage/get-bucket.md | 23 -------- .../java/storage/get-file-download.md | 24 -------- .../java/storage/get-file-preview.md | 35 ------------ .../java/storage/get-file-view.md | 24 -------- .../server-kotlin/java/storage/get-file.md | 24 -------- .../java/storage/list-buckets.md | 24 -------- .../server-kotlin/java/storage/list-files.md | 25 -------- .../java/storage/update-bucket.md | 32 ----------- .../server-kotlin/java/storage/update-file.md | 26 --------- .../java/teams/create-membership.md | 29 ---------- .../1.6.x/server-kotlin/java/teams/create.md | 25 -------- .../java/teams/delete-membership.md | 24 -------- .../1.6.x/server-kotlin/java/teams/delete.md | 23 -------- .../java/teams/get-membership.md | 24 -------- .../server-kotlin/java/teams/get-prefs.md | 23 -------- .../1.6.x/server-kotlin/java/teams/get.md | 23 -------- .../java/teams/list-memberships.md | 25 -------- .../1.6.x/server-kotlin/java/teams/list.md | 24 -------- .../java/teams/update-membership-status.md | 26 --------- .../java/teams/update-membership.md | 25 -------- .../server-kotlin/java/teams/update-name.md | 24 -------- .../server-kotlin/java/teams/update-prefs.md | 24 -------- .../java/users/create-argon2user.md | 26 --------- .../java/users/create-bcrypt-user.md | 26 --------- .../server-kotlin/java/users/create-j-w-t.md | 25 -------- .../java/users/create-m-d5user.md | 26 --------- .../java/users/create-mfa-recovery-codes.md | 23 -------- .../java/users/create-p-h-pass-user.md | 26 --------- .../java/users/create-s-h-a-user.md | 27 --------- .../java/users/create-scrypt-modified-user.md | 29 ---------- .../java/users/create-scrypt-user.md | 31 ---------- .../java/users/create-session.md | 23 -------- .../server-kotlin/java/users/create-target.md | 29 ---------- .../server-kotlin/java/users/create-token.md | 25 -------- .../1.6.x/server-kotlin/java/users/create.md | 27 --------- .../java/users/delete-identity.md | 23 -------- .../java/users/delete-mfa-authenticator.md | 25 -------- .../java/users/delete-session.md | 24 -------- .../java/users/delete-sessions.md | 23 -------- .../server-kotlin/java/users/delete-target.md | 24 -------- .../1.6.x/server-kotlin/java/users/delete.md | 23 -------- .../java/users/get-mfa-recovery-codes.md | 23 -------- .../server-kotlin/java/users/get-prefs.md | 23 -------- .../server-kotlin/java/users/get-target.md | 24 -------- .../1.6.x/server-kotlin/java/users/get.md | 23 -------- .../java/users/list-identities.md | 24 -------- .../server-kotlin/java/users/list-logs.md | 24 -------- .../java/users/list-memberships.md | 23 -------- .../java/users/list-mfa-factors.md | 23 -------- .../server-kotlin/java/users/list-sessions.md | 23 -------- .../server-kotlin/java/users/list-targets.md | 24 -------- .../1.6.x/server-kotlin/java/users/list.md | 24 -------- .../java/users/update-email-verification.md | 24 -------- .../server-kotlin/java/users/update-email.md | 24 -------- .../server-kotlin/java/users/update-labels.md | 24 -------- .../java/users/update-mfa-recovery-codes.md | 23 -------- .../server-kotlin/java/users/update-mfa.md | 24 -------- .../server-kotlin/java/users/update-name.md | 24 -------- .../java/users/update-password.md | 24 -------- .../java/users/update-phone-verification.md | 24 -------- .../server-kotlin/java/users/update-phone.md | 24 -------- .../server-kotlin/java/users/update-prefs.md | 24 -------- .../server-kotlin/java/users/update-status.md | 24 -------- .../server-kotlin/java/users/update-target.md | 27 --------- .../account/create-anonymous-session.md | 11 ---- .../account/create-email-password-session.md | 14 ----- .../kotlin/account/create-email-token.md | 15 ----- .../kotlin/account/create-j-w-t.md | 11 ---- .../account/create-magic-u-r-l-token.md | 16 ------ .../account/create-mfa-authenticator.md | 15 ----- .../kotlin/account/create-mfa-challenge.md | 14 ----- .../account/create-mfa-recovery-codes.md | 12 ---- .../kotlin/account/create-o-auth2token.md | 17 ------ .../kotlin/account/create-phone-token.md | 14 ----- .../account/create-phone-verification.md | 12 ---- .../kotlin/account/create-recovery.md | 15 ----- .../kotlin/account/create-session.md | 14 ----- .../kotlin/account/create-verification.md | 14 ----- .../server-kotlin/kotlin/account/create.md | 16 ------ .../kotlin/account/delete-identity.md | 14 ----- .../account/delete-mfa-authenticator.md | 15 ----- .../kotlin/account/delete-session.md | 14 ----- .../kotlin/account/delete-sessions.md | 12 ---- .../kotlin/account/get-mfa-recovery-codes.md | 12 ---- .../server-kotlin/kotlin/account/get-prefs.md | 12 ---- .../kotlin/account/get-session.md | 14 ----- .../1.6.x/server-kotlin/kotlin/account/get.md | 12 ---- .../kotlin/account/list-identities.md | 14 ----- .../server-kotlin/kotlin/account/list-logs.md | 14 ----- .../kotlin/account/list-mfa-factors.md | 12 ---- .../kotlin/account/list-sessions.md | 12 ---- .../kotlin/account/update-email.md | 15 ----- .../kotlin/account/update-m-f-a.md | 14 ----- .../account/update-magic-u-r-l-session.md | 14 ----- .../account/update-mfa-authenticator.md | 16 ------ .../kotlin/account/update-mfa-challenge.md | 15 ----- .../account/update-mfa-recovery-codes.md | 12 ---- .../kotlin/account/update-name.md | 14 ----- .../kotlin/account/update-password.md | 15 ----- .../kotlin/account/update-phone-session.md | 14 ----- .../account/update-phone-verification.md | 15 ----- .../kotlin/account/update-phone.md | 15 ----- .../kotlin/account/update-prefs.md | 14 ----- .../kotlin/account/update-recovery.md | 16 ------ .../kotlin/account/update-session.md | 14 ----- .../kotlin/account/update-status.md | 12 ---- .../kotlin/account/update-verification.md | 15 ----- .../kotlin/avatars/get-browser.md | 18 ------ .../kotlin/avatars/get-credit-card.md | 18 ------ .../kotlin/avatars/get-favicon.md | 14 ----- .../server-kotlin/kotlin/avatars/get-flag.md | 18 ------ .../server-kotlin/kotlin/avatars/get-image.md | 16 ------ .../kotlin/avatars/get-initials.md | 17 ------ .../server-kotlin/kotlin/avatars/get-q-r.md | 17 ------ .../databases/create-boolean-attribute.md | 19 ------- .../kotlin/databases/create-collection.md | 19 ------- .../databases/create-datetime-attribute.md | 19 ------- .../kotlin/databases/create-document.md | 18 ------ .../databases/create-email-attribute.md | 19 ------- .../kotlin/databases/create-enum-attribute.md | 20 ------- .../databases/create-float-attribute.md | 21 ------- .../kotlin/databases/create-index.md | 20 ------- .../databases/create-integer-attribute.md | 21 ------- .../kotlin/databases/create-ip-attribute.md | 19 ------- .../create-relationship-attribute.md | 22 ------- .../databases/create-string-attribute.md | 21 ------- .../kotlin/databases/create-url-attribute.md | 19 ------- .../server-kotlin/kotlin/databases/create.md | 16 ------ .../kotlin/databases/delete-attribute.md | 16 ------ .../kotlin/databases/delete-collection.md | 15 ----- .../kotlin/databases/delete-document.md | 16 ------ .../kotlin/databases/delete-index.md | 16 ------ .../server-kotlin/kotlin/databases/delete.md | 14 ----- .../kotlin/databases/get-attribute.md | 16 ------ .../kotlin/databases/get-collection.md | 15 ----- .../kotlin/databases/get-document.md | 17 ------ .../kotlin/databases/get-index.md | 16 ------ .../server-kotlin/kotlin/databases/get.md | 14 ----- .../kotlin/databases/list-attributes.md | 16 ------ .../kotlin/databases/list-collections.md | 16 ------ .../kotlin/databases/list-documents.md | 16 ------ .../kotlin/databases/list-indexes.md | 16 ------ .../server-kotlin/kotlin/databases/list.md | 15 ----- .../databases/update-boolean-attribute.md | 18 ------ .../kotlin/databases/update-collection.md | 19 ------- .../databases/update-datetime-attribute.md | 18 ------ .../kotlin/databases/update-document.md | 18 ------ .../databases/update-email-attribute.md | 18 ------ .../kotlin/databases/update-enum-attribute.md | 19 ------- .../databases/update-float-attribute.md | 20 ------- .../databases/update-integer-attribute.md | 20 ------- .../kotlin/databases/update-ip-attribute.md | 18 ------ .../update-relationship-attribute.md | 17 ------ .../databases/update-string-attribute.md | 18 ------ .../kotlin/databases/update-url-attribute.md | 18 ------ .../server-kotlin/kotlin/databases/update.md | 16 ------ .../kotlin/functions/create-build.md | 16 ------ .../kotlin/functions/create-deployment.md | 19 ------- .../kotlin/functions/create-execution.md | 20 ------- .../kotlin/functions/create-variable.md | 16 ------ .../server-kotlin/kotlin/functions/create.md | 35 ------------ .../kotlin/functions/delete-deployment.md | 15 ----- .../kotlin/functions/delete-execution.md | 15 ----- .../kotlin/functions/delete-variable.md | 15 ----- .../server-kotlin/kotlin/functions/delete.md | 14 ----- .../kotlin/functions/download-deployment.md | 15 ----- .../kotlin/functions/get-deployment.md | 15 ----- .../kotlin/functions/get-execution.md | 15 ----- .../kotlin/functions/get-variable.md | 15 ----- .../server-kotlin/kotlin/functions/get.md | 14 ----- .../kotlin/functions/list-deployments.md | 16 ------ .../kotlin/functions/list-executions.md | 16 ------ .../kotlin/functions/list-runtimes.md | 12 ---- .../kotlin/functions/list-variables.md | 14 ----- .../server-kotlin/kotlin/functions/list.md | 15 ----- .../functions/update-deployment-build.md | 15 ----- .../kotlin/functions/update-deployment.md | 15 ----- .../kotlin/functions/update-variable.md | 17 ------ .../server-kotlin/kotlin/functions/update.md | 30 ---------- .../server-kotlin/kotlin/graphql/mutation.md | 14 ----- .../server-kotlin/kotlin/graphql/query.md | 14 ----- .../kotlin/health/get-antivirus.md | 12 ---- .../server-kotlin/kotlin/health/get-cache.md | 12 ---- .../kotlin/health/get-certificate.md | 14 ----- .../server-kotlin/kotlin/health/get-d-b.md | 12 ---- .../kotlin/health/get-failed-jobs.md | 16 ------ .../kotlin/health/get-pub-sub.md | 12 ---- .../kotlin/health/get-queue-builds.md | 14 ----- .../kotlin/health/get-queue-certificates.md | 14 ----- .../kotlin/health/get-queue-databases.md | 15 ----- .../kotlin/health/get-queue-deletes.md | 14 ----- .../kotlin/health/get-queue-functions.md | 14 ----- .../kotlin/health/get-queue-logs.md | 14 ----- .../kotlin/health/get-queue-mails.md | 14 ----- .../kotlin/health/get-queue-messaging.md | 14 ----- .../kotlin/health/get-queue-migrations.md | 14 ----- .../kotlin/health/get-queue-usage-dump.md | 14 ----- .../kotlin/health/get-queue-usage.md | 14 ----- .../kotlin/health/get-queue-webhooks.md | 14 ----- .../server-kotlin/kotlin/health/get-queue.md | 12 ---- .../kotlin/health/get-storage-local.md | 12 ---- .../kotlin/health/get-storage.md | 12 ---- .../server-kotlin/kotlin/health/get-time.md | 12 ---- .../1.6.x/server-kotlin/kotlin/health/get.md | 12 ---- .../1.6.x/server-kotlin/kotlin/locale/get.md | 12 ---- .../server-kotlin/kotlin/locale/list-codes.md | 12 ---- .../kotlin/locale/list-continents.md | 12 ---- .../kotlin/locale/list-countries-e-u.md | 12 ---- .../kotlin/locale/list-countries-phones.md | 12 ---- .../kotlin/locale/list-countries.md | 12 ---- .../kotlin/locale/list-currencies.md | 12 ---- .../kotlin/locale/list-languages.md | 12 ---- .../kotlin/messaging/create-apns-provider.md | 21 ------- .../kotlin/messaging/create-email.md | 25 -------- .../kotlin/messaging/create-fcm-provider.md | 17 ------ .../messaging/create-mailgun-provider.md | 23 -------- .../kotlin/messaging/create-msg91provider.md | 19 ------- .../kotlin/messaging/create-push.md | 29 ---------- .../messaging/create-sendgrid-provider.md | 21 ------- .../kotlin/messaging/create-sms.md | 20 ------- .../kotlin/messaging/create-smtp-provider.md | 27 --------- .../kotlin/messaging/create-subscriber.md | 16 ------ .../messaging/create-telesign-provider.md | 19 ------- .../messaging/create-textmagic-provider.md | 19 ------- .../kotlin/messaging/create-topic.md | 16 ------ .../messaging/create-twilio-provider.md | 19 ------- .../messaging/create-vonage-provider.md | 19 ------- .../kotlin/messaging/delete-provider.md | 14 ----- .../kotlin/messaging/delete-subscriber.md | 15 ----- .../kotlin/messaging/delete-topic.md | 14 ----- .../server-kotlin/kotlin/messaging/delete.md | 14 ----- .../kotlin/messaging/get-message.md | 14 ----- .../kotlin/messaging/get-provider.md | 14 ----- .../kotlin/messaging/get-subscriber.md | 15 ----- .../kotlin/messaging/get-topic.md | 14 ----- .../kotlin/messaging/list-message-logs.md | 15 ----- .../kotlin/messaging/list-messages.md | 15 ----- .../kotlin/messaging/list-provider-logs.md | 15 ----- .../kotlin/messaging/list-providers.md | 15 ----- .../kotlin/messaging/list-subscriber-logs.md | 15 ----- .../kotlin/messaging/list-subscribers.md | 16 ------ .../kotlin/messaging/list-targets.md | 15 ----- .../kotlin/messaging/list-topic-logs.md | 15 ----- .../kotlin/messaging/list-topics.md | 15 ----- .../kotlin/messaging/update-apns-provider.md | 21 ------- .../kotlin/messaging/update-email.md | 25 -------- .../kotlin/messaging/update-fcm-provider.md | 17 ------ .../messaging/update-mailgun-provider.md | 23 -------- .../kotlin/messaging/update-msg91provider.md | 19 ------- .../kotlin/messaging/update-push.md | 29 ---------- .../messaging/update-sendgrid-provider.md | 21 ------- .../kotlin/messaging/update-sms.md | 20 ------- .../kotlin/messaging/update-smtp-provider.md | 27 --------- .../messaging/update-telesign-provider.md | 19 ------- .../messaging/update-textmagic-provider.md | 19 ------- .../kotlin/messaging/update-topic.md | 16 ------ .../messaging/update-twilio-provider.md | 19 ------- .../messaging/update-vonage-provider.md | 19 ------- .../kotlin/storage/create-bucket.md | 23 -------- .../kotlin/storage/create-file.md | 18 ------ .../kotlin/storage/delete-bucket.md | 14 ----- .../kotlin/storage/delete-file.md | 15 ----- .../kotlin/storage/get-bucket.md | 14 ----- .../kotlin/storage/get-file-download.md | 15 ----- .../kotlin/storage/get-file-preview.md | 26 --------- .../kotlin/storage/get-file-view.md | 15 ----- .../server-kotlin/kotlin/storage/get-file.md | 15 ----- .../kotlin/storage/list-buckets.md | 15 ----- .../kotlin/storage/list-files.md | 16 ------ .../kotlin/storage/update-bucket.md | 23 -------- .../kotlin/storage/update-file.md | 17 ------ .../kotlin/teams/create-membership.md | 20 ------- .../server-kotlin/kotlin/teams/create.md | 16 ------ .../kotlin/teams/delete-membership.md | 15 ----- .../server-kotlin/kotlin/teams/delete.md | 14 ----- .../kotlin/teams/get-membership.md | 15 ----- .../server-kotlin/kotlin/teams/get-prefs.md | 14 ----- .../1.6.x/server-kotlin/kotlin/teams/get.md | 14 ----- .../kotlin/teams/list-memberships.md | 16 ------ .../1.6.x/server-kotlin/kotlin/teams/list.md | 15 ----- .../kotlin/teams/update-membership-status.md | 17 ------ .../kotlin/teams/update-membership.md | 16 ------ .../server-kotlin/kotlin/teams/update-name.md | 15 ----- .../kotlin/teams/update-prefs.md | 15 ----- .../kotlin/users/create-argon2user.md | 17 ------ .../kotlin/users/create-bcrypt-user.md | 17 ------ .../kotlin/users/create-j-w-t.md | 16 ------ .../kotlin/users/create-m-d5user.md | 17 ------ .../kotlin/users/create-mfa-recovery-codes.md | 14 ----- .../kotlin/users/create-p-h-pass-user.md | 17 ------ .../kotlin/users/create-s-h-a-user.md | 18 ------ .../users/create-scrypt-modified-user.md | 20 ------- .../kotlin/users/create-scrypt-user.md | 22 ------- .../kotlin/users/create-session.md | 14 ----- .../kotlin/users/create-target.md | 20 ------- .../kotlin/users/create-token.md | 16 ------ .../server-kotlin/kotlin/users/create.md | 18 ------ .../kotlin/users/delete-identity.md | 14 ----- .../kotlin/users/delete-mfa-authenticator.md | 16 ------ .../kotlin/users/delete-session.md | 15 ----- .../kotlin/users/delete-sessions.md | 14 ----- .../kotlin/users/delete-target.md | 15 ----- .../server-kotlin/kotlin/users/delete.md | 14 ----- .../kotlin/users/get-mfa-recovery-codes.md | 14 ----- .../server-kotlin/kotlin/users/get-prefs.md | 14 ----- .../server-kotlin/kotlin/users/get-target.md | 15 ----- .../1.6.x/server-kotlin/kotlin/users/get.md | 14 ----- .../kotlin/users/list-identities.md | 15 ----- .../server-kotlin/kotlin/users/list-logs.md | 15 ----- .../kotlin/users/list-memberships.md | 14 ----- .../kotlin/users/list-mfa-factors.md | 14 ----- .../kotlin/users/list-sessions.md | 14 ----- .../kotlin/users/list-targets.md | 15 ----- .../1.6.x/server-kotlin/kotlin/users/list.md | 15 ----- .../kotlin/users/update-email-verification.md | 15 ----- .../kotlin/users/update-email.md | 15 ----- .../kotlin/users/update-labels.md | 15 ----- .../kotlin/users/update-mfa-recovery-codes.md | 14 ----- .../server-kotlin/kotlin/users/update-mfa.md | 15 ----- .../server-kotlin/kotlin/users/update-name.md | 15 ----- .../kotlin/users/update-password.md | 15 ----- .../kotlin/users/update-phone-verification.md | 15 ----- .../kotlin/users/update-phone.md | 15 ----- .../kotlin/users/update-prefs.md | 15 ----- .../kotlin/users/update-status.md | 15 ----- .../kotlin/users/update-target.md | 18 ------ .../account/create-anonymous-session.md | 9 --- .../account/create-email-password-session.md | 12 ---- .../examples/account/create-email-token.md | 13 ----- .../examples/account/create-j-w-t.md | 9 --- .../account/create-magic-u-r-l-token.md | 14 ----- .../account/create-mfa-authenticator.md | 12 ---- .../examples/account/create-mfa-challenge.md | 11 ---- .../account/create-mfa-recovery-codes.md | 10 ---- .../examples/account/create-o-auth2token.md | 14 ----- .../examples/account/create-phone-token.md | 12 ---- .../account/create-phone-verification.md | 10 ---- .../examples/account/create-recovery.md | 13 ----- .../examples/account/create-session.md | 12 ---- .../examples/account/create-verification.md | 12 ---- .../server-nodejs/examples/account/create.md | 14 ----- .../examples/account/delete-identity.md | 12 ---- .../account/delete-mfa-authenticator.md | 12 ---- .../examples/account/delete-session.md | 12 ---- .../examples/account/delete-sessions.md | 10 ---- .../account/get-mfa-recovery-codes.md | 10 ---- .../examples/account/get-prefs.md | 10 ---- .../examples/account/get-session.md | 12 ---- .../server-nodejs/examples/account/get.md | 10 ---- .../examples/account/list-identities.md | 12 ---- .../examples/account/list-logs.md | 12 ---- .../examples/account/list-mfa-factors.md | 10 ---- .../examples/account/list-sessions.md | 10 ---- .../examples/account/update-email.md | 13 ----- .../examples/account/update-m-f-a.md | 12 ---- .../account/update-magic-u-r-l-session.md | 12 ---- .../account/update-mfa-authenticator.md | 13 ----- .../examples/account/update-mfa-challenge.md | 13 ----- .../account/update-mfa-recovery-codes.md | 10 ---- .../examples/account/update-name.md | 12 ---- .../examples/account/update-password.md | 13 ----- .../examples/account/update-phone-session.md | 12 ---- .../account/update-phone-verification.md | 13 ----- .../examples/account/update-phone.md | 13 ----- .../examples/account/update-prefs.md | 12 ---- .../examples/account/update-recovery.md | 14 ----- .../examples/account/update-session.md | 12 ---- .../examples/account/update-status.md | 10 ---- .../examples/account/update-verification.md | 13 ----- .../examples/avatars/get-browser.md | 15 ----- .../examples/avatars/get-credit-card.md | 15 ----- .../examples/avatars/get-favicon.md | 12 ---- .../examples/avatars/get-flag.md | 15 ----- .../examples/avatars/get-image.md | 14 ----- .../examples/avatars/get-initials.md | 15 ----- .../server-nodejs/examples/avatars/get-q-r.md | 15 ----- .../databases/create-boolean-attribute.md | 17 ------ .../examples/databases/create-collection.md | 17 ------ .../databases/create-datetime-attribute.md | 17 ------ .../examples/databases/create-document.md | 16 ------ .../databases/create-email-attribute.md | 17 ------ .../databases/create-enum-attribute.md | 18 ------ .../databases/create-float-attribute.md | 19 ------- .../examples/databases/create-index.md | 17 ------ .../databases/create-integer-attribute.md | 19 ------- .../examples/databases/create-ip-attribute.md | 17 ------ .../create-relationship-attribute.md | 19 ------- .../databases/create-string-attribute.md | 19 ------- .../databases/create-url-attribute.md | 17 ------ .../examples/databases/create.md | 14 ----- .../examples/databases/delete-attribute.md | 14 ----- .../examples/databases/delete-collection.md | 13 ----- .../examples/databases/delete-document.md | 14 ----- .../examples/databases/delete-index.md | 14 ----- .../examples/databases/delete.md | 12 ---- .../examples/databases/get-attribute.md | 14 ----- .../examples/databases/get-collection.md | 13 ----- .../examples/databases/get-document.md | 15 ----- .../examples/databases/get-index.md | 14 ----- .../server-nodejs/examples/databases/get.md | 12 ---- .../examples/databases/list-attributes.md | 14 ----- .../examples/databases/list-collections.md | 14 ----- .../examples/databases/list-documents.md | 14 ----- .../examples/databases/list-indexes.md | 14 ----- .../server-nodejs/examples/databases/list.md | 13 ----- .../databases/update-boolean-attribute.md | 16 ------ .../examples/databases/update-collection.md | 17 ------ .../databases/update-datetime-attribute.md | 16 ------ .../examples/databases/update-document.md | 16 ------ .../databases/update-email-attribute.md | 16 ------ .../databases/update-enum-attribute.md | 17 ------ .../databases/update-float-attribute.md | 18 ------ .../databases/update-integer-attribute.md | 18 ------ .../examples/databases/update-ip-attribute.md | 16 ------ .../update-relationship-attribute.md | 15 ----- .../databases/update-string-attribute.md | 16 ------ .../databases/update-url-attribute.md | 16 ------ .../examples/databases/update.md | 14 ----- .../examples/functions/create-build.md | 14 ----- .../examples/functions/create-deployment.md | 17 ------ .../examples/functions/create-execution.md | 18 ------ .../examples/functions/create-variable.md | 14 ----- .../examples/functions/create.md | 32 ----------- .../examples/functions/delete-deployment.md | 13 ----- .../examples/functions/delete-execution.md | 13 ----- .../examples/functions/delete-variable.md | 13 ----- .../examples/functions/delete.md | 12 ---- .../examples/functions/download-deployment.md | 13 ----- .../examples/functions/get-deployment.md | 13 ----- .../examples/functions/get-execution.md | 13 ----- .../examples/functions/get-variable.md | 13 ----- .../server-nodejs/examples/functions/get.md | 12 ---- .../examples/functions/list-deployments.md | 14 ----- .../examples/functions/list-executions.md | 14 ----- .../examples/functions/list-runtimes.md | 10 ---- .../examples/functions/list-variables.md | 12 ---- .../server-nodejs/examples/functions/list.md | 13 ----- .../functions/update-deployment-build.md | 13 ----- .../examples/functions/update-deployment.md | 13 ----- .../examples/functions/update-variable.md | 15 ----- .../examples/functions/update.md | 28 --------- .../examples/graphql/mutation.md | 12 ---- .../server-nodejs/examples/graphql/query.md | 12 ---- .../examples/health/get-antivirus.md | 10 ---- .../examples/health/get-cache.md | 10 ---- .../examples/health/get-certificate.md | 12 ---- .../server-nodejs/examples/health/get-d-b.md | 10 ---- .../examples/health/get-failed-jobs.md | 13 ----- .../examples/health/get-pub-sub.md | 10 ---- .../examples/health/get-queue-builds.md | 12 ---- .../examples/health/get-queue-certificates.md | 12 ---- .../examples/health/get-queue-databases.md | 13 ----- .../examples/health/get-queue-deletes.md | 12 ---- .../examples/health/get-queue-functions.md | 12 ---- .../examples/health/get-queue-logs.md | 12 ---- .../examples/health/get-queue-mails.md | 12 ---- .../examples/health/get-queue-messaging.md | 12 ---- .../examples/health/get-queue-migrations.md | 12 ---- .../examples/health/get-queue-usage-dump.md | 12 ---- .../examples/health/get-queue-usage.md | 12 ---- .../examples/health/get-queue-webhooks.md | 12 ---- .../examples/health/get-queue.md | 10 ---- .../examples/health/get-storage-local.md | 10 ---- .../examples/health/get-storage.md | 10 ---- .../server-nodejs/examples/health/get-time.md | 10 ---- .../server-nodejs/examples/health/get.md | 10 ---- .../server-nodejs/examples/locale/get.md | 10 ---- .../examples/locale/list-codes.md | 10 ---- .../examples/locale/list-continents.md | 10 ---- .../examples/locale/list-countries-e-u.md | 10 ---- .../examples/locale/list-countries-phones.md | 10 ---- .../examples/locale/list-countries.md | 10 ---- .../examples/locale/list-currencies.md | 10 ---- .../examples/locale/list-languages.md | 10 ---- .../messaging/create-apns-provider.md | 19 ------- .../examples/messaging/create-email.md | 23 -------- .../examples/messaging/create-fcm-provider.md | 15 ----- .../messaging/create-mailgun-provider.md | 21 ------- .../messaging/create-msg91provider.md | 17 ------ .../examples/messaging/create-push.md | 27 --------- .../messaging/create-sendgrid-provider.md | 19 ------- .../examples/messaging/create-sms.md | 18 ------ .../messaging/create-smtp-provider.md | 25 -------- .../examples/messaging/create-subscriber.md | 14 ----- .../messaging/create-telesign-provider.md | 17 ------ .../messaging/create-textmagic-provider.md | 17 ------ .../examples/messaging/create-topic.md | 14 ----- .../messaging/create-twilio-provider.md | 17 ------ .../messaging/create-vonage-provider.md | 17 ------ .../examples/messaging/delete-provider.md | 12 ---- .../examples/messaging/delete-subscriber.md | 13 ----- .../examples/messaging/delete-topic.md | 12 ---- .../examples/messaging/delete.md | 12 ---- .../examples/messaging/get-message.md | 12 ---- .../examples/messaging/get-provider.md | 12 ---- .../examples/messaging/get-subscriber.md | 13 ----- .../examples/messaging/get-topic.md | 12 ---- .../examples/messaging/list-message-logs.md | 13 ----- .../examples/messaging/list-messages.md | 13 ----- .../examples/messaging/list-provider-logs.md | 13 ----- .../examples/messaging/list-providers.md | 13 ----- .../messaging/list-subscriber-logs.md | 13 ----- .../examples/messaging/list-subscribers.md | 14 ----- .../examples/messaging/list-targets.md | 13 ----- .../examples/messaging/list-topic-logs.md | 13 ----- .../examples/messaging/list-topics.md | 13 ----- .../messaging/update-apns-provider.md | 19 ------- .../examples/messaging/update-email.md | 23 -------- .../examples/messaging/update-fcm-provider.md | 15 ----- .../messaging/update-mailgun-provider.md | 21 ------- .../messaging/update-msg91provider.md | 17 ------ .../examples/messaging/update-push.md | 27 --------- .../messaging/update-sendgrid-provider.md | 19 ------- .../examples/messaging/update-sms.md | 18 ------ .../messaging/update-smtp-provider.md | 25 -------- .../messaging/update-telesign-provider.md | 17 ------ .../messaging/update-textmagic-provider.md | 17 ------ .../examples/messaging/update-topic.md | 14 ----- .../messaging/update-twilio-provider.md | 17 ------ .../messaging/update-vonage-provider.md | 17 ------ .../examples/storage/create-bucket.md | 21 ------- .../examples/storage/create-file.md | 16 ------ .../examples/storage/delete-bucket.md | 12 ---- .../examples/storage/delete-file.md | 13 ----- .../examples/storage/get-bucket.md | 12 ---- .../examples/storage/get-file-download.md | 13 ----- .../examples/storage/get-file-preview.md | 24 -------- .../examples/storage/get-file-view.md | 13 ----- .../examples/storage/get-file.md | 13 ----- .../examples/storage/list-buckets.md | 13 ----- .../examples/storage/list-files.md | 14 ----- .../examples/storage/update-bucket.md | 21 ------- .../examples/storage/update-file.md | 15 ----- .../examples/teams/create-membership.md | 18 ------ .../server-nodejs/examples/teams/create.md | 14 ----- .../examples/teams/delete-membership.md | 13 ----- .../server-nodejs/examples/teams/delete.md | 12 ---- .../examples/teams/get-membership.md | 13 ----- .../server-nodejs/examples/teams/get-prefs.md | 12 ---- .../1.6.x/server-nodejs/examples/teams/get.md | 12 ---- .../examples/teams/list-memberships.md | 14 ----- .../server-nodejs/examples/teams/list.md | 13 ----- .../teams/update-membership-status.md | 15 ----- .../examples/teams/update-membership.md | 14 ----- .../examples/teams/update-name.md | 13 ----- .../examples/teams/update-prefs.md | 13 ----- .../examples/users/create-argon2user.md | 15 ----- .../examples/users/create-bcrypt-user.md | 15 ----- .../examples/users/create-j-w-t.md | 14 ----- .../examples/users/create-m-d5user.md | 15 ----- .../users/create-mfa-recovery-codes.md | 12 ---- .../examples/users/create-p-h-pass-user.md | 15 ----- .../examples/users/create-s-h-a-user.md | 16 ------ .../users/create-scrypt-modified-user.md | 18 ------ .../examples/users/create-scrypt-user.md | 20 ------- .../examples/users/create-session.md | 12 ---- .../examples/users/create-target.md | 17 ------ .../examples/users/create-token.md | 14 ----- .../server-nodejs/examples/users/create.md | 16 ------ .../examples/users/delete-identity.md | 12 ---- .../users/delete-mfa-authenticator.md | 13 ----- .../examples/users/delete-session.md | 13 ----- .../examples/users/delete-sessions.md | 12 ---- .../examples/users/delete-target.md | 13 ----- .../server-nodejs/examples/users/delete.md | 12 ---- .../examples/users/get-mfa-recovery-codes.md | 12 ---- .../server-nodejs/examples/users/get-prefs.md | 12 ---- .../examples/users/get-target.md | 13 ----- .../1.6.x/server-nodejs/examples/users/get.md | 12 ---- .../examples/users/list-identities.md | 13 ----- .../server-nodejs/examples/users/list-logs.md | 13 ----- .../examples/users/list-memberships.md | 12 ---- .../examples/users/list-mfa-factors.md | 12 ---- .../examples/users/list-sessions.md | 12 ---- .../examples/users/list-targets.md | 13 ----- .../server-nodejs/examples/users/list.md | 13 ----- .../users/update-email-verification.md | 13 ----- .../examples/users/update-email.md | 13 ----- .../examples/users/update-labels.md | 13 ----- .../users/update-mfa-recovery-codes.md | 12 ---- .../examples/users/update-mfa.md | 13 ----- .../examples/users/update-name.md | 13 ----- .../examples/users/update-password.md | 13 ----- .../users/update-phone-verification.md | 13 ----- .../examples/users/update-phone.md | 13 ----- .../examples/users/update-prefs.md | 13 ----- .../examples/users/update-status.md | 13 ----- .../examples/users/update-target.md | 16 ------ .../account/create-anonymous-session.md | 12 ---- .../account/create-email-password-session.md | 15 ----- .../examples/account/create-email-token.md | 16 ------ .../examples/account/create-j-w-t.md | 12 ---- .../account/create-magic-u-r-l-token.md | 17 ------ .../account/create-mfa-authenticator.md | 16 ------ .../examples/account/create-mfa-challenge.md | 15 ----- .../account/create-mfa-recovery-codes.md | 13 ----- .../examples/account/create-o-auth2token.md | 18 ------ .../examples/account/create-phone-token.md | 15 ----- .../account/create-phone-verification.md | 13 ----- .../examples/account/create-recovery.md | 16 ------ .../examples/account/create-session.md | 15 ----- .../examples/account/create-verification.md | 15 ----- .../server-php/examples/account/create.md | 17 ------ .../examples/account/delete-identity.md | 15 ----- .../account/delete-mfa-authenticator.md | 16 ------ .../examples/account/delete-session.md | 15 ----- .../examples/account/delete-sessions.md | 13 ----- .../account/get-mfa-recovery-codes.md | 13 ----- .../server-php/examples/account/get-prefs.md | 13 ----- .../examples/account/get-session.md | 15 ----- .../1.6.x/server-php/examples/account/get.md | 13 ----- .../examples/account/list-identities.md | 15 ----- .../server-php/examples/account/list-logs.md | 15 ----- .../examples/account/list-mfa-factors.md | 13 ----- .../examples/account/list-sessions.md | 13 ----- .../examples/account/update-email.md | 16 ------ .../examples/account/update-m-f-a.md | 15 ----- .../account/update-magic-u-r-l-session.md | 15 ----- .../account/update-mfa-authenticator.md | 17 ------ .../examples/account/update-mfa-challenge.md | 16 ------ .../account/update-mfa-recovery-codes.md | 13 ----- .../examples/account/update-name.md | 15 ----- .../examples/account/update-password.md | 16 ------ .../examples/account/update-phone-session.md | 15 ----- .../account/update-phone-verification.md | 16 ------ .../examples/account/update-phone.md | 16 ------ .../examples/account/update-prefs.md | 15 ----- .../examples/account/update-recovery.md | 17 ------ .../examples/account/update-session.md | 15 ----- .../examples/account/update-status.md | 13 ----- .../examples/account/update-verification.md | 16 ------ .../examples/avatars/get-browser.md | 19 ------- .../examples/avatars/get-credit-card.md | 19 ------- .../examples/avatars/get-favicon.md | 15 ----- .../server-php/examples/avatars/get-flag.md | 19 ------- .../server-php/examples/avatars/get-image.md | 17 ------ .../examples/avatars/get-initials.md | 18 ------ .../server-php/examples/avatars/get-q-r.md | 18 ------ .../databases/create-boolean-attribute.md | 20 ------- .../examples/databases/create-collection.md | 20 ------- .../databases/create-datetime-attribute.md | 20 ------- .../examples/databases/create-document.md | 19 ------- .../databases/create-email-attribute.md | 20 ------- .../databases/create-enum-attribute.md | 21 ------- .../databases/create-float-attribute.md | 22 ------- .../examples/databases/create-index.md | 21 ------- .../databases/create-integer-attribute.md | 22 ------- .../examples/databases/create-ip-attribute.md | 20 ------- .../create-relationship-attribute.md | 23 -------- .../databases/create-string-attribute.md | 22 ------- .../databases/create-url-attribute.md | 20 ------- .../server-php/examples/databases/create.md | 17 ------ .../examples/databases/delete-attribute.md | 17 ------ .../examples/databases/delete-collection.md | 16 ------ .../examples/databases/delete-document.md | 17 ------ .../examples/databases/delete-index.md | 17 ------ .../server-php/examples/databases/delete.md | 15 ----- .../examples/databases/get-attribute.md | 17 ------ .../examples/databases/get-collection.md | 16 ------ .../examples/databases/get-document.md | 18 ------ .../examples/databases/get-index.md | 17 ------ .../server-php/examples/databases/get.md | 15 ----- .../examples/databases/list-attributes.md | 17 ------ .../examples/databases/list-collections.md | 17 ------ .../examples/databases/list-documents.md | 17 ------ .../examples/databases/list-indexes.md | 17 ------ .../server-php/examples/databases/list.md | 16 ------ .../databases/update-boolean-attribute.md | 19 ------- .../examples/databases/update-collection.md | 20 ------- .../databases/update-datetime-attribute.md | 19 ------- .../examples/databases/update-document.md | 19 ------- .../databases/update-email-attribute.md | 19 ------- .../databases/update-enum-attribute.md | 20 ------- .../databases/update-float-attribute.md | 21 ------- .../databases/update-integer-attribute.md | 21 ------- .../examples/databases/update-ip-attribute.md | 19 ------- .../update-relationship-attribute.md | 18 ------ .../databases/update-string-attribute.md | 19 ------- .../databases/update-url-attribute.md | 19 ------- .../server-php/examples/databases/update.md | 17 ------ .../examples/functions/create-build.md | 17 ------ .../examples/functions/create-deployment.md | 20 ------- .../examples/functions/create-execution.md | 21 ------- .../examples/functions/create-variable.md | 17 ------ .../server-php/examples/functions/create.md | 36 ------------ .../examples/functions/delete-deployment.md | 16 ------ .../examples/functions/delete-execution.md | 16 ------ .../examples/functions/delete-variable.md | 16 ------ .../server-php/examples/functions/delete.md | 15 ----- .../examples/functions/download-deployment.md | 16 ------ .../examples/functions/get-deployment.md | 16 ------ .../examples/functions/get-execution.md | 16 ------ .../examples/functions/get-variable.md | 16 ------ .../server-php/examples/functions/get.md | 15 ----- .../examples/functions/list-deployments.md | 17 ------ .../examples/functions/list-executions.md | 17 ------ .../examples/functions/list-runtimes.md | 13 ----- .../examples/functions/list-variables.md | 15 ----- .../server-php/examples/functions/list.md | 16 ------ .../functions/update-deployment-build.md | 16 ------ .../examples/functions/update-deployment.md | 16 ------ .../examples/functions/update-variable.md | 18 ------ .../server-php/examples/functions/update.md | 31 ---------- .../server-php/examples/graphql/mutation.md | 15 ----- .../server-php/examples/graphql/query.md | 15 ----- .../examples/health/get-antivirus.md | 13 ----- .../server-php/examples/health/get-cache.md | 13 ----- .../examples/health/get-certificate.md | 15 ----- .../server-php/examples/health/get-d-b.md | 13 ----- .../examples/health/get-failed-jobs.md | 17 ------ .../server-php/examples/health/get-pub-sub.md | 13 ----- .../examples/health/get-queue-builds.md | 15 ----- .../examples/health/get-queue-certificates.md | 15 ----- .../examples/health/get-queue-databases.md | 16 ------ .../examples/health/get-queue-deletes.md | 15 ----- .../examples/health/get-queue-functions.md | 15 ----- .../examples/health/get-queue-logs.md | 15 ----- .../examples/health/get-queue-mails.md | 15 ----- .../examples/health/get-queue-messaging.md | 15 ----- .../examples/health/get-queue-migrations.md | 15 ----- .../examples/health/get-queue-usage-dump.md | 15 ----- .../examples/health/get-queue-usage.md | 15 ----- .../examples/health/get-queue-webhooks.md | 15 ----- .../server-php/examples/health/get-queue.md | 13 ----- .../examples/health/get-storage-local.md | 13 ----- .../server-php/examples/health/get-storage.md | 13 ----- .../server-php/examples/health/get-time.md | 13 ----- .../1.6.x/server-php/examples/health/get.md | 13 ----- .../1.6.x/server-php/examples/locale/get.md | 13 ----- .../server-php/examples/locale/list-codes.md | 13 ----- .../examples/locale/list-continents.md | 13 ----- .../examples/locale/list-countries-e-u.md | 13 ----- .../examples/locale/list-countries-phones.md | 13 ----- .../examples/locale/list-countries.md | 13 ----- .../examples/locale/list-currencies.md | 13 ----- .../examples/locale/list-languages.md | 13 ----- .../messaging/create-apns-provider.md | 22 ------- .../examples/messaging/create-email.md | 26 --------- .../examples/messaging/create-fcm-provider.md | 18 ------ .../messaging/create-mailgun-provider.md | 24 -------- .../messaging/create-msg91provider.md | 20 ------- .../examples/messaging/create-push.md | 30 ---------- .../messaging/create-sendgrid-provider.md | 22 ------- .../examples/messaging/create-sms.md | 21 ------- .../messaging/create-smtp-provider.md | 28 --------- .../examples/messaging/create-subscriber.md | 17 ------ .../messaging/create-telesign-provider.md | 20 ------- .../messaging/create-textmagic-provider.md | 20 ------- .../examples/messaging/create-topic.md | 17 ------ .../messaging/create-twilio-provider.md | 20 ------- .../messaging/create-vonage-provider.md | 20 ------- .../examples/messaging/delete-provider.md | 15 ----- .../examples/messaging/delete-subscriber.md | 16 ------ .../examples/messaging/delete-topic.md | 15 ----- .../server-php/examples/messaging/delete.md | 15 ----- .../examples/messaging/get-message.md | 15 ----- .../examples/messaging/get-provider.md | 15 ----- .../examples/messaging/get-subscriber.md | 16 ------ .../examples/messaging/get-topic.md | 15 ----- .../examples/messaging/list-message-logs.md | 16 ------ .../examples/messaging/list-messages.md | 16 ------ .../examples/messaging/list-provider-logs.md | 16 ------ .../examples/messaging/list-providers.md | 16 ------ .../messaging/list-subscriber-logs.md | 16 ------ .../examples/messaging/list-subscribers.md | 17 ------ .../examples/messaging/list-targets.md | 16 ------ .../examples/messaging/list-topic-logs.md | 16 ------ .../examples/messaging/list-topics.md | 16 ------ .../messaging/update-apns-provider.md | 22 ------- .../examples/messaging/update-email.md | 26 --------- .../examples/messaging/update-fcm-provider.md | 18 ------ .../messaging/update-mailgun-provider.md | 24 -------- .../messaging/update-msg91provider.md | 20 ------- .../examples/messaging/update-push.md | 30 ---------- .../messaging/update-sendgrid-provider.md | 22 ------- .../examples/messaging/update-sms.md | 21 ------- .../messaging/update-smtp-provider.md | 28 --------- .../messaging/update-telesign-provider.md | 20 ------- .../messaging/update-textmagic-provider.md | 20 ------- .../examples/messaging/update-topic.md | 17 ------ .../messaging/update-twilio-provider.md | 20 ------- .../messaging/update-vonage-provider.md | 20 ------- .../examples/storage/create-bucket.md | 24 -------- .../examples/storage/create-file.md | 19 ------- .../examples/storage/delete-bucket.md | 15 ----- .../examples/storage/delete-file.md | 16 ------ .../server-php/examples/storage/get-bucket.md | 15 ----- .../examples/storage/get-file-download.md | 16 ------ .../examples/storage/get-file-preview.md | 27 --------- .../examples/storage/get-file-view.md | 16 ------ .../server-php/examples/storage/get-file.md | 16 ------ .../examples/storage/list-buckets.md | 16 ------ .../server-php/examples/storage/list-files.md | 17 ------ .../examples/storage/update-bucket.md | 24 -------- .../examples/storage/update-file.md | 18 ------ .../examples/teams/create-membership.md | 21 ------- .../1.6.x/server-php/examples/teams/create.md | 17 ------ .../examples/teams/delete-membership.md | 16 ------ .../1.6.x/server-php/examples/teams/delete.md | 15 ----- .../examples/teams/get-membership.md | 16 ------ .../server-php/examples/teams/get-prefs.md | 15 ----- .../1.6.x/server-php/examples/teams/get.md | 15 ----- .../examples/teams/list-memberships.md | 17 ------ .../1.6.x/server-php/examples/teams/list.md | 16 ------ .../teams/update-membership-status.md | 18 ------ .../examples/teams/update-membership.md | 17 ------ .../server-php/examples/teams/update-name.md | 16 ------ .../server-php/examples/teams/update-prefs.md | 16 ------ .../examples/users/create-argon2user.md | 18 ------ .../examples/users/create-bcrypt-user.md | 18 ------ .../server-php/examples/users/create-j-w-t.md | 17 ------ .../examples/users/create-m-d5user.md | 18 ------ .../users/create-mfa-recovery-codes.md | 15 ----- .../examples/users/create-p-h-pass-user.md | 18 ------ .../examples/users/create-s-h-a-user.md | 19 ------- .../users/create-scrypt-modified-user.md | 21 ------- .../examples/users/create-scrypt-user.md | 23 -------- .../examples/users/create-session.md | 15 ----- .../examples/users/create-target.md | 21 ------- .../server-php/examples/users/create-token.md | 17 ------ .../1.6.x/server-php/examples/users/create.md | 19 ------- .../examples/users/delete-identity.md | 15 ----- .../users/delete-mfa-authenticator.md | 17 ------ .../examples/users/delete-session.md | 16 ------ .../examples/users/delete-sessions.md | 15 ----- .../examples/users/delete-target.md | 16 ------ .../1.6.x/server-php/examples/users/delete.md | 15 ----- .../examples/users/get-mfa-recovery-codes.md | 15 ----- .../server-php/examples/users/get-prefs.md | 15 ----- .../server-php/examples/users/get-target.md | 16 ------ .../1.6.x/server-php/examples/users/get.md | 15 ----- .../examples/users/list-identities.md | 16 ------ .../server-php/examples/users/list-logs.md | 16 ------ .../examples/users/list-memberships.md | 15 ----- .../examples/users/list-mfa-factors.md | 15 ----- .../examples/users/list-sessions.md | 15 ----- .../server-php/examples/users/list-targets.md | 16 ------ .../1.6.x/server-php/examples/users/list.md | 16 ------ .../users/update-email-verification.md | 16 ------ .../server-php/examples/users/update-email.md | 16 ------ .../examples/users/update-labels.md | 16 ------ .../users/update-mfa-recovery-codes.md | 15 ----- .../server-php/examples/users/update-mfa.md | 16 ------ .../server-php/examples/users/update-name.md | 16 ------ .../examples/users/update-password.md | 16 ------ .../users/update-phone-verification.md | 16 ------ .../server-php/examples/users/update-phone.md | 16 ------ .../server-php/examples/users/update-prefs.md | 16 ------ .../examples/users/update-status.md | 16 ------ .../examples/users/update-target.md | 19 ------- .../account/create-anonymous-session.md | 9 --- .../account/create-email-password-session.md | 12 ---- .../examples/account/create-email-token.md | 13 ----- .../examples/account/create-j-w-t.md | 9 --- .../account/create-magic-u-r-l-token.md | 14 ----- .../account/create-mfa-authenticator.md | 13 ----- .../examples/account/create-mfa-challenge.md | 12 ---- .../account/create-mfa-recovery-codes.md | 10 ---- .../examples/account/create-o-auth2token.md | 15 ----- .../examples/account/create-phone-token.md | 12 ---- .../account/create-phone-verification.md | 10 ---- .../examples/account/create-recovery.md | 13 ----- .../examples/account/create-session.md | 12 ---- .../examples/account/create-verification.md | 12 ---- .../server-python/examples/account/create.md | 14 ----- .../examples/account/delete-identity.md | 12 ---- .../account/delete-mfa-authenticator.md | 13 ----- .../examples/account/delete-session.md | 12 ---- .../examples/account/delete-sessions.md | 10 ---- .../account/get-mfa-recovery-codes.md | 10 ---- .../examples/account/get-prefs.md | 10 ---- .../examples/account/get-session.md | 12 ---- .../server-python/examples/account/get.md | 10 ---- .../examples/account/list-identities.md | 12 ---- .../examples/account/list-logs.md | 12 ---- .../examples/account/list-mfa-factors.md | 10 ---- .../examples/account/list-sessions.md | 10 ---- .../examples/account/update-email.md | 13 ----- .../examples/account/update-m-f-a.md | 12 ---- .../account/update-magic-u-r-l-session.md | 12 ---- .../account/update-mfa-authenticator.md | 14 ----- .../examples/account/update-mfa-challenge.md | 13 ----- .../account/update-mfa-recovery-codes.md | 10 ---- .../examples/account/update-name.md | 12 ---- .../examples/account/update-password.md | 13 ----- .../examples/account/update-phone-session.md | 12 ---- .../account/update-phone-verification.md | 13 ----- .../examples/account/update-phone.md | 13 ----- .../examples/account/update-prefs.md | 12 ---- .../examples/account/update-recovery.md | 14 ----- .../examples/account/update-session.md | 12 ---- .../examples/account/update-status.md | 10 ---- .../examples/account/update-verification.md | 13 ----- .../examples/avatars/get-browser.md | 16 ------ .../examples/avatars/get-credit-card.md | 16 ------ .../examples/avatars/get-favicon.md | 12 ---- .../examples/avatars/get-flag.md | 16 ------ .../examples/avatars/get-image.md | 14 ----- .../examples/avatars/get-initials.md | 15 ----- .../server-python/examples/avatars/get-q-r.md | 15 ----- .../databases/create-boolean-attribute.md | 17 ------ .../examples/databases/create-collection.md | 17 ------ .../databases/create-datetime-attribute.md | 17 ------ .../examples/databases/create-document.md | 16 ------ .../databases/create-email-attribute.md | 17 ------ .../databases/create-enum-attribute.md | 18 ------ .../databases/create-float-attribute.md | 19 ------- .../examples/databases/create-index.md | 18 ------ .../databases/create-integer-attribute.md | 19 ------- .../examples/databases/create-ip-attribute.md | 17 ------ .../create-relationship-attribute.md | 20 ------- .../databases/create-string-attribute.md | 19 ------- .../databases/create-url-attribute.md | 17 ------ .../examples/databases/create.md | 14 ----- .../examples/databases/delete-attribute.md | 14 ----- .../examples/databases/delete-collection.md | 13 ----- .../examples/databases/delete-document.md | 14 ----- .../examples/databases/delete-index.md | 14 ----- .../examples/databases/delete.md | 12 ---- .../examples/databases/get-attribute.md | 14 ----- .../examples/databases/get-collection.md | 13 ----- .../examples/databases/get-document.md | 15 ----- .../examples/databases/get-index.md | 14 ----- .../server-python/examples/databases/get.md | 12 ---- .../examples/databases/list-attributes.md | 14 ----- .../examples/databases/list-collections.md | 14 ----- .../examples/databases/list-documents.md | 14 ----- .../examples/databases/list-indexes.md | 14 ----- .../server-python/examples/databases/list.md | 13 ----- .../databases/update-boolean-attribute.md | 16 ------ .../examples/databases/update-collection.md | 17 ------ .../databases/update-datetime-attribute.md | 16 ------ .../examples/databases/update-document.md | 16 ------ .../databases/update-email-attribute.md | 16 ------ .../databases/update-enum-attribute.md | 17 ------ .../databases/update-float-attribute.md | 18 ------ .../databases/update-integer-attribute.md | 18 ------ .../examples/databases/update-ip-attribute.md | 16 ------ .../update-relationship-attribute.md | 15 ----- .../databases/update-string-attribute.md | 16 ------ .../databases/update-url-attribute.md | 16 ------ .../examples/databases/update.md | 14 ----- .../examples/functions/create-build.md | 14 ----- .../examples/functions/create-deployment.md | 17 ------ .../examples/functions/create-execution.md | 18 ------ .../examples/functions/create-variable.md | 14 ----- .../examples/functions/create.md | 33 ----------- .../examples/functions/delete-deployment.md | 13 ----- .../examples/functions/delete-execution.md | 13 ----- .../examples/functions/delete-variable.md | 13 ----- .../examples/functions/delete.md | 12 ---- .../examples/functions/download-deployment.md | 13 ----- .../examples/functions/get-deployment.md | 13 ----- .../examples/functions/get-execution.md | 13 ----- .../examples/functions/get-variable.md | 13 ----- .../server-python/examples/functions/get.md | 12 ---- .../examples/functions/list-deployments.md | 14 ----- .../examples/functions/list-executions.md | 14 ----- .../examples/functions/list-runtimes.md | 10 ---- .../examples/functions/list-variables.md | 12 ---- .../server-python/examples/functions/list.md | 13 ----- .../functions/update-deployment-build.md | 13 ----- .../examples/functions/update-deployment.md | 13 ----- .../examples/functions/update-variable.md | 15 ----- .../examples/functions/update.md | 28 --------- .../examples/graphql/mutation.md | 12 ---- .../server-python/examples/graphql/query.md | 12 ---- .../examples/health/get-antivirus.md | 10 ---- .../examples/health/get-cache.md | 10 ---- .../examples/health/get-certificate.md | 12 ---- .../server-python/examples/health/get-d-b.md | 10 ---- .../examples/health/get-failed-jobs.md | 14 ----- .../examples/health/get-pub-sub.md | 10 ---- .../examples/health/get-queue-builds.md | 12 ---- .../examples/health/get-queue-certificates.md | 12 ---- .../examples/health/get-queue-databases.md | 13 ----- .../examples/health/get-queue-deletes.md | 12 ---- .../examples/health/get-queue-functions.md | 12 ---- .../examples/health/get-queue-logs.md | 12 ---- .../examples/health/get-queue-mails.md | 12 ---- .../examples/health/get-queue-messaging.md | 12 ---- .../examples/health/get-queue-migrations.md | 12 ---- .../examples/health/get-queue-usage-dump.md | 12 ---- .../examples/health/get-queue-usage.md | 12 ---- .../examples/health/get-queue-webhooks.md | 12 ---- .../examples/health/get-queue.md | 10 ---- .../examples/health/get-storage-local.md | 10 ---- .../examples/health/get-storage.md | 10 ---- .../server-python/examples/health/get-time.md | 10 ---- .../server-python/examples/health/get.md | 10 ---- .../server-python/examples/locale/get.md | 10 ---- .../examples/locale/list-codes.md | 10 ---- .../examples/locale/list-continents.md | 10 ---- .../examples/locale/list-countries-e-u.md | 10 ---- .../examples/locale/list-countries-phones.md | 10 ---- .../examples/locale/list-countries.md | 10 ---- .../examples/locale/list-currencies.md | 10 ---- .../examples/locale/list-languages.md | 10 ---- .../messaging/create-apns-provider.md | 19 ------- .../examples/messaging/create-email.md | 23 -------- .../examples/messaging/create-fcm-provider.md | 15 ----- .../messaging/create-mailgun-provider.md | 21 ------- .../messaging/create-msg91provider.md | 17 ------ .../examples/messaging/create-push.md | 27 --------- .../messaging/create-sendgrid-provider.md | 19 ------- .../examples/messaging/create-sms.md | 18 ------ .../messaging/create-smtp-provider.md | 25 -------- .../examples/messaging/create-subscriber.md | 14 ----- .../messaging/create-telesign-provider.md | 17 ------ .../messaging/create-textmagic-provider.md | 17 ------ .../examples/messaging/create-topic.md | 14 ----- .../messaging/create-twilio-provider.md | 17 ------ .../messaging/create-vonage-provider.md | 17 ------ .../examples/messaging/delete-provider.md | 12 ---- .../examples/messaging/delete-subscriber.md | 13 ----- .../examples/messaging/delete-topic.md | 12 ---- .../examples/messaging/delete.md | 12 ---- .../examples/messaging/get-message.md | 12 ---- .../examples/messaging/get-provider.md | 12 ---- .../examples/messaging/get-subscriber.md | 13 ----- .../examples/messaging/get-topic.md | 12 ---- .../examples/messaging/list-message-logs.md | 13 ----- .../examples/messaging/list-messages.md | 13 ----- .../examples/messaging/list-provider-logs.md | 13 ----- .../examples/messaging/list-providers.md | 13 ----- .../messaging/list-subscriber-logs.md | 13 ----- .../examples/messaging/list-subscribers.md | 14 ----- .../examples/messaging/list-targets.md | 13 ----- .../examples/messaging/list-topic-logs.md | 13 ----- .../examples/messaging/list-topics.md | 13 ----- .../messaging/update-apns-provider.md | 19 ------- .../examples/messaging/update-email.md | 23 -------- .../examples/messaging/update-fcm-provider.md | 15 ----- .../messaging/update-mailgun-provider.md | 21 ------- .../messaging/update-msg91provider.md | 17 ------ .../examples/messaging/update-push.md | 27 --------- .../messaging/update-sendgrid-provider.md | 19 ------- .../examples/messaging/update-sms.md | 18 ------ .../messaging/update-smtp-provider.md | 25 -------- .../messaging/update-telesign-provider.md | 17 ------ .../messaging/update-textmagic-provider.md | 17 ------ .../examples/messaging/update-topic.md | 14 ----- .../messaging/update-twilio-provider.md | 17 ------ .../messaging/update-vonage-provider.md | 17 ------ .../examples/storage/create-bucket.md | 21 ------- .../examples/storage/create-file.md | 16 ------ .../examples/storage/delete-bucket.md | 12 ---- .../examples/storage/delete-file.md | 13 ----- .../examples/storage/get-bucket.md | 12 ---- .../examples/storage/get-file-download.md | 13 ----- .../examples/storage/get-file-preview.md | 24 -------- .../examples/storage/get-file-view.md | 13 ----- .../examples/storage/get-file.md | 13 ----- .../examples/storage/list-buckets.md | 13 ----- .../examples/storage/list-files.md | 14 ----- .../examples/storage/update-bucket.md | 21 ------- .../examples/storage/update-file.md | 15 ----- .../examples/teams/create-membership.md | 18 ------ .../server-python/examples/teams/create.md | 14 ----- .../examples/teams/delete-membership.md | 13 ----- .../server-python/examples/teams/delete.md | 12 ---- .../examples/teams/get-membership.md | 13 ----- .../server-python/examples/teams/get-prefs.md | 12 ---- .../1.6.x/server-python/examples/teams/get.md | 12 ---- .../examples/teams/list-memberships.md | 14 ----- .../server-python/examples/teams/list.md | 13 ----- .../teams/update-membership-status.md | 15 ----- .../examples/teams/update-membership.md | 14 ----- .../examples/teams/update-name.md | 13 ----- .../examples/teams/update-prefs.md | 13 ----- .../examples/users/create-argon2user.md | 15 ----- .../examples/users/create-bcrypt-user.md | 15 ----- .../examples/users/create-j-w-t.md | 14 ----- .../examples/users/create-m-d5user.md | 15 ----- .../users/create-mfa-recovery-codes.md | 12 ---- .../examples/users/create-p-h-pass-user.md | 15 ----- .../examples/users/create-s-h-a-user.md | 16 ------ .../users/create-scrypt-modified-user.md | 18 ------ .../examples/users/create-scrypt-user.md | 20 ------- .../examples/users/create-session.md | 12 ---- .../examples/users/create-target.md | 18 ------ .../examples/users/create-token.md | 14 ----- .../server-python/examples/users/create.md | 16 ------ .../examples/users/delete-identity.md | 12 ---- .../users/delete-mfa-authenticator.md | 14 ----- .../examples/users/delete-session.md | 13 ----- .../examples/users/delete-sessions.md | 12 ---- .../examples/users/delete-target.md | 13 ----- .../server-python/examples/users/delete.md | 12 ---- .../examples/users/get-mfa-recovery-codes.md | 12 ---- .../server-python/examples/users/get-prefs.md | 12 ---- .../examples/users/get-target.md | 13 ----- .../1.6.x/server-python/examples/users/get.md | 12 ---- .../examples/users/list-identities.md | 13 ----- .../server-python/examples/users/list-logs.md | 13 ----- .../examples/users/list-memberships.md | 12 ---- .../examples/users/list-mfa-factors.md | 12 ---- .../examples/users/list-sessions.md | 12 ---- .../examples/users/list-targets.md | 13 ----- .../server-python/examples/users/list.md | 13 ----- .../users/update-email-verification.md | 13 ----- .../examples/users/update-email.md | 13 ----- .../examples/users/update-labels.md | 13 ----- .../users/update-mfa-recovery-codes.md | 12 ---- .../examples/users/update-mfa.md | 13 ----- .../examples/users/update-name.md | 13 ----- .../examples/users/update-password.md | 13 ----- .../users/update-phone-verification.md | 13 ----- .../examples/users/update-phone.md | 13 ----- .../examples/users/update-prefs.md | 13 ----- .../examples/users/update-status.md | 13 ----- .../examples/users/update-target.md | 16 ------ .../account/create-anonymous-session.md | 6 -- .../account/create-email-password-session.md | 10 ---- .../examples/account/create-email-token.md | 11 ---- .../examples/account/create-j-w-t.md | 6 -- .../account/create-magic-u-r-l-token.md | 12 ---- .../account/create-mfa-authenticator.md | 8 --- .../examples/account/create-mfa-challenge.md | 9 --- .../account/create-mfa-recovery-codes.md | 8 --- .../examples/account/create-o-auth2token.md | 6 -- .../examples/account/create-phone-token.md | 10 ---- .../account/create-phone-verification.md | 8 --- .../examples/account/create-recovery.md | 12 ---- .../examples/account/create-session.md | 10 ---- .../examples/account/create-verification.md | 11 ---- .../server-rest/examples/account/create.md | 12 ---- .../examples/account/delete-identity.md | 8 --- .../account/delete-mfa-authenticator.md | 8 --- .../examples/account/delete-session.md | 8 --- .../examples/account/delete-sessions.md | 8 --- .../account/get-mfa-recovery-codes.md | 8 --- .../server-rest/examples/account/get-prefs.md | 8 --- .../examples/account/get-session.md | 8 --- .../1.6.x/server-rest/examples/account/get.md | 8 --- .../examples/account/list-identities.md | 8 --- .../server-rest/examples/account/list-logs.md | 8 --- .../examples/account/list-mfa-factors.md | 8 --- .../examples/account/list-sessions.md | 8 --- .../examples/account/update-email.md | 12 ---- .../examples/account/update-m-f-a.md | 11 ---- .../account/update-magic-u-r-l-session.md | 10 ---- .../account/update-mfa-authenticator.md | 11 ---- .../examples/account/update-mfa-challenge.md | 12 ---- .../account/update-mfa-recovery-codes.md | 8 --- .../examples/account/update-name.md | 11 ---- .../examples/account/update-password.md | 12 ---- .../examples/account/update-phone-session.md | 10 ---- .../account/update-phone-verification.md | 12 ---- .../examples/account/update-phone.md | 12 ---- .../examples/account/update-prefs.md | 11 ---- .../examples/account/update-recovery.md | 13 ----- .../examples/account/update-session.md | 8 --- .../examples/account/update-status.md | 8 --- .../examples/account/update-verification.md | 12 ---- .../examples/avatars/get-browser.md | 9 --- .../examples/avatars/get-credit-card.md | 9 --- .../examples/avatars/get-favicon.md | 9 --- .../server-rest/examples/avatars/get-flag.md | 9 --- .../server-rest/examples/avatars/get-image.md | 9 --- .../examples/avatars/get-initials.md | 9 --- .../server-rest/examples/avatars/get-q-r.md | 9 --- .../databases/create-boolean-attribute.md | 13 ----- .../examples/databases/create-collection.md | 14 ----- .../databases/create-datetime-attribute.md | 13 ----- .../examples/databases/create-document.md | 14 ----- .../databases/create-email-attribute.md | 13 ----- .../databases/create-enum-attribute.md | 14 ----- .../databases/create-float-attribute.md | 15 ----- .../examples/databases/create-index.md | 13 ----- .../databases/create-integer-attribute.md | 15 ----- .../examples/databases/create-ip-attribute.md | 13 ----- .../create-relationship-attribute.md | 15 ----- .../databases/create-string-attribute.md | 15 ----- .../databases/create-url-attribute.md | 13 ----- .../server-rest/examples/databases/create.md | 12 ---- .../examples/databases/delete-attribute.md | 7 --- .../examples/databases/delete-collection.md | 7 --- .../examples/databases/delete-document.md | 9 --- .../examples/databases/delete-index.md | 7 --- .../server-rest/examples/databases/delete.md | 7 --- .../examples/databases/get-attribute.md | 7 --- .../examples/databases/get-collection.md | 7 --- .../examples/databases/get-document.md | 9 --- .../examples/databases/get-index.md | 7 --- .../server-rest/examples/databases/get.md | 7 --- .../examples/databases/list-attributes.md | 7 --- .../examples/databases/list-collections.md | 7 --- .../examples/databases/list-documents.md | 9 --- .../examples/databases/list-indexes.md | 7 --- .../server-rest/examples/databases/list.md | 7 --- .../databases/update-boolean-attribute.md | 11 ---- .../examples/databases/update-collection.md | 13 ----- .../databases/update-datetime-attribute.md | 11 ---- .../examples/databases/update-document.md | 13 ----- .../databases/update-email-attribute.md | 11 ---- .../databases/update-enum-attribute.md | 12 ---- .../databases/update-float-attribute.md | 13 ----- .../databases/update-integer-attribute.md | 13 ----- .../examples/databases/update-ip-attribute.md | 11 ---- .../update-relationship-attribute.md | 10 ---- .../databases/update-string-attribute.md | 11 ---- .../databases/update-url-attribute.md | 11 ---- .../server-rest/examples/databases/update.md | 11 ---- .../examples/functions/create-build.md | 10 ---- .../examples/functions/create-deployment.md | 30 ---------- .../examples/functions/create-execution.md | 17 ------ .../examples/functions/create-variable.md | 11 ---- .../server-rest/examples/functions/create.md | 30 ---------- .../examples/functions/delete-deployment.md | 7 --- .../examples/functions/delete-execution.md | 7 --- .../examples/functions/delete-variable.md | 7 --- .../server-rest/examples/functions/delete.md | 7 --- .../examples/functions/download-deployment.md | 7 --- .../examples/functions/get-deployment.md | 7 --- .../examples/functions/get-execution.md | 9 --- .../examples/functions/get-variable.md | 7 --- .../server-rest/examples/functions/get.md | 7 --- .../examples/functions/list-deployments.md | 7 --- .../examples/functions/list-executions.md | 9 --- .../examples/functions/list-runtimes.md | 7 --- .../examples/functions/list-variables.md | 7 --- .../server-rest/examples/functions/list.md | 7 --- .../functions/update-deployment-build.md | 7 --- .../examples/functions/update-deployment.md | 7 --- .../examples/functions/update-variable.md | 11 ---- .../server-rest/examples/functions/update.md | 25 -------- .../server-rest/examples/graphql/mutation.md | 13 ----- .../server-rest/examples/graphql/query.md | 13 ----- .../examples/health/get-antivirus.md | 7 --- .../server-rest/examples/health/get-cache.md | 7 --- .../examples/health/get-certificate.md | 7 --- .../server-rest/examples/health/get-d-b.md | 7 --- .../examples/health/get-failed-jobs.md | 7 --- .../examples/health/get-pub-sub.md | 7 --- .../examples/health/get-queue-builds.md | 7 --- .../examples/health/get-queue-certificates.md | 7 --- .../examples/health/get-queue-databases.md | 7 --- .../examples/health/get-queue-deletes.md | 7 --- .../examples/health/get-queue-functions.md | 7 --- .../examples/health/get-queue-logs.md | 7 --- .../examples/health/get-queue-mails.md | 7 --- .../examples/health/get-queue-messaging.md | 7 --- .../examples/health/get-queue-migrations.md | 7 --- .../examples/health/get-queue-usage-dump.md | 7 --- .../examples/health/get-queue-usage.md | 7 --- .../examples/health/get-queue-webhooks.md | 7 --- .../server-rest/examples/health/get-queue.md | 7 --- .../examples/health/get-storage-local.md | 7 --- .../examples/health/get-storage.md | 7 --- .../server-rest/examples/health/get-time.md | 7 --- .../1.6.x/server-rest/examples/health/get.md | 7 --- .../1.6.x/server-rest/examples/locale/get.md | 9 --- .../server-rest/examples/locale/list-codes.md | 9 --- .../examples/locale/list-continents.md | 9 --- .../examples/locale/list-countries-e-u.md | 9 --- .../examples/locale/list-countries-phones.md | 9 --- .../examples/locale/list-countries.md | 9 --- .../examples/locale/list-currencies.md | 9 --- .../examples/locale/list-languages.md | 9 --- .../messaging/create-apns-provider.md | 17 ------ .../examples/messaging/create-email.md | 21 ------- .../examples/messaging/create-fcm-provider.md | 13 ----- .../messaging/create-mailgun-provider.md | 19 ------- .../messaging/create-msg91provider.md | 15 ----- .../examples/messaging/create-push.md | 25 -------- .../messaging/create-sendgrid-provider.md | 17 ------ .../examples/messaging/create-sms.md | 16 ------ .../messaging/create-smtp-provider.md | 23 -------- .../examples/messaging/create-subscriber.md | 13 ----- .../messaging/create-telesign-provider.md | 15 ----- .../messaging/create-textmagic-provider.md | 15 ----- .../examples/messaging/create-topic.md | 12 ---- .../messaging/create-twilio-provider.md | 15 ----- .../messaging/create-vonage-provider.md | 15 ----- .../examples/messaging/delete-provider.md | 7 --- .../examples/messaging/delete-subscriber.md | 9 --- .../examples/messaging/delete-topic.md | 7 --- .../server-rest/examples/messaging/delete.md | 7 --- .../examples/messaging/get-message.md | 7 --- .../examples/messaging/get-provider.md | 7 --- .../examples/messaging/get-subscriber.md | 7 --- .../examples/messaging/get-topic.md | 7 --- .../examples/messaging/list-message-logs.md | 7 --- .../examples/messaging/list-messages.md | 7 --- .../examples/messaging/list-provider-logs.md | 7 --- .../examples/messaging/list-providers.md | 7 --- .../messaging/list-subscriber-logs.md | 7 --- .../examples/messaging/list-subscribers.md | 7 --- .../examples/messaging/list-targets.md | 7 --- .../examples/messaging/list-topic-logs.md | 7 --- .../examples/messaging/list-topics.md | 7 --- .../messaging/update-apns-provider.md | 16 ------ .../examples/messaging/update-email.md | 20 ------- .../examples/messaging/update-fcm-provider.md | 12 ---- .../messaging/update-mailgun-provider.md | 18 ------ .../messaging/update-msg91provider.md | 14 ----- .../examples/messaging/update-push.md | 24 -------- .../messaging/update-sendgrid-provider.md | 16 ------ .../examples/messaging/update-sms.md | 15 ----- .../messaging/update-smtp-provider.md | 22 ------- .../messaging/update-telesign-provider.md | 14 ----- .../messaging/update-textmagic-provider.md | 14 ----- .../examples/messaging/update-topic.md | 11 ---- .../messaging/update-twilio-provider.md | 14 ----- .../messaging/update-vonage-provider.md | 14 ----- .../examples/storage/create-bucket.md | 19 ------- .../examples/storage/create-file.md | 27 --------- .../examples/storage/delete-bucket.md | 7 --- .../examples/storage/delete-file.md | 9 --- .../examples/storage/get-bucket.md | 7 --- .../examples/storage/get-file-download.md | 9 --- .../examples/storage/get-file-preview.md | 9 --- .../examples/storage/get-file-view.md | 9 --- .../server-rest/examples/storage/get-file.md | 9 --- .../examples/storage/list-buckets.md | 7 --- .../examples/storage/list-files.md | 9 --- .../examples/storage/update-bucket.md | 18 ------ .../examples/storage/update-file.md | 13 ----- .../examples/teams/create-membership.md | 17 ------ .../server-rest/examples/teams/create.md | 14 ----- .../examples/teams/delete-membership.md | 9 --- .../server-rest/examples/teams/delete.md | 9 --- .../examples/teams/get-membership.md | 9 --- .../server-rest/examples/teams/get-prefs.md | 8 --- .../1.6.x/server-rest/examples/teams/get.md | 9 --- .../examples/teams/list-memberships.md | 9 --- .../1.6.x/server-rest/examples/teams/list.md | 9 --- .../teams/update-membership-status.md | 12 ---- .../examples/teams/update-membership.md | 12 ---- .../server-rest/examples/teams/update-name.md | 12 ---- .../examples/teams/update-prefs.md | 11 ---- .../examples/users/create-argon2user.md | 13 ----- .../examples/users/create-bcrypt-user.md | 13 ----- .../examples/users/create-j-w-t.md | 11 ---- .../examples/users/create-m-d5user.md | 13 ----- .../users/create-mfa-recovery-codes.md | 7 --- .../examples/users/create-p-h-pass-user.md | 13 ----- .../examples/users/create-s-h-a-user.md | 14 ----- .../users/create-scrypt-modified-user.md | 16 ------ .../examples/users/create-scrypt-user.md | 18 ------ .../examples/users/create-session.md | 7 --- .../examples/users/create-target.md | 14 ----- .../examples/users/create-token.md | 11 ---- .../server-rest/examples/users/create.md | 14 ----- .../examples/users/delete-identity.md | 7 --- .../users/delete-mfa-authenticator.md | 7 --- .../examples/users/delete-session.md | 7 --- .../examples/users/delete-sessions.md | 7 --- .../examples/users/delete-target.md | 7 --- .../server-rest/examples/users/delete.md | 7 --- .../examples/users/get-mfa-recovery-codes.md | 7 --- .../server-rest/examples/users/get-prefs.md | 7 --- .../server-rest/examples/users/get-target.md | 7 --- .../1.6.x/server-rest/examples/users/get.md | 7 --- .../examples/users/list-identities.md | 7 --- .../server-rest/examples/users/list-logs.md | 7 --- .../examples/users/list-memberships.md | 7 --- .../examples/users/list-mfa-factors.md | 7 --- .../examples/users/list-sessions.md | 7 --- .../examples/users/list-targets.md | 7 --- .../1.6.x/server-rest/examples/users/list.md | 7 --- .../users/update-email-verification.md | 10 ---- .../examples/users/update-email.md | 10 ---- .../examples/users/update-labels.md | 10 ---- .../users/update-mfa-recovery-codes.md | 7 --- .../server-rest/examples/users/update-mfa.md | 10 ---- .../server-rest/examples/users/update-name.md | 10 ---- .../examples/users/update-password.md | 10 ---- .../users/update-phone-verification.md | 10 ---- .../examples/users/update-phone.md | 10 ---- .../examples/users/update-prefs.md | 10 ---- .../examples/users/update-status.md | 10 ---- .../examples/users/update-target.md | 12 ---- .../account/create-anonymous-session.md | 11 ---- .../account/create-email-password-session.md | 14 ----- .../examples/account/create-email-token.md | 15 ----- .../examples/account/create-j-w-t.md | 11 ---- .../account/create-magic-u-r-l-token.md | 16 ------ .../account/create-mfa-authenticator.md | 15 ----- .../examples/account/create-mfa-challenge.md | 14 ----- .../account/create-mfa-recovery-codes.md | 12 ---- .../examples/account/create-o-auth2token.md | 17 ------ .../examples/account/create-phone-token.md | 14 ----- .../account/create-phone-verification.md | 12 ---- .../examples/account/create-recovery.md | 15 ----- .../examples/account/create-session.md | 14 ----- .../examples/account/create-verification.md | 14 ----- .../server-ruby/examples/account/create.md | 16 ------ .../examples/account/delete-identity.md | 14 ----- .../account/delete-mfa-authenticator.md | 15 ----- .../examples/account/delete-session.md | 14 ----- .../examples/account/delete-sessions.md | 12 ---- .../account/get-mfa-recovery-codes.md | 12 ---- .../server-ruby/examples/account/get-prefs.md | 12 ---- .../examples/account/get-session.md | 14 ----- .../1.6.x/server-ruby/examples/account/get.md | 12 ---- .../examples/account/list-identities.md | 14 ----- .../server-ruby/examples/account/list-logs.md | 14 ----- .../examples/account/list-mfa-factors.md | 12 ---- .../examples/account/list-sessions.md | 12 ---- .../examples/account/update-email.md | 15 ----- .../examples/account/update-m-f-a.md | 14 ----- .../account/update-magic-u-r-l-session.md | 14 ----- .../account/update-mfa-authenticator.md | 16 ------ .../examples/account/update-mfa-challenge.md | 15 ----- .../account/update-mfa-recovery-codes.md | 12 ---- .../examples/account/update-name.md | 14 ----- .../examples/account/update-password.md | 15 ----- .../examples/account/update-phone-session.md | 14 ----- .../account/update-phone-verification.md | 15 ----- .../examples/account/update-phone.md | 15 ----- .../examples/account/update-prefs.md | 14 ----- .../examples/account/update-recovery.md | 16 ------ .../examples/account/update-session.md | 14 ----- .../examples/account/update-status.md | 12 ---- .../examples/account/update-verification.md | 15 ----- .../examples/avatars/get-browser.md | 18 ------ .../examples/avatars/get-credit-card.md | 18 ------ .../examples/avatars/get-favicon.md | 14 ----- .../server-ruby/examples/avatars/get-flag.md | 18 ------ .../server-ruby/examples/avatars/get-image.md | 16 ------ .../examples/avatars/get-initials.md | 17 ------ .../server-ruby/examples/avatars/get-q-r.md | 17 ------ .../databases/create-boolean-attribute.md | 19 ------- .../examples/databases/create-collection.md | 19 ------- .../databases/create-datetime-attribute.md | 19 ------- .../examples/databases/create-document.md | 18 ------ .../databases/create-email-attribute.md | 19 ------- .../databases/create-enum-attribute.md | 20 ------- .../databases/create-float-attribute.md | 21 ------- .../examples/databases/create-index.md | 20 ------- .../databases/create-integer-attribute.md | 21 ------- .../examples/databases/create-ip-attribute.md | 19 ------- .../create-relationship-attribute.md | 22 ------- .../databases/create-string-attribute.md | 21 ------- .../databases/create-url-attribute.md | 19 ------- .../server-ruby/examples/databases/create.md | 16 ------ .../examples/databases/delete-attribute.md | 16 ------ .../examples/databases/delete-collection.md | 15 ----- .../examples/databases/delete-document.md | 16 ------ .../examples/databases/delete-index.md | 16 ------ .../server-ruby/examples/databases/delete.md | 14 ----- .../examples/databases/get-attribute.md | 16 ------ .../examples/databases/get-collection.md | 15 ----- .../examples/databases/get-document.md | 17 ------ .../examples/databases/get-index.md | 16 ------ .../server-ruby/examples/databases/get.md | 14 ----- .../examples/databases/list-attributes.md | 16 ------ .../examples/databases/list-collections.md | 16 ------ .../examples/databases/list-documents.md | 16 ------ .../examples/databases/list-indexes.md | 16 ------ .../server-ruby/examples/databases/list.md | 15 ----- .../databases/update-boolean-attribute.md | 18 ------ .../examples/databases/update-collection.md | 19 ------- .../databases/update-datetime-attribute.md | 18 ------ .../examples/databases/update-document.md | 18 ------ .../databases/update-email-attribute.md | 18 ------ .../databases/update-enum-attribute.md | 19 ------- .../databases/update-float-attribute.md | 20 ------- .../databases/update-integer-attribute.md | 20 ------- .../examples/databases/update-ip-attribute.md | 18 ------ .../update-relationship-attribute.md | 17 ------ .../databases/update-string-attribute.md | 18 ------ .../databases/update-url-attribute.md | 18 ------ .../server-ruby/examples/databases/update.md | 16 ------ .../examples/functions/create-build.md | 16 ------ .../examples/functions/create-deployment.md | 18 ------ .../examples/functions/create-execution.md | 20 ------- .../examples/functions/create-variable.md | 16 ------ .../server-ruby/examples/functions/create.md | 35 ------------ .../examples/functions/delete-deployment.md | 15 ----- .../examples/functions/delete-execution.md | 15 ----- .../examples/functions/delete-variable.md | 15 ----- .../server-ruby/examples/functions/delete.md | 14 ----- .../examples/functions/download-deployment.md | 15 ----- .../examples/functions/get-deployment.md | 15 ----- .../examples/functions/get-execution.md | 15 ----- .../examples/functions/get-variable.md | 15 ----- .../server-ruby/examples/functions/get.md | 14 ----- .../examples/functions/list-deployments.md | 16 ------ .../examples/functions/list-executions.md | 16 ------ .../examples/functions/list-runtimes.md | 12 ---- .../examples/functions/list-variables.md | 14 ----- .../server-ruby/examples/functions/list.md | 15 ----- .../functions/update-deployment-build.md | 15 ----- .../examples/functions/update-deployment.md | 15 ----- .../examples/functions/update-variable.md | 17 ------ .../server-ruby/examples/functions/update.md | 30 ---------- .../server-ruby/examples/graphql/mutation.md | 14 ----- .../server-ruby/examples/graphql/query.md | 14 ----- .../examples/health/get-antivirus.md | 12 ---- .../server-ruby/examples/health/get-cache.md | 12 ---- .../examples/health/get-certificate.md | 14 ----- .../server-ruby/examples/health/get-d-b.md | 12 ---- .../examples/health/get-failed-jobs.md | 16 ------ .../examples/health/get-pub-sub.md | 12 ---- .../examples/health/get-queue-builds.md | 14 ----- .../examples/health/get-queue-certificates.md | 14 ----- .../examples/health/get-queue-databases.md | 15 ----- .../examples/health/get-queue-deletes.md | 14 ----- .../examples/health/get-queue-functions.md | 14 ----- .../examples/health/get-queue-logs.md | 14 ----- .../examples/health/get-queue-mails.md | 14 ----- .../examples/health/get-queue-messaging.md | 14 ----- .../examples/health/get-queue-migrations.md | 14 ----- .../examples/health/get-queue-usage-dump.md | 14 ----- .../examples/health/get-queue-usage.md | 14 ----- .../examples/health/get-queue-webhooks.md | 14 ----- .../server-ruby/examples/health/get-queue.md | 12 ---- .../examples/health/get-storage-local.md | 12 ---- .../examples/health/get-storage.md | 12 ---- .../server-ruby/examples/health/get-time.md | 12 ---- .../1.6.x/server-ruby/examples/health/get.md | 12 ---- .../1.6.x/server-ruby/examples/locale/get.md | 12 ---- .../server-ruby/examples/locale/list-codes.md | 12 ---- .../examples/locale/list-continents.md | 12 ---- .../examples/locale/list-countries-e-u.md | 12 ---- .../examples/locale/list-countries-phones.md | 12 ---- .../examples/locale/list-countries.md | 12 ---- .../examples/locale/list-currencies.md | 12 ---- .../examples/locale/list-languages.md | 12 ---- .../messaging/create-apns-provider.md | 21 ------- .../examples/messaging/create-email.md | 25 -------- .../examples/messaging/create-fcm-provider.md | 17 ------ .../messaging/create-mailgun-provider.md | 23 -------- .../messaging/create-msg91provider.md | 19 ------- .../examples/messaging/create-push.md | 29 ---------- .../messaging/create-sendgrid-provider.md | 21 ------- .../examples/messaging/create-sms.md | 20 ------- .../messaging/create-smtp-provider.md | 27 --------- .../examples/messaging/create-subscriber.md | 16 ------ .../messaging/create-telesign-provider.md | 19 ------- .../messaging/create-textmagic-provider.md | 19 ------- .../examples/messaging/create-topic.md | 16 ------ .../messaging/create-twilio-provider.md | 19 ------- .../messaging/create-vonage-provider.md | 19 ------- .../examples/messaging/delete-provider.md | 14 ----- .../examples/messaging/delete-subscriber.md | 15 ----- .../examples/messaging/delete-topic.md | 14 ----- .../server-ruby/examples/messaging/delete.md | 14 ----- .../examples/messaging/get-message.md | 14 ----- .../examples/messaging/get-provider.md | 14 ----- .../examples/messaging/get-subscriber.md | 15 ----- .../examples/messaging/get-topic.md | 14 ----- .../examples/messaging/list-message-logs.md | 15 ----- .../examples/messaging/list-messages.md | 15 ----- .../examples/messaging/list-provider-logs.md | 15 ----- .../examples/messaging/list-providers.md | 15 ----- .../messaging/list-subscriber-logs.md | 15 ----- .../examples/messaging/list-subscribers.md | 16 ------ .../examples/messaging/list-targets.md | 15 ----- .../examples/messaging/list-topic-logs.md | 15 ----- .../examples/messaging/list-topics.md | 15 ----- .../messaging/update-apns-provider.md | 21 ------- .../examples/messaging/update-email.md | 25 -------- .../examples/messaging/update-fcm-provider.md | 17 ------ .../messaging/update-mailgun-provider.md | 23 -------- .../messaging/update-msg91provider.md | 19 ------- .../examples/messaging/update-push.md | 29 ---------- .../messaging/update-sendgrid-provider.md | 21 ------- .../examples/messaging/update-sms.md | 20 ------- .../messaging/update-smtp-provider.md | 27 --------- .../messaging/update-telesign-provider.md | 19 ------- .../messaging/update-textmagic-provider.md | 19 ------- .../examples/messaging/update-topic.md | 16 ------ .../messaging/update-twilio-provider.md | 19 ------- .../messaging/update-vonage-provider.md | 19 ------- .../examples/storage/create-bucket.md | 23 -------- .../examples/storage/create-file.md | 17 ------ .../examples/storage/delete-bucket.md | 14 ----- .../examples/storage/delete-file.md | 15 ----- .../examples/storage/get-bucket.md | 14 ----- .../examples/storage/get-file-download.md | 15 ----- .../examples/storage/get-file-preview.md | 26 --------- .../examples/storage/get-file-view.md | 15 ----- .../server-ruby/examples/storage/get-file.md | 15 ----- .../examples/storage/list-buckets.md | 15 ----- .../examples/storage/list-files.md | 16 ------ .../examples/storage/update-bucket.md | 23 -------- .../examples/storage/update-file.md | 17 ------ .../examples/teams/create-membership.md | 20 ------- .../server-ruby/examples/teams/create.md | 16 ------ .../examples/teams/delete-membership.md | 15 ----- .../server-ruby/examples/teams/delete.md | 14 ----- .../examples/teams/get-membership.md | 15 ----- .../server-ruby/examples/teams/get-prefs.md | 14 ----- .../1.6.x/server-ruby/examples/teams/get.md | 14 ----- .../examples/teams/list-memberships.md | 16 ------ .../1.6.x/server-ruby/examples/teams/list.md | 15 ----- .../teams/update-membership-status.md | 17 ------ .../examples/teams/update-membership.md | 16 ------ .../server-ruby/examples/teams/update-name.md | 15 ----- .../examples/teams/update-prefs.md | 15 ----- .../examples/users/create-argon2user.md | 17 ------ .../examples/users/create-bcrypt-user.md | 17 ------ .../examples/users/create-j-w-t.md | 16 ------ .../examples/users/create-m-d5user.md | 17 ------ .../users/create-mfa-recovery-codes.md | 14 ----- .../examples/users/create-p-h-pass-user.md | 17 ------ .../examples/users/create-s-h-a-user.md | 18 ------ .../users/create-scrypt-modified-user.md | 20 ------- .../examples/users/create-scrypt-user.md | 22 ------- .../examples/users/create-session.md | 14 ----- .../examples/users/create-target.md | 20 ------- .../examples/users/create-token.md | 16 ------ .../server-ruby/examples/users/create.md | 18 ------ .../examples/users/delete-identity.md | 14 ----- .../users/delete-mfa-authenticator.md | 16 ------ .../examples/users/delete-session.md | 15 ----- .../examples/users/delete-sessions.md | 14 ----- .../examples/users/delete-target.md | 15 ----- .../server-ruby/examples/users/delete.md | 14 ----- .../examples/users/get-mfa-recovery-codes.md | 14 ----- .../server-ruby/examples/users/get-prefs.md | 14 ----- .../server-ruby/examples/users/get-target.md | 15 ----- .../1.6.x/server-ruby/examples/users/get.md | 14 ----- .../examples/users/list-identities.md | 15 ----- .../server-ruby/examples/users/list-logs.md | 15 ----- .../examples/users/list-memberships.md | 14 ----- .../examples/users/list-mfa-factors.md | 14 ----- .../examples/users/list-sessions.md | 14 ----- .../examples/users/list-targets.md | 15 ----- .../1.6.x/server-ruby/examples/users/list.md | 15 ----- .../users/update-email-verification.md | 15 ----- .../examples/users/update-email.md | 15 ----- .../examples/users/update-labels.md | 15 ----- .../users/update-mfa-recovery-codes.md | 14 ----- .../server-ruby/examples/users/update-mfa.md | 15 ----- .../server-ruby/examples/users/update-name.md | 15 ----- .../examples/users/update-password.md | 15 ----- .../users/update-phone-verification.md | 15 ----- .../examples/users/update-phone.md | 15 ----- .../examples/users/update-prefs.md | 15 ----- .../examples/users/update-status.md | 15 ----- .../examples/users/update-target.md | 18 ------ .../account/create-anonymous-session.md | 10 ---- .../account/create-email-password-session.md | 13 ----- .../examples/account/create-email-token.md | 14 ----- .../examples/account/create-j-w-t.md | 10 ---- .../account/create-magic-u-r-l-token.md | 15 ----- .../account/create-mfa-authenticator.md | 14 ----- .../examples/account/create-mfa-challenge.md | 13 ----- .../account/create-mfa-recovery-codes.md | 11 ---- .../examples/account/create-o-auth2token.md | 16 ------ .../examples/account/create-phone-token.md | 13 ----- .../account/create-phone-verification.md | 11 ---- .../examples/account/create-recovery.md | 14 ----- .../examples/account/create-session.md | 13 ----- .../examples/account/create-verification.md | 13 ----- .../server-swift/examples/account/create.md | 15 ----- .../examples/account/delete-identity.md | 13 ----- .../account/delete-mfa-authenticator.md | 14 ----- .../examples/account/delete-session.md | 13 ----- .../examples/account/delete-sessions.md | 11 ---- .../account/get-mfa-recovery-codes.md | 11 ---- .../examples/account/get-prefs.md | 11 ---- .../examples/account/get-session.md | 13 ----- .../server-swift/examples/account/get.md | 11 ---- .../examples/account/list-identities.md | 13 ----- .../examples/account/list-logs.md | 13 ----- .../examples/account/list-mfa-factors.md | 11 ---- .../examples/account/list-sessions.md | 11 ---- .../examples/account/update-email.md | 14 ----- .../examples/account/update-m-f-a.md | 13 ----- .../account/update-magic-u-r-l-session.md | 13 ----- .../account/update-mfa-authenticator.md | 15 ----- .../examples/account/update-mfa-challenge.md | 14 ----- .../account/update-mfa-recovery-codes.md | 11 ---- .../examples/account/update-name.md | 13 ----- .../examples/account/update-password.md | 14 ----- .../examples/account/update-phone-session.md | 13 ----- .../account/update-phone-verification.md | 14 ----- .../examples/account/update-phone.md | 14 ----- .../examples/account/update-prefs.md | 13 ----- .../examples/account/update-recovery.md | 15 ----- .../examples/account/update-session.md | 13 ----- .../examples/account/update-status.md | 11 ---- .../examples/account/update-verification.md | 14 ----- .../examples/avatars/get-browser.md | 17 ------ .../examples/avatars/get-credit-card.md | 17 ------ .../examples/avatars/get-favicon.md | 13 ----- .../server-swift/examples/avatars/get-flag.md | 17 ------ .../examples/avatars/get-image.md | 15 ----- .../examples/avatars/get-initials.md | 16 ------ .../server-swift/examples/avatars/get-q-r.md | 16 ------ .../databases/create-boolean-attribute.md | 18 ------ .../examples/databases/create-collection.md | 18 ------ .../databases/create-datetime-attribute.md | 18 ------ .../examples/databases/create-document.md | 17 ------ .../databases/create-email-attribute.md | 18 ------ .../databases/create-enum-attribute.md | 19 ------- .../databases/create-float-attribute.md | 20 ------- .../examples/databases/create-index.md | 19 ------- .../databases/create-integer-attribute.md | 20 ------- .../examples/databases/create-ip-attribute.md | 18 ------ .../create-relationship-attribute.md | 21 ------- .../databases/create-string-attribute.md | 20 ------- .../databases/create-url-attribute.md | 18 ------ .../server-swift/examples/databases/create.md | 15 ----- .../examples/databases/delete-attribute.md | 15 ----- .../examples/databases/delete-collection.md | 14 ----- .../examples/databases/delete-document.md | 15 ----- .../examples/databases/delete-index.md | 15 ----- .../server-swift/examples/databases/delete.md | 13 ----- .../examples/databases/get-attribute.md | 15 ----- .../examples/databases/get-collection.md | 14 ----- .../examples/databases/get-document.md | 16 ------ .../examples/databases/get-index.md | 15 ----- .../server-swift/examples/databases/get.md | 13 ----- .../examples/databases/list-attributes.md | 15 ----- .../examples/databases/list-collections.md | 15 ----- .../examples/databases/list-documents.md | 15 ----- .../examples/databases/list-indexes.md | 15 ----- .../server-swift/examples/databases/list.md | 14 ----- .../databases/update-boolean-attribute.md | 17 ------ .../examples/databases/update-collection.md | 18 ------ .../databases/update-datetime-attribute.md | 17 ------ .../examples/databases/update-document.md | 17 ------ .../databases/update-email-attribute.md | 17 ------ .../databases/update-enum-attribute.md | 18 ------ .../databases/update-float-attribute.md | 19 ------- .../databases/update-integer-attribute.md | 19 ------- .../examples/databases/update-ip-attribute.md | 17 ------ .../update-relationship-attribute.md | 17 ------ .../databases/update-string-attribute.md | 17 ------ .../databases/update-url-attribute.md | 17 ------ .../server-swift/examples/databases/update.md | 15 ----- .../examples/functions/create-build.md | 15 ----- .../examples/functions/create-deployment.md | 17 ------ .../examples/functions/create-execution.md | 20 ------- .../examples/functions/create-variable.md | 15 ----- .../server-swift/examples/functions/create.md | 34 ----------- .../examples/functions/delete-deployment.md | 14 ----- .../examples/functions/delete-execution.md | 14 ----- .../examples/functions/delete-variable.md | 14 ----- .../server-swift/examples/functions/delete.md | 13 ----- .../examples/functions/download-deployment.md | 14 ----- .../examples/functions/get-deployment.md | 14 ----- .../examples/functions/get-execution.md | 14 ----- .../examples/functions/get-variable.md | 14 ----- .../server-swift/examples/functions/get.md | 13 ----- .../examples/functions/list-deployments.md | 15 ----- .../examples/functions/list-executions.md | 15 ----- .../examples/functions/list-runtimes.md | 11 ---- .../examples/functions/list-variables.md | 13 ----- .../server-swift/examples/functions/list.md | 14 ----- .../functions/update-deployment-build.md | 14 ----- .../examples/functions/update-deployment.md | 14 ----- .../examples/functions/update-variable.md | 16 ------ .../server-swift/examples/functions/update.md | 30 ---------- .../server-swift/examples/graphql/mutation.md | 13 ----- .../server-swift/examples/graphql/query.md | 13 ----- .../examples/health/get-antivirus.md | 11 ---- .../server-swift/examples/health/get-cache.md | 11 ---- .../examples/health/get-certificate.md | 13 ----- .../server-swift/examples/health/get-d-b.md | 11 ---- .../examples/health/get-failed-jobs.md | 15 ----- .../examples/health/get-pub-sub.md | 11 ---- .../examples/health/get-queue-builds.md | 13 ----- .../examples/health/get-queue-certificates.md | 13 ----- .../examples/health/get-queue-databases.md | 14 ----- .../examples/health/get-queue-deletes.md | 13 ----- .../examples/health/get-queue-functions.md | 13 ----- .../examples/health/get-queue-logs.md | 13 ----- .../examples/health/get-queue-mails.md | 13 ----- .../examples/health/get-queue-messaging.md | 13 ----- .../examples/health/get-queue-migrations.md | 13 ----- .../examples/health/get-queue-usage-dump.md | 13 ----- .../examples/health/get-queue-usage.md | 13 ----- .../examples/health/get-queue-webhooks.md | 13 ----- .../server-swift/examples/health/get-queue.md | 11 ---- .../examples/health/get-storage-local.md | 11 ---- .../examples/health/get-storage.md | 11 ---- .../server-swift/examples/health/get-time.md | 11 ---- .../1.6.x/server-swift/examples/health/get.md | 11 ---- .../1.6.x/server-swift/examples/locale/get.md | 11 ---- .../examples/locale/list-codes.md | 11 ---- .../examples/locale/list-continents.md | 11 ---- .../examples/locale/list-countries-e-u.md | 11 ---- .../examples/locale/list-countries-phones.md | 11 ---- .../examples/locale/list-countries.md | 11 ---- .../examples/locale/list-currencies.md | 11 ---- .../examples/locale/list-languages.md | 11 ---- .../messaging/create-apns-provider.md | 20 ------- .../examples/messaging/create-email.md | 24 -------- .../examples/messaging/create-fcm-provider.md | 16 ------ .../messaging/create-mailgun-provider.md | 22 ------- .../messaging/create-msg91provider.md | 18 ------ .../examples/messaging/create-push.md | 28 --------- .../messaging/create-sendgrid-provider.md | 20 ------- .../examples/messaging/create-sms.md | 19 ------- .../messaging/create-smtp-provider.md | 27 --------- .../examples/messaging/create-subscriber.md | 15 ----- .../messaging/create-telesign-provider.md | 18 ------ .../messaging/create-textmagic-provider.md | 18 ------ .../examples/messaging/create-topic.md | 15 ----- .../messaging/create-twilio-provider.md | 18 ------ .../messaging/create-vonage-provider.md | 18 ------ .../examples/messaging/delete-provider.md | 13 ----- .../examples/messaging/delete-subscriber.md | 14 ----- .../examples/messaging/delete-topic.md | 13 ----- .../server-swift/examples/messaging/delete.md | 13 ----- .../examples/messaging/get-message.md | 13 ----- .../examples/messaging/get-provider.md | 13 ----- .../examples/messaging/get-subscriber.md | 14 ----- .../examples/messaging/get-topic.md | 13 ----- .../examples/messaging/list-message-logs.md | 14 ----- .../examples/messaging/list-messages.md | 14 ----- .../examples/messaging/list-provider-logs.md | 14 ----- .../examples/messaging/list-providers.md | 14 ----- .../messaging/list-subscriber-logs.md | 14 ----- .../examples/messaging/list-subscribers.md | 15 ----- .../examples/messaging/list-targets.md | 14 ----- .../examples/messaging/list-topic-logs.md | 14 ----- .../examples/messaging/list-topics.md | 14 ----- .../messaging/update-apns-provider.md | 20 ------- .../examples/messaging/update-email.md | 24 -------- .../examples/messaging/update-fcm-provider.md | 16 ------ .../messaging/update-mailgun-provider.md | 22 ------- .../messaging/update-msg91provider.md | 18 ------ .../examples/messaging/update-push.md | 28 --------- .../messaging/update-sendgrid-provider.md | 20 ------- .../examples/messaging/update-sms.md | 19 ------- .../messaging/update-smtp-provider.md | 27 --------- .../messaging/update-telesign-provider.md | 18 ------ .../messaging/update-textmagic-provider.md | 18 ------ .../examples/messaging/update-topic.md | 15 ----- .../messaging/update-twilio-provider.md | 18 ------ .../messaging/update-vonage-provider.md | 18 ------ .../examples/storage/create-bucket.md | 23 -------- .../examples/storage/create-file.md | 16 ------ .../examples/storage/delete-bucket.md | 13 ----- .../examples/storage/delete-file.md | 14 ----- .../examples/storage/get-bucket.md | 13 ----- .../examples/storage/get-file-download.md | 14 ----- .../examples/storage/get-file-preview.md | 26 --------- .../examples/storage/get-file-view.md | 14 ----- .../server-swift/examples/storage/get-file.md | 14 ----- .../examples/storage/list-buckets.md | 14 ----- .../examples/storage/list-files.md | 15 ----- .../examples/storage/update-bucket.md | 23 -------- .../examples/storage/update-file.md | 16 ------ .../examples/teams/create-membership.md | 19 ------- .../server-swift/examples/teams/create.md | 15 ----- .../examples/teams/delete-membership.md | 14 ----- .../server-swift/examples/teams/delete.md | 13 ----- .../examples/teams/get-membership.md | 14 ----- .../server-swift/examples/teams/get-prefs.md | 13 ----- .../1.6.x/server-swift/examples/teams/get.md | 13 ----- .../examples/teams/list-memberships.md | 15 ----- .../1.6.x/server-swift/examples/teams/list.md | 14 ----- .../teams/update-membership-status.md | 16 ------ .../examples/teams/update-membership.md | 15 ----- .../examples/teams/update-name.md | 14 ----- .../examples/teams/update-prefs.md | 14 ----- .../examples/users/create-argon2user.md | 16 ------ .../examples/users/create-bcrypt-user.md | 16 ------ .../examples/users/create-j-w-t.md | 15 ----- .../examples/users/create-m-d5user.md | 16 ------ .../users/create-mfa-recovery-codes.md | 13 ----- .../examples/users/create-p-h-pass-user.md | 16 ------ .../examples/users/create-s-h-a-user.md | 18 ------ .../users/create-scrypt-modified-user.md | 19 ------- .../examples/users/create-scrypt-user.md | 21 ------- .../examples/users/create-session.md | 13 ----- .../examples/users/create-target.md | 19 ------- .../examples/users/create-token.md | 15 ----- .../server-swift/examples/users/create.md | 17 ------ .../examples/users/delete-identity.md | 13 ----- .../users/delete-mfa-authenticator.md | 15 ----- .../examples/users/delete-session.md | 14 ----- .../examples/users/delete-sessions.md | 13 ----- .../examples/users/delete-target.md | 14 ----- .../server-swift/examples/users/delete.md | 13 ----- .../examples/users/get-mfa-recovery-codes.md | 13 ----- .../server-swift/examples/users/get-prefs.md | 13 ----- .../server-swift/examples/users/get-target.md | 14 ----- .../1.6.x/server-swift/examples/users/get.md | 13 ----- .../examples/users/list-identities.md | 14 ----- .../server-swift/examples/users/list-logs.md | 14 ----- .../examples/users/list-memberships.md | 13 ----- .../examples/users/list-mfa-factors.md | 13 ----- .../examples/users/list-sessions.md | 13 ----- .../examples/users/list-targets.md | 14 ----- .../1.6.x/server-swift/examples/users/list.md | 14 ----- .../users/update-email-verification.md | 14 ----- .../examples/users/update-email.md | 14 ----- .../examples/users/update-labels.md | 14 ----- .../users/update-mfa-recovery-codes.md | 13 ----- .../server-swift/examples/users/update-mfa.md | 14 ----- .../examples/users/update-name.md | 14 ----- .../examples/users/update-password.md | 14 ----- .../users/update-phone-verification.md | 14 ----- .../examples/users/update-phone.md | 14 ----- .../examples/users/update-prefs.md | 14 ----- .../examples/users/update-status.md | 14 ----- .../examples/users/update-target.md | 17 ------ 4623 files changed, 68170 deletions(-) delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-o-auth2session.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-push-target.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-session.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create-verification.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/create.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/delete-push-target.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/delete-session.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/get-session.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/get.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/list-identities.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/list-logs.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-email.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-name.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-password.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-phone.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-push-target.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-session.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-status.md delete mode 100644 docs/examples/1.6.x/client-android/java/account/update-verification.md delete mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/client-android/java/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/client-android/java/databases/create-document.md delete mode 100644 docs/examples/1.6.x/client-android/java/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/client-android/java/databases/get-document.md delete mode 100644 docs/examples/1.6.x/client-android/java/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/client-android/java/databases/update-document.md delete mode 100644 docs/examples/1.6.x/client-android/java/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/client-android/java/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/client-android/java/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/client-android/java/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/client-android/java/graphql/query.md delete mode 100644 docs/examples/1.6.x/client-android/java/locale/get.md delete mode 100644 docs/examples/1.6.x/client-android/java/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/client-android/java/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/client-android/java/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/client-android/java/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/client-android/java/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/client-android/java/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/client-android/java/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/client-android/java/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/client-android/java/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/client-android/java/storage/create-file.md delete mode 100644 docs/examples/1.6.x/client-android/java/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/client-android/java/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/client-android/java/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/client-android/java/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/client-android/java/storage/get-file.md delete mode 100644 docs/examples/1.6.x/client-android/java/storage/list-files.md delete mode 100644 docs/examples/1.6.x/client-android/java/storage/update-file.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/create.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/delete.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/get.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/list.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/update-name.md delete mode 100644 docs/examples/1.6.x/client-android/java/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2session.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-push-target.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-session.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create-verification.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/create.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/delete-push-target.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/delete-session.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/get-session.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/get.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/list-identities.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/list-logs.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-email.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-name.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-password.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-phone.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-push-target.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-session.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-status.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/account/update-verification.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/databases/create-document.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/databases/get-document.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/databases/update-document.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/graphql/query.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/get.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/create-file.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/get-file.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/list-files.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/storage/update-file.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/create.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/delete.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/get.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/list.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/update-name.md delete mode 100644 docs/examples/1.6.x/client-android/kotlin/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-o-auth2session.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-push-target.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/create.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/delete-push-target.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/get.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-push-target.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/client-apple/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2session.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-push-target.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/create.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/delete-push-target.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/get.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-push-target.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/client-flutter/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-push-target.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/create.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/delete-push-target.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/get.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-push-target.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/client-graphql/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2session.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-push-target.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/create.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/delete-push-target.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/get.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-push-target.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/client-react-native/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-o-auth2session.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-push-target.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/create.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/delete-push-target.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/get.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-push-target.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/client-rest/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-o-auth2session.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-push-target.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/create.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/delete-push-target.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/get.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-push-target.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/client-web/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/client-web/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/client-web/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/client-web/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/client-web/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/client-web/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/client-web/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/client-web/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/client-web/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/client-web/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/client-web/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/client-web/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/client-web/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/client-web/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/client-web/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/client-web/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/client-web/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/client-web/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/client-web/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/client-web/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/client-web/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/client-web/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/client-web/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/client-web/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/client-web/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-o-auth2session.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-push-target.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/create.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete-push-target.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/delete.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/get.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-push-target.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/assistant/chat.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/console/variables.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-collection-usage.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-database-usage.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get-usage.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-collection-logs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-document-logs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list-logs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get-function-usage.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get-usage.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/health/get.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/create-appwrite-migration.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-migration.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-o-auth-migration.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/create-n-host-migration.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/create-supabase-migration.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/delete-firebase-auth.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/delete.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get-appwrite-report.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report-o-auth.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get-n-host-report.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get-supabase-report.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/get.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/list-firebase-projects.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/list.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/migrations/retry.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/project/create-variable.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/project/delete-variable.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/project/get-usage.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/project/get-variable.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/project/list-variables.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/project/update-variable.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create-key.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create-platform.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create-smtp-test.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create-webhook.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/create.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete-email-template.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete-key.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete-platform.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete-sms-template.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete-webhook.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/delete.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get-email-template.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get-key.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get-platform.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get-sms-template.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get-webhook.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/get.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/list-keys.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/list-platforms.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/list-webhooks.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/list.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-api-status-all.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-api-status.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-duration.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-limit.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-dictionary.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-history.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-sessions-limit.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-auth-status.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-email-template.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-key.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-mock-numbers.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-o-auth2.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-personal-data-check.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-platform.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-service-status-all.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-service-status.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-session-alerts.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-sms-template.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-smtp.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-team.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-webhook-signature.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update-webhook.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/projects/update.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/proxy/create-rule.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/proxy/delete-rule.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/proxy/get-rule.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/proxy/list-rules.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/proxy/update-rule-verification.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-bucket-usage.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/get-usage.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/list-logs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/create.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/get-usage.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/get.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/list.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/users/update-target.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/create-repository-detection.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/create-repository.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/delete-installation.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/get-installation.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/get-repository-contents.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/get-repository.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/list-installations.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/list-repositories.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/list-repository-branches.md delete mode 100644 docs/examples/1.6.x/console-cli/examples/vcs/update-external-deployments.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-o-auth2session.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-push-target.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/create.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/delete-push-target.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/delete.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/get.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-push-target.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/console-web/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/console-web/examples/assistant/chat.md delete mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/console-web/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/console-web/examples/console/variables.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-collection-usage.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-database-usage.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/get-usage.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-collection-logs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-document-logs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/list-logs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/console-web/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/get-function-usage.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/get-usage.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/console-web/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/console-web/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/console-web/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/console-web/examples/health/get.md delete mode 100644 docs/examples/1.6.x/console-web/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/console-web/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/create-appwrite-migration.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/create-firebase-migration.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/create-firebase-o-auth-migration.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/create-n-host-migration.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/create-supabase-migration.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/delete-firebase-auth.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/delete.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get-appwrite-report.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report-o-auth.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get-n-host-report.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get-supabase-report.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/get.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/list-firebase-projects.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/list.md delete mode 100644 docs/examples/1.6.x/console-web/examples/migrations/retry.md delete mode 100644 docs/examples/1.6.x/console-web/examples/project/create-variable.md delete mode 100644 docs/examples/1.6.x/console-web/examples/project/delete-variable.md delete mode 100644 docs/examples/1.6.x/console-web/examples/project/get-usage.md delete mode 100644 docs/examples/1.6.x/console-web/examples/project/get-variable.md delete mode 100644 docs/examples/1.6.x/console-web/examples/project/list-variables.md delete mode 100644 docs/examples/1.6.x/console-web/examples/project/update-variable.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/create-key.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/create-platform.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/create-smtp-test.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/create-webhook.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/create.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete-email-template.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete-key.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete-platform.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete-sms-template.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete-webhook.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/delete.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/get-email-template.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/get-key.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/get-platform.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/get-sms-template.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/get-webhook.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/get.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/list-keys.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/list-platforms.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/list-webhooks.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/list.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-api-status-all.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-api-status.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-duration.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-limit.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-password-dictionary.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-password-history.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-sessions-limit.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-auth-status.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-email-template.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-key.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-mock-numbers.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-o-auth2.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-personal-data-check.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-platform.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-service-status-all.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-service-status.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-session-alerts.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-sms-template.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-smtp.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-team.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-webhook-signature.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update-webhook.md delete mode 100644 docs/examples/1.6.x/console-web/examples/projects/update.md delete mode 100644 docs/examples/1.6.x/console-web/examples/proxy/create-rule.md delete mode 100644 docs/examples/1.6.x/console-web/examples/proxy/delete-rule.md delete mode 100644 docs/examples/1.6.x/console-web/examples/proxy/get-rule.md delete mode 100644 docs/examples/1.6.x/console-web/examples/proxy/list-rules.md delete mode 100644 docs/examples/1.6.x/console-web/examples/proxy/update-rule-verification.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-bucket-usage.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/get-usage.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/console-web/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/list-logs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/console-web/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/create.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/get-usage.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/get.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/list.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/console-web/examples/users/update-target.md delete mode 100644 docs/examples/1.6.x/console-web/examples/vcs/create-repository-detection.md delete mode 100644 docs/examples/1.6.x/console-web/examples/vcs/create-repository.md delete mode 100644 docs/examples/1.6.x/console-web/examples/vcs/delete-installation.md delete mode 100644 docs/examples/1.6.x/console-web/examples/vcs/get-installation.md delete mode 100644 docs/examples/1.6.x/console-web/examples/vcs/get-repository-contents.md delete mode 100644 docs/examples/1.6.x/console-web/examples/vcs/get-repository.md delete mode 100644 docs/examples/1.6.x/console-web/examples/vcs/list-installations.md delete mode 100644 docs/examples/1.6.x/console-web/examples/vcs/list-repositories.md delete mode 100644 docs/examples/1.6.x/console-web/examples/vcs/list-repository-branches.md delete mode 100644 docs/examples/1.6.x/console-web/examples/vcs/update-external-deployments.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/create.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/get.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/health/get.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/create.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/get.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/list.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-dart/examples/users/update-target.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/create.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/get.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/health/get.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/create.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/get.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/list.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-deno/examples/users/update-target.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/create.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/get.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/health/get.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/create.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/get.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/list.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-dotnet/examples/users/update-target.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/create.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/get.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/health/get.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/create.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/get.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/list.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-graphql/examples/users/update-target.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/create.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/create.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/list.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/databases/update.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/create.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/list.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/functions/update.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/graphql/query.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/health/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/create.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/list.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/create.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/delete.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/list.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-kotlin/java/users/update-target.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/create.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/create.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/list.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/databases/update.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/create.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/list.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/functions/update.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/graphql/query.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/health/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/create.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/list.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/create.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/delete.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/get.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/list.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-kotlin/kotlin/users/update-target.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/create.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/get.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/health/get.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/create.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/get.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/list.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-nodejs/examples/users/update-target.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/create.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/get.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-php/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-php/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-php/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-php/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/server-php/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/server-php/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-php/examples/health/get.md delete mode 100644 docs/examples/1.6.x/server-php/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-php/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-php/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-php/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/create.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/get.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/list.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-php/examples/users/update-target.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/create.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/get.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-python/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-python/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-python/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-python/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/server-python/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/server-python/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-python/examples/health/get.md delete mode 100644 docs/examples/1.6.x/server-python/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-python/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-python/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-python/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/create.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/get.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/list.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-python/examples/users/update-target.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/create.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/get.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/health/get.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/create.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/get.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/list.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-rest/examples/users/update-target.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/create.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/get.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/health/get.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/create.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/get.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/list.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-ruby/examples/users/update-target.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-anonymous-session.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-email-password-session.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-email-token.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-magic-u-r-l-token.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-phone-token.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-recovery.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-session.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create-verification.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/create.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/delete-session.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/get-session.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/get.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/list-identities.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/list-logs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-email.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-m-f-a.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-magic-u-r-l-session.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-mfa-challenge.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-name.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-password.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-phone-session.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-phone.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-recovery.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-session.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-status.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/account/update-verification.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-browser.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-credit-card.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-favicon.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-flag.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-image.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-initials.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/avatars/get-q-r.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-collection.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-document.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-index.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/create.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/delete-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/delete-collection.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/delete-document.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/delete-index.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/delete.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/get-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/get-collection.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/get-document.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/get-index.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/get.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/list-attributes.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/list-collections.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/list-documents.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/list-indexes.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/list.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-boolean-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-collection.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-datetime-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-document.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-email-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-enum-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-float-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-integer-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-ip-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-relationship-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-string-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update-url-attribute.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/databases/update.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/create-build.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/create-deployment.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/create-execution.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/create-variable.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/create.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/delete-deployment.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/delete-execution.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/delete-variable.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/delete.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/download-deployment.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/get-deployment.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/get-execution.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/get-variable.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/get.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/list-deployments.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/list-executions.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/list-runtimes.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/list-variables.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/list.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/update-deployment-build.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/update-deployment.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/update-variable.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/functions/update.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/graphql/mutation.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/graphql/query.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-antivirus.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-cache.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-certificate.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-d-b.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-failed-jobs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-pub-sub.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-builds.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-certificates.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-databases.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-deletes.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-functions.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-logs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-mails.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-messaging.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-migrations.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-usage-dump.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-usage.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue-webhooks.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-queue.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-storage-local.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-storage.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get-time.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/health/get.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/locale/get.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-codes.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-continents.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-countries-e-u.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-countries-phones.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-countries.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-currencies.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/locale/list-languages.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-email.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-push.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-sms.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-subscriber.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-topic.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/create-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/delete-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/delete-subscriber.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/delete-topic.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/delete.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/get-message.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/get-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/get-subscriber.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/get-topic.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-message-logs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-messages.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-provider-logs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-providers.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-subscriber-logs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-subscribers.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-targets.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-topic-logs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/list-topics.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-apns-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-email.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-fcm-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-mailgun-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-msg91provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-push.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-sendgrid-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-sms.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-smtp-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-telesign-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-textmagic-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-topic.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-twilio-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/messaging/update-vonage-provider.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/create-bucket.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/create-file.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/delete-bucket.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/delete-file.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/get-bucket.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/get-file-download.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/get-file-preview.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/get-file-view.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/get-file.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/list-buckets.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/list-files.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/update-bucket.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/storage/update-file.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/create-membership.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/create.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/delete-membership.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/delete.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/get-membership.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/get.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/list.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/update-membership-status.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/update-membership.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/update-name.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/teams/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-argon2user.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-bcrypt-user.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-j-w-t.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-m-d5user.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-p-h-pass-user.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-s-h-a-user.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-scrypt-modified-user.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-scrypt-user.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-session.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-target.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create-token.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/create.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete-identity.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete-mfa-authenticator.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete-session.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete-sessions.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete-target.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/delete.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/get-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/get-prefs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/get-target.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/get.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-identities.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-logs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-memberships.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-mfa-factors.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-sessions.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/list-targets.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/list.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-email-verification.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-email.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-labels.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-mfa-recovery-codes.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-mfa.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-name.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-password.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-phone-verification.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-phone.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-prefs.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-status.md delete mode 100644 docs/examples/1.6.x/server-swift/examples/users/update-target.md diff --git a/docs/examples/1.6.x/client-android/java/account/create-anonymous-session.md b/docs/examples/1.6.x/client-android/java/account/create-anonymous-session.md deleted file mode 100644 index 5475d1bbd4..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-anonymous-session.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createAnonymousSession(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/create-email-password-session.md b/docs/examples/1.6.x/client-android/java/account/create-email-password-session.md deleted file mode 100644 index f4c59eb130..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-email-password-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createEmailPasswordSession( - "email@example.com", // email - "password", // password - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create-email-token.md b/docs/examples/1.6.x/client-android/java/account/create-email-token.md deleted file mode 100644 index d1b91c9419..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-email-token.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createEmailToken( - "<USER_ID>", // userId - "email@example.com", // email - false, // phrase (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create-j-w-t.md b/docs/examples/1.6.x/client-android/java/account/create-j-w-t.md deleted file mode 100644 index 481259e68c..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-j-w-t.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createJWT(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-android/java/account/create-magic-u-r-l-token.md deleted file mode 100644 index 3c91e9bf7e..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createMagicURLToken( - "<USER_ID>", // userId - "email@example.com", // email - "https://example.com", // url (optional) - false, // phrase (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-android/java/account/create-mfa-authenticator.md deleted file mode 100644 index 35ec26cfb5..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-mfa-authenticator.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; -import io.appwrite.enums.AuthenticatorType; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createMfaAuthenticator( - AuthenticatorType.TOTP, // type - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-android/java/account/create-mfa-challenge.md deleted file mode 100644 index f930b566de..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-mfa-challenge.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; -import io.appwrite.enums.AuthenticationFactor; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createMfaChallenge( - AuthenticationFactor.EMAIL, // factor - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/java/account/create-mfa-recovery-codes.md deleted file mode 100644 index 48f8582e96..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/create-o-auth2session.md b/docs/examples/1.6.x/client-android/java/account/create-o-auth2session.md deleted file mode 100644 index fafd8e1753..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-o-auth2session.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; -import io.appwrite.enums.OAuthProvider; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createOAuth2Session( - OAuthProvider.AMAZON, // provider - "https://example.com", // success (optional) - "https://example.com", // failure (optional) - listOf(), // scopes (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create-o-auth2token.md b/docs/examples/1.6.x/client-android/java/account/create-o-auth2token.md deleted file mode 100644 index 72fe76e6d7..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-o-auth2token.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; -import io.appwrite.enums.OAuthProvider; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createOAuth2Token( - OAuthProvider.AMAZON, // provider - "https://example.com", // success (optional) - "https://example.com", // failure (optional) - listOf(), // scopes (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create-phone-token.md b/docs/examples/1.6.x/client-android/java/account/create-phone-token.md deleted file mode 100644 index 92eeee8603..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-phone-token.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createPhoneToken( - "<USER_ID>", // userId - "+12065550100", // phone - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create-phone-verification.md b/docs/examples/1.6.x/client-android/java/account/create-phone-verification.md deleted file mode 100644 index c560065a05..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-phone-verification.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createPhoneVerification(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/create-push-target.md b/docs/examples/1.6.x/client-android/java/account/create-push-target.md deleted file mode 100644 index 127aec0506..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-push-target.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createPushTarget( - "<TARGET_ID>", // targetId - "<IDENTIFIER>", // identifier - "<PROVIDER_ID>", // providerId (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create-recovery.md b/docs/examples/1.6.x/client-android/java/account/create-recovery.md deleted file mode 100644 index 09f8fb9959..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-recovery.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createRecovery( - "email@example.com", // email - "https://example.com", // url - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create-session.md b/docs/examples/1.6.x/client-android/java/account/create-session.md deleted file mode 100644 index f54f57cc39..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createSession( - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create-verification.md b/docs/examples/1.6.x/client-android/java/account/create-verification.md deleted file mode 100644 index c52ee2bf3a..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create-verification.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createVerification( - "https://example.com", // url - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/create.md b/docs/examples/1.6.x/client-android/java/account/create.md deleted file mode 100644 index 15d9b73f1d..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/create.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.create( - "<USER_ID>", // userId - "email@example.com", // email - "", // password - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/delete-identity.md b/docs/examples/1.6.x/client-android/java/account/delete-identity.md deleted file mode 100644 index a84f57b263..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/delete-identity.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.deleteIdentity( - "<IDENTITY_ID>", // identityId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-android/java/account/delete-mfa-authenticator.md deleted file mode 100644 index b7c7442270..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; -import io.appwrite.enums.AuthenticatorType; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.deleteMfaAuthenticator( - AuthenticatorType.TOTP, // type - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/delete-push-target.md b/docs/examples/1.6.x/client-android/java/account/delete-push-target.md deleted file mode 100644 index 0b51801855..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/delete-push-target.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.deletePushTarget( - "<TARGET_ID>", // targetId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/delete-session.md b/docs/examples/1.6.x/client-android/java/account/delete-session.md deleted file mode 100644 index 602752ec7d..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/delete-session.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.deleteSession( - "<SESSION_ID>", // sessionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/delete-sessions.md b/docs/examples/1.6.x/client-android/java/account/delete-sessions.md deleted file mode 100644 index 8c48aaf1ec..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/delete-sessions.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.deleteSessions(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/java/account/get-mfa-recovery-codes.md deleted file mode 100644 index f42101c5d4..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.getMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/get-prefs.md b/docs/examples/1.6.x/client-android/java/account/get-prefs.md deleted file mode 100644 index 6a40dc7c4a..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/get-prefs.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.getPrefs(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/get-session.md b/docs/examples/1.6.x/client-android/java/account/get-session.md deleted file mode 100644 index 912a52dcb0..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/get-session.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.getSession( - "<SESSION_ID>", // sessionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/get.md b/docs/examples/1.6.x/client-android/java/account/get.md deleted file mode 100644 index 9a99a755ae..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/get.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.get(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/list-identities.md b/docs/examples/1.6.x/client-android/java/account/list-identities.md deleted file mode 100644 index 38ccc92562..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/list-identities.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.listIdentities( - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/list-logs.md b/docs/examples/1.6.x/client-android/java/account/list-logs.md deleted file mode 100644 index 7f39d843f2..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/list-logs.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.listLogs( - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/list-mfa-factors.md b/docs/examples/1.6.x/client-android/java/account/list-mfa-factors.md deleted file mode 100644 index f5319880d1..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/list-mfa-factors.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.listMfaFactors(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/list-sessions.md b/docs/examples/1.6.x/client-android/java/account/list-sessions.md deleted file mode 100644 index 6571458d97..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/list-sessions.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.listSessions(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/update-email.md b/docs/examples/1.6.x/client-android/java/account/update-email.md deleted file mode 100644 index 5e99b73045..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-email.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateEmail( - "email@example.com", // email - "password", // password - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-m-f-a.md b/docs/examples/1.6.x/client-android/java/account/update-m-f-a.md deleted file mode 100644 index f8420b0ccb..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-m-f-a.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateMFA( - false, // mfa - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-android/java/account/update-magic-u-r-l-session.md deleted file mode 100644 index 1d408270cb..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateMagicURLSession( - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-android/java/account/update-mfa-authenticator.md deleted file mode 100644 index 09506e5ca5..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-mfa-authenticator.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; -import io.appwrite.enums.AuthenticatorType; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateMfaAuthenticator( - AuthenticatorType.TOTP, // type - "<OTP>", // otp - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-android/java/account/update-mfa-challenge.md deleted file mode 100644 index 9fc3e39c36..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-mfa-challenge.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateMfaChallenge( - "<CHALLENGE_ID>", // challengeId - "<OTP>", // otp - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/java/account/update-mfa-recovery-codes.md deleted file mode 100644 index 36795a05ab..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/update-name.md b/docs/examples/1.6.x/client-android/java/account/update-name.md deleted file mode 100644 index f9a018503f..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-name.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateName( - "<NAME>", // name - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-password.md b/docs/examples/1.6.x/client-android/java/account/update-password.md deleted file mode 100644 index 676caad9ce..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-password.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updatePassword( - "", // password - "password", // oldPassword (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-phone-session.md b/docs/examples/1.6.x/client-android/java/account/update-phone-session.md deleted file mode 100644 index 5f9e43300a..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-phone-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updatePhoneSession( - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-phone-verification.md b/docs/examples/1.6.x/client-android/java/account/update-phone-verification.md deleted file mode 100644 index 739b6d88f4..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-phone-verification.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updatePhoneVerification( - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-phone.md b/docs/examples/1.6.x/client-android/java/account/update-phone.md deleted file mode 100644 index adbb0982fe..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-phone.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updatePhone( - "+12065550100", // phone - "password", // password - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-prefs.md b/docs/examples/1.6.x/client-android/java/account/update-prefs.md deleted file mode 100644 index ad42651c8e..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-prefs.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updatePrefs( - mapOf( "a" to "b" ), // prefs - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-push-target.md b/docs/examples/1.6.x/client-android/java/account/update-push-target.md deleted file mode 100644 index 735757202d..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-push-target.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updatePushTarget( - "<TARGET_ID>", // targetId - "<IDENTIFIER>", // identifier - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-recovery.md b/docs/examples/1.6.x/client-android/java/account/update-recovery.md deleted file mode 100644 index f8067d09cf..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-recovery.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateRecovery( - "<USER_ID>", // userId - "<SECRET>", // secret - "", // password - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-session.md b/docs/examples/1.6.x/client-android/java/account/update-session.md deleted file mode 100644 index 2b6df41bbc..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-session.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateSession( - "<SESSION_ID>", // sessionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/account/update-status.md b/docs/examples/1.6.x/client-android/java/account/update-status.md deleted file mode 100644 index 38cf5cfdf9..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-status.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateStatus(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/account/update-verification.md b/docs/examples/1.6.x/client-android/java/account/update-verification.md deleted file mode 100644 index 8cfbbb69d7..0000000000 --- a/docs/examples/1.6.x/client-android/java/account/update-verification.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateVerification( - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-browser.md b/docs/examples/1.6.x/client-android/java/avatars/get-browser.md deleted file mode 100644 index a11df7e31b..0000000000 --- a/docs/examples/1.6.x/client-android/java/avatars/get-browser.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; -import io.appwrite.enums.Browser; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Avatars avatars = new Avatars(client); - -avatars.getBrowser( - Browser.AVANT_BROWSER, // code - 0, // width (optional) - 0, // height (optional) - 0, // quality (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-credit-card.md b/docs/examples/1.6.x/client-android/java/avatars/get-credit-card.md deleted file mode 100644 index f1e2b392da..0000000000 --- a/docs/examples/1.6.x/client-android/java/avatars/get-credit-card.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; -import io.appwrite.enums.CreditCard; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Avatars avatars = new Avatars(client); - -avatars.getCreditCard( - CreditCard.AMERICAN_EXPRESS, // code - 0, // width (optional) - 0, // height (optional) - 0, // quality (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-favicon.md b/docs/examples/1.6.x/client-android/java/avatars/get-favicon.md deleted file mode 100644 index 5cfd60b86a..0000000000 --- a/docs/examples/1.6.x/client-android/java/avatars/get-favicon.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Avatars avatars = new Avatars(client); - -avatars.getFavicon( - "https://example.com", // url - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-flag.md b/docs/examples/1.6.x/client-android/java/avatars/get-flag.md deleted file mode 100644 index 492ecc0410..0000000000 --- a/docs/examples/1.6.x/client-android/java/avatars/get-flag.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; -import io.appwrite.enums.Flag; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Avatars avatars = new Avatars(client); - -avatars.getFlag( - Flag.AFGHANISTAN, // code - 0, // width (optional) - 0, // height (optional) - 0, // quality (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-image.md b/docs/examples/1.6.x/client-android/java/avatars/get-image.md deleted file mode 100644 index 4fc1e35f35..0000000000 --- a/docs/examples/1.6.x/client-android/java/avatars/get-image.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Avatars avatars = new Avatars(client); - -avatars.getImage( - "https://example.com", // url - 0, // width (optional) - 0, // height (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-initials.md b/docs/examples/1.6.x/client-android/java/avatars/get-initials.md deleted file mode 100644 index 9b286089ed..0000000000 --- a/docs/examples/1.6.x/client-android/java/avatars/get-initials.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Avatars avatars = new Avatars(client); - -avatars.getInitials( - "<NAME>", // name (optional) - 0, // width (optional) - 0, // height (optional) - "", // background (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/avatars/get-q-r.md b/docs/examples/1.6.x/client-android/java/avatars/get-q-r.md deleted file mode 100644 index 29446d54d7..0000000000 --- a/docs/examples/1.6.x/client-android/java/avatars/get-q-r.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Avatars avatars = new Avatars(client); - -avatars.getQR( - "<TEXT>", // text - 1, // size (optional) - 0, // margin (optional) - false, // download (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/databases/create-document.md b/docs/examples/1.6.x/client-android/java/databases/create-document.md deleted file mode 100644 index 87d33bdc60..0000000000 --- a/docs/examples/1.6.x/client-android/java/databases/create-document.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Databases databases = new Databases(client); - -databases.createDocument( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "<DOCUMENT_ID>", // documentId - mapOf( "a" to "b" ), // data - listOf("read("any")"), // permissions (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/databases/delete-document.md b/docs/examples/1.6.x/client-android/java/databases/delete-document.md deleted file mode 100644 index 2fb3accf32..0000000000 --- a/docs/examples/1.6.x/client-android/java/databases/delete-document.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Databases databases = new Databases(client); - -databases.deleteDocument( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "<DOCUMENT_ID>", // documentId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/databases/get-document.md b/docs/examples/1.6.x/client-android/java/databases/get-document.md deleted file mode 100644 index 0edce73467..0000000000 --- a/docs/examples/1.6.x/client-android/java/databases/get-document.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Databases databases = new Databases(client); - -databases.getDocument( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "<DOCUMENT_ID>", // documentId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/databases/list-documents.md b/docs/examples/1.6.x/client-android/java/databases/list-documents.md deleted file mode 100644 index f256e1413c..0000000000 --- a/docs/examples/1.6.x/client-android/java/databases/list-documents.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Databases databases = new Databases(client); - -databases.listDocuments( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/databases/update-document.md b/docs/examples/1.6.x/client-android/java/databases/update-document.md deleted file mode 100644 index 16f89df2c8..0000000000 --- a/docs/examples/1.6.x/client-android/java/databases/update-document.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Databases databases = new Databases(client); - -databases.updateDocument( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "<DOCUMENT_ID>", // documentId - mapOf( "a" to "b" ), // data (optional) - listOf("read("any")"), // permissions (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/functions/create-execution.md b/docs/examples/1.6.x/client-android/java/functions/create-execution.md deleted file mode 100644 index 5d4cc4d3bf..0000000000 --- a/docs/examples/1.6.x/client-android/java/functions/create-execution.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Functions functions = new Functions(client); - -functions.createExecution( - "<FUNCTION_ID>", // functionId - "<BODY>", // body (optional) - false, // async (optional) - "<PATH>", // path (optional) - ExecutionMethod.GET, // method (optional) - mapOf( "a" to "b" ), // headers (optional) - "", // scheduledAt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/functions/get-execution.md b/docs/examples/1.6.x/client-android/java/functions/get-execution.md deleted file mode 100644 index 82314451cb..0000000000 --- a/docs/examples/1.6.x/client-android/java/functions/get-execution.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Functions functions = new Functions(client); - -functions.getExecution( - "<FUNCTION_ID>", // functionId - "<EXECUTION_ID>", // executionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/functions/list-executions.md b/docs/examples/1.6.x/client-android/java/functions/list-executions.md deleted file mode 100644 index ac793fa789..0000000000 --- a/docs/examples/1.6.x/client-android/java/functions/list-executions.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Functions functions = new Functions(client); - -functions.listExecutions( - "<FUNCTION_ID>", // functionId - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/graphql/mutation.md b/docs/examples/1.6.x/client-android/java/graphql/mutation.md deleted file mode 100644 index 5e49fcb848..0000000000 --- a/docs/examples/1.6.x/client-android/java/graphql/mutation.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Graphql; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Graphql graphql = new Graphql(client); - -graphql.mutation( - mapOf( "a" to "b" ), // query - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/graphql/query.md b/docs/examples/1.6.x/client-android/java/graphql/query.md deleted file mode 100644 index 2d39c167c7..0000000000 --- a/docs/examples/1.6.x/client-android/java/graphql/query.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Graphql; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Graphql graphql = new Graphql(client); - -graphql.query( - mapOf( "a" to "b" ), // query - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/locale/get.md b/docs/examples/1.6.x/client-android/java/locale/get.md deleted file mode 100644 index 4883b2191a..0000000000 --- a/docs/examples/1.6.x/client-android/java/locale/get.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Locale locale = new Locale(client); - -locale.get(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-codes.md b/docs/examples/1.6.x/client-android/java/locale/list-codes.md deleted file mode 100644 index caddf6c6f6..0000000000 --- a/docs/examples/1.6.x/client-android/java/locale/list-codes.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Locale locale = new Locale(client); - -locale.listCodes(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-continents.md b/docs/examples/1.6.x/client-android/java/locale/list-continents.md deleted file mode 100644 index 634f471d77..0000000000 --- a/docs/examples/1.6.x/client-android/java/locale/list-continents.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Locale locale = new Locale(client); - -locale.listContinents(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-android/java/locale/list-countries-e-u.md deleted file mode 100644 index 798ea3464b..0000000000 --- a/docs/examples/1.6.x/client-android/java/locale/list-countries-e-u.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Locale locale = new Locale(client); - -locale.listCountriesEU(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-countries-phones.md b/docs/examples/1.6.x/client-android/java/locale/list-countries-phones.md deleted file mode 100644 index 08285470f3..0000000000 --- a/docs/examples/1.6.x/client-android/java/locale/list-countries-phones.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Locale locale = new Locale(client); - -locale.listCountriesPhones(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-countries.md b/docs/examples/1.6.x/client-android/java/locale/list-countries.md deleted file mode 100644 index b56ab5c5c3..0000000000 --- a/docs/examples/1.6.x/client-android/java/locale/list-countries.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Locale locale = new Locale(client); - -locale.listCountries(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-currencies.md b/docs/examples/1.6.x/client-android/java/locale/list-currencies.md deleted file mode 100644 index ab014b5f95..0000000000 --- a/docs/examples/1.6.x/client-android/java/locale/list-currencies.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Locale locale = new Locale(client); - -locale.listCurrencies(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/locale/list-languages.md b/docs/examples/1.6.x/client-android/java/locale/list-languages.md deleted file mode 100644 index 8ef5723a5d..0000000000 --- a/docs/examples/1.6.x/client-android/java/locale/list-languages.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Locale locale = new Locale(client); - -locale.listLanguages(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); -})); diff --git a/docs/examples/1.6.x/client-android/java/messaging/create-subscriber.md b/docs/examples/1.6.x/client-android/java/messaging/create-subscriber.md deleted file mode 100644 index d1ea18b5e4..0000000000 --- a/docs/examples/1.6.x/client-android/java/messaging/create-subscriber.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Messaging messaging = new Messaging(client); - -messaging.createSubscriber( - "<TOPIC_ID>", // topicId - "<SUBSCRIBER_ID>", // subscriberId - "<TARGET_ID>", // targetId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-android/java/messaging/delete-subscriber.md deleted file mode 100644 index 5fa1b57955..0000000000 --- a/docs/examples/1.6.x/client-android/java/messaging/delete-subscriber.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Messaging messaging = new Messaging(client); - -messaging.deleteSubscriber( - "<TOPIC_ID>", // topicId - "<SUBSCRIBER_ID>", // subscriberId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/storage/create-file.md b/docs/examples/1.6.x/client-android/java/storage/create-file.md deleted file mode 100644 index 716ef6ca39..0000000000 --- a/docs/examples/1.6.x/client-android/java/storage/create-file.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.models.InputFile; -import io.appwrite.services.Storage; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Storage storage = new Storage(client); - -storage.createFile( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - InputFile.fromPath("file.png"), // file - listOf("read("any")"), // permissions (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/storage/delete-file.md b/docs/examples/1.6.x/client-android/java/storage/delete-file.md deleted file mode 100644 index e4b4a2bfbe..0000000000 --- a/docs/examples/1.6.x/client-android/java/storage/delete-file.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Storage storage = new Storage(client); - -storage.deleteFile( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/storage/get-file-download.md b/docs/examples/1.6.x/client-android/java/storage/get-file-download.md deleted file mode 100644 index 304bbfea96..0000000000 --- a/docs/examples/1.6.x/client-android/java/storage/get-file-download.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Storage storage = new Storage(client); - -storage.getFileDownload( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/storage/get-file-preview.md b/docs/examples/1.6.x/client-android/java/storage/get-file-preview.md deleted file mode 100644 index 267b16f4e7..0000000000 --- a/docs/examples/1.6.x/client-android/java/storage/get-file-preview.md +++ /dev/null @@ -1,34 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Storage storage = new Storage(client); - -storage.getFilePreview( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - 0, // width (optional) - 0, // height (optional) - ImageGravity.CENTER, // gravity (optional) - 0, // quality (optional) - 0, // borderWidth (optional) - "", // borderColor (optional) - 0, // borderRadius (optional) - 0, // opacity (optional) - -360, // rotation (optional) - "", // background (optional) - ImageFormat.JPG, // output (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/storage/get-file-view.md b/docs/examples/1.6.x/client-android/java/storage/get-file-view.md deleted file mode 100644 index ae40098548..0000000000 --- a/docs/examples/1.6.x/client-android/java/storage/get-file-view.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Storage storage = new Storage(client); - -storage.getFileView( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/storage/get-file.md b/docs/examples/1.6.x/client-android/java/storage/get-file.md deleted file mode 100644 index 86118c04d5..0000000000 --- a/docs/examples/1.6.x/client-android/java/storage/get-file.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Storage storage = new Storage(client); - -storage.getFile( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/storage/list-files.md b/docs/examples/1.6.x/client-android/java/storage/list-files.md deleted file mode 100644 index 3ef0aceb46..0000000000 --- a/docs/examples/1.6.x/client-android/java/storage/list-files.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Storage storage = new Storage(client); - -storage.listFiles( - "<BUCKET_ID>", // bucketId - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/storage/update-file.md b/docs/examples/1.6.x/client-android/java/storage/update-file.md deleted file mode 100644 index 6a90a6170b..0000000000 --- a/docs/examples/1.6.x/client-android/java/storage/update-file.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Storage storage = new Storage(client); - -storage.updateFile( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - "<NAME>", // name (optional) - listOf("read("any")"), // permissions (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/create-membership.md b/docs/examples/1.6.x/client-android/java/teams/create-membership.md deleted file mode 100644 index bca117a452..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/create-membership.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.createMembership( - "<TEAM_ID>", // teamId - listOf(), // roles - "email@example.com", // email (optional) - "<USER_ID>", // userId (optional) - "+12065550100", // phone (optional) - "https://example.com", // url (optional) - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/create.md b/docs/examples/1.6.x/client-android/java/teams/create.md deleted file mode 100644 index 6644e24580..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/create.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.create( - "<TEAM_ID>", // teamId - "<NAME>", // name - listOf(), // roles (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/delete-membership.md b/docs/examples/1.6.x/client-android/java/teams/delete-membership.md deleted file mode 100644 index 953f4615d7..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/delete-membership.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.deleteMembership( - "<TEAM_ID>", // teamId - "<MEMBERSHIP_ID>", // membershipId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/delete.md b/docs/examples/1.6.x/client-android/java/teams/delete.md deleted file mode 100644 index d4b6076903..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/delete.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.delete( - "<TEAM_ID>", // teamId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/get-membership.md b/docs/examples/1.6.x/client-android/java/teams/get-membership.md deleted file mode 100644 index 425e6f3028..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/get-membership.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.getMembership( - "<TEAM_ID>", // teamId - "<MEMBERSHIP_ID>", // membershipId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/get-prefs.md b/docs/examples/1.6.x/client-android/java/teams/get-prefs.md deleted file mode 100644 index a36be581c6..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/get-prefs.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.getPrefs( - "<TEAM_ID>", // teamId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/get.md b/docs/examples/1.6.x/client-android/java/teams/get.md deleted file mode 100644 index 7ecfbab1cb..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/get.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.get( - "<TEAM_ID>", // teamId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/list-memberships.md b/docs/examples/1.6.x/client-android/java/teams/list-memberships.md deleted file mode 100644 index 6a7e056d72..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/list-memberships.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.listMemberships( - "<TEAM_ID>", // teamId - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/list.md b/docs/examples/1.6.x/client-android/java/teams/list.md deleted file mode 100644 index 94b65d6909..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/list.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.list( - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/update-membership-status.md b/docs/examples/1.6.x/client-android/java/teams/update-membership-status.md deleted file mode 100644 index ffb722a07c..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/update-membership-status.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.updateMembershipStatus( - "<TEAM_ID>", // teamId - "<MEMBERSHIP_ID>", // membershipId - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/update-membership.md b/docs/examples/1.6.x/client-android/java/teams/update-membership.md deleted file mode 100644 index 478a94d6db..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/update-membership.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.updateMembership( - "<TEAM_ID>", // teamId - "<MEMBERSHIP_ID>", // membershipId - listOf(), // roles - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/update-name.md b/docs/examples/1.6.x/client-android/java/teams/update-name.md deleted file mode 100644 index 219bece350..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/update-name.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.updateName( - "<TEAM_ID>", // teamId - "<NAME>", // name - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/java/teams/update-prefs.md b/docs/examples/1.6.x/client-android/java/teams/update-prefs.md deleted file mode 100644 index e4fb344d18..0000000000 --- a/docs/examples/1.6.x/client-android/java/teams/update-prefs.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Teams teams = new Teams(client); - -teams.updatePrefs( - "<TEAM_ID>", // teamId - mapOf( "a" to "b" ), // prefs - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - Log.d("Appwrite", result.toString()); - }) -); - diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-anonymous-session.md b/docs/examples/1.6.x/client-android/kotlin/account/create-anonymous-session.md deleted file mode 100644 index 6731b6c067..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-anonymous-session.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createAnonymousSession() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-email-password-session.md b/docs/examples/1.6.x/client-android/kotlin/account/create-email-password-session.md deleted file mode 100644 index 88123a5c96..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-email-password-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createEmailPasswordSession( - email = "email@example.com", - password = "password", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-email-token.md b/docs/examples/1.6.x/client-android/kotlin/account/create-email-token.md deleted file mode 100644 index adaa5eb7e6..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-email-token.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createEmailToken( - userId = "<USER_ID>", - email = "email@example.com", - phrase = false, // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-j-w-t.md b/docs/examples/1.6.x/client-android/kotlin/account/create-j-w-t.md deleted file mode 100644 index 34e6b1ae51..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-j-w-t.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createJWT() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-android/kotlin/account/create-magic-u-r-l-token.md deleted file mode 100644 index 10c9427f5e..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createMagicURLToken( - userId = "<USER_ID>", - email = "email@example.com", - url = "https://example.com", // (optional) - phrase = false, // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-authenticator.md deleted file mode 100644 index 2b60be3878..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-authenticator.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account -import io.appwrite.enums.AuthenticatorType - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createMfaAuthenticator( - type = AuthenticatorType.TOTP, -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-challenge.md deleted file mode 100644 index f7554de2fc..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-challenge.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account -import io.appwrite.enums.AuthenticationFactor - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createMfaChallenge( - factor = AuthenticationFactor.EMAIL, -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-recovery-codes.md deleted file mode 100644 index 5618b3baa4..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2session.md b/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2session.md deleted file mode 100644 index e2aebc9c88..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2session.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account -import io.appwrite.enums.OAuthProvider - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -account.createOAuth2Session( - provider = OAuthProvider.AMAZON, - success = "https://example.com", // (optional) - failure = "https://example.com", // (optional) - scopes = listOf(), // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2token.md b/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2token.md deleted file mode 100644 index 71e58db6a3..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-o-auth2token.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account -import io.appwrite.enums.OAuthProvider - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -account.createOAuth2Token( - provider = OAuthProvider.AMAZON, - success = "https://example.com", // (optional) - failure = "https://example.com", // (optional) - scopes = listOf(), // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-phone-token.md b/docs/examples/1.6.x/client-android/kotlin/account/create-phone-token.md deleted file mode 100644 index 16e744c889..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-phone-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createPhoneToken( - userId = "<USER_ID>", - phone = "+12065550100", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-phone-verification.md b/docs/examples/1.6.x/client-android/kotlin/account/create-phone-verification.md deleted file mode 100644 index 74a05a0187..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-phone-verification.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createPhoneVerification() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-push-target.md b/docs/examples/1.6.x/client-android/kotlin/account/create-push-target.md deleted file mode 100644 index 80b8221112..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-push-target.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createPushTarget( - targetId = "<TARGET_ID>", - identifier = "<IDENTIFIER>", - providerId = "<PROVIDER_ID>", // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-recovery.md b/docs/examples/1.6.x/client-android/kotlin/account/create-recovery.md deleted file mode 100644 index 9b4f0dbf1f..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createRecovery( - email = "email@example.com", - url = "https://example.com", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-session.md b/docs/examples/1.6.x/client-android/kotlin/account/create-session.md deleted file mode 100644 index 8eab36b3bb..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createSession( - userId = "<USER_ID>", - secret = "<SECRET>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create-verification.md b/docs/examples/1.6.x/client-android/kotlin/account/create-verification.md deleted file mode 100644 index 5c2d869b98..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.createVerification( - url = "https://example.com", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/create.md b/docs/examples/1.6.x/client-android/kotlin/account/create.md deleted file mode 100644 index 27079085a2..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/create.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.create( - userId = "<USER_ID>", - email = "email@example.com", - password = "", - name = "<NAME>", // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/delete-identity.md b/docs/examples/1.6.x/client-android/kotlin/account/delete-identity.md deleted file mode 100644 index decb1b0402..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/delete-identity.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.deleteIdentity( - identityId = "<IDENTITY_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-android/kotlin/account/delete-mfa-authenticator.md deleted file mode 100644 index a9a9fd8eab..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account -import io.appwrite.enums.AuthenticatorType - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.deleteMfaAuthenticator( - type = AuthenticatorType.TOTP, -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/delete-push-target.md b/docs/examples/1.6.x/client-android/kotlin/account/delete-push-target.md deleted file mode 100644 index a1e5519b67..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/delete-push-target.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.deletePushTarget( - targetId = "<TARGET_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/delete-session.md b/docs/examples/1.6.x/client-android/kotlin/account/delete-session.md deleted file mode 100644 index 4d49833c88..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/delete-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.deleteSession( - sessionId = "<SESSION_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/delete-sessions.md b/docs/examples/1.6.x/client-android/kotlin/account/delete-sessions.md deleted file mode 100644 index d8bf87189a..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/delete-sessions.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.deleteSessions() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/kotlin/account/get-mfa-recovery-codes.md deleted file mode 100644 index bdd2908601..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.getMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/get-prefs.md b/docs/examples/1.6.x/client-android/kotlin/account/get-prefs.md deleted file mode 100644 index a4fefc5150..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/get-prefs.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.getPrefs() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/get-session.md b/docs/examples/1.6.x/client-android/kotlin/account/get-session.md deleted file mode 100644 index b18c532175..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/get-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.getSession( - sessionId = "<SESSION_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/get.md b/docs/examples/1.6.x/client-android/kotlin/account/get.md deleted file mode 100644 index 1718bdd0c3..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.get() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/list-identities.md b/docs/examples/1.6.x/client-android/kotlin/account/list-identities.md deleted file mode 100644 index e553a88818..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/list-identities.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.listIdentities( - queries = listOf(), // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/list-logs.md b/docs/examples/1.6.x/client-android/kotlin/account/list-logs.md deleted file mode 100644 index 2ee8214336..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/list-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.listLogs( - queries = listOf(), // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/list-mfa-factors.md b/docs/examples/1.6.x/client-android/kotlin/account/list-mfa-factors.md deleted file mode 100644 index eddefdc88c..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/list-mfa-factors.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.listMfaFactors() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/list-sessions.md b/docs/examples/1.6.x/client-android/kotlin/account/list-sessions.md deleted file mode 100644 index b4841445d5..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/list-sessions.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.listSessions() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-email.md b/docs/examples/1.6.x/client-android/kotlin/account/update-email.md deleted file mode 100644 index b8f759f9eb..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-email.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updateEmail( - email = "email@example.com", - password = "password", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-m-f-a.md b/docs/examples/1.6.x/client-android/kotlin/account/update-m-f-a.md deleted file mode 100644 index 8940cf4743..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-m-f-a.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updateMFA( - mfa = false, -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-android/kotlin/account/update-magic-u-r-l-session.md deleted file mode 100644 index 09029e4070..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updateMagicURLSession( - userId = "<USER_ID>", - secret = "<SECRET>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-authenticator.md deleted file mode 100644 index 5889931a21..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-authenticator.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account -import io.appwrite.enums.AuthenticatorType - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updateMfaAuthenticator( - type = AuthenticatorType.TOTP, - otp = "<OTP>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-challenge.md deleted file mode 100644 index d63401b283..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-challenge.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updateMfaChallenge( - challengeId = "<CHALLENGE_ID>", - otp = "<OTP>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-recovery-codes.md deleted file mode 100644 index 69b41c9224..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updateMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-name.md b/docs/examples/1.6.x/client-android/kotlin/account/update-name.md deleted file mode 100644 index 6658a1b3fc..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updateName( - name = "<NAME>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-password.md b/docs/examples/1.6.x/client-android/kotlin/account/update-password.md deleted file mode 100644 index fe3b8ceb06..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-password.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updatePassword( - password = "", - oldPassword = "password", // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-phone-session.md b/docs/examples/1.6.x/client-android/kotlin/account/update-phone-session.md deleted file mode 100644 index 7414b2e0c0..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-phone-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updatePhoneSession( - userId = "<USER_ID>", - secret = "<SECRET>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-phone-verification.md b/docs/examples/1.6.x/client-android/kotlin/account/update-phone-verification.md deleted file mode 100644 index e1b264bbde..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-phone-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updatePhoneVerification( - userId = "<USER_ID>", - secret = "<SECRET>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-phone.md b/docs/examples/1.6.x/client-android/kotlin/account/update-phone.md deleted file mode 100644 index c4ae4f5ea4..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-phone.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updatePhone( - phone = "+12065550100", - password = "password", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-prefs.md b/docs/examples/1.6.x/client-android/kotlin/account/update-prefs.md deleted file mode 100644 index 62129a298e..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updatePrefs( - prefs = mapOf( "a" to "b" ), -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-push-target.md b/docs/examples/1.6.x/client-android/kotlin/account/update-push-target.md deleted file mode 100644 index 8dfa97c767..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-push-target.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updatePushTarget( - targetId = "<TARGET_ID>", - identifier = "<IDENTIFIER>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-recovery.md b/docs/examples/1.6.x/client-android/kotlin/account/update-recovery.md deleted file mode 100644 index 6c83496584..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-recovery.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updateRecovery( - userId = "<USER_ID>", - secret = "<SECRET>", - password = "", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-session.md b/docs/examples/1.6.x/client-android/kotlin/account/update-session.md deleted file mode 100644 index 85dec29278..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updateSession( - sessionId = "<SESSION_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-status.md b/docs/examples/1.6.x/client-android/kotlin/account/update-status.md deleted file mode 100644 index 4bf9faf07f..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-status.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updateStatus() diff --git a/docs/examples/1.6.x/client-android/kotlin/account/update-verification.md b/docs/examples/1.6.x/client-android/kotlin/account/update-verification.md deleted file mode 100644 index 4bd5459a6c..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/account/update-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val result = account.updateVerification( - userId = "<USER_ID>", - secret = "<SECRET>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-browser.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-browser.md deleted file mode 100644 index 6f2a45cd3f..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/avatars/get-browser.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars -import io.appwrite.enums.Browser - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val avatars = Avatars(client) - -val result = avatars.getBrowser( - code = Browser.AVANT_BROWSER, - width = 0, // (optional) - height = 0, // (optional) - quality = 0, // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-credit-card.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-credit-card.md deleted file mode 100644 index a85c8c8638..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/avatars/get-credit-card.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars -import io.appwrite.enums.CreditCard - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val avatars = Avatars(client) - -val result = avatars.getCreditCard( - code = CreditCard.AMERICAN_EXPRESS, - width = 0, // (optional) - height = 0, // (optional) - quality = 0, // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-favicon.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-favicon.md deleted file mode 100644 index eee47e1dca..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/avatars/get-favicon.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val avatars = Avatars(client) - -val result = avatars.getFavicon( - url = "https://example.com", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-flag.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-flag.md deleted file mode 100644 index 0689ba13cd..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/avatars/get-flag.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars -import io.appwrite.enums.Flag - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val avatars = Avatars(client) - -val result = avatars.getFlag( - code = Flag.AFGHANISTAN, - width = 0, // (optional) - height = 0, // (optional) - quality = 0, // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-image.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-image.md deleted file mode 100644 index 7042757e73..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/avatars/get-image.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val avatars = Avatars(client) - -val result = avatars.getImage( - url = "https://example.com", - width = 0, // (optional) - height = 0, // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-initials.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-initials.md deleted file mode 100644 index fd52a3b0a7..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/avatars/get-initials.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val avatars = Avatars(client) - -val result = avatars.getInitials( - name = "<NAME>", // (optional) - width = 0, // (optional) - height = 0, // (optional) - background = "", // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/avatars/get-q-r.md b/docs/examples/1.6.x/client-android/kotlin/avatars/get-q-r.md deleted file mode 100644 index 3be18c159a..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/avatars/get-q-r.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val avatars = Avatars(client) - -val result = avatars.getQR( - text = "<TEXT>", - size = 1, // (optional) - margin = 0, // (optional) - download = false, // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/databases/create-document.md b/docs/examples/1.6.x/client-android/kotlin/databases/create-document.md deleted file mode 100644 index 69c17efd1c..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/databases/create-document.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val databases = Databases(client) - -val result = databases.createDocument( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - documentId = "<DOCUMENT_ID>", - data = mapOf( "a" to "b" ), - permissions = listOf("read("any")"), // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/databases/delete-document.md b/docs/examples/1.6.x/client-android/kotlin/databases/delete-document.md deleted file mode 100644 index 3733e2f28a..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/databases/delete-document.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val databases = Databases(client) - -val result = databases.deleteDocument( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - documentId = "<DOCUMENT_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/databases/get-document.md b/docs/examples/1.6.x/client-android/kotlin/databases/get-document.md deleted file mode 100644 index a11de0e6ce..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/databases/get-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val databases = Databases(client) - -val result = databases.getDocument( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - documentId = "<DOCUMENT_ID>", - queries = listOf(), // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/databases/list-documents.md b/docs/examples/1.6.x/client-android/kotlin/databases/list-documents.md deleted file mode 100644 index 6615d443ac..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/databases/list-documents.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val databases = Databases(client) - -val result = databases.listDocuments( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - queries = listOf(), // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/databases/update-document.md b/docs/examples/1.6.x/client-android/kotlin/databases/update-document.md deleted file mode 100644 index 5f9aab2c43..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/databases/update-document.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val databases = Databases(client) - -val result = databases.updateDocument( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - documentId = "<DOCUMENT_ID>", - data = mapOf( "a" to "b" ), // (optional) - permissions = listOf("read("any")"), // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/functions/create-execution.md b/docs/examples/1.6.x/client-android/kotlin/functions/create-execution.md deleted file mode 100644 index e4ddc6a7e5..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/functions/create-execution.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val functions = Functions(client) - -val result = functions.createExecution( - functionId = "<FUNCTION_ID>", - body = "<BODY>", // (optional) - async = false, // (optional) - path = "<PATH>", // (optional) - method = ExecutionMethod.GET, // (optional) - headers = mapOf( "a" to "b" ), // (optional) - scheduledAt = "", // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/functions/get-execution.md b/docs/examples/1.6.x/client-android/kotlin/functions/get-execution.md deleted file mode 100644 index 6ca4bed8ad..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/functions/get-execution.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val functions = Functions(client) - -val result = functions.getExecution( - functionId = "<FUNCTION_ID>", - executionId = "<EXECUTION_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/functions/list-executions.md b/docs/examples/1.6.x/client-android/kotlin/functions/list-executions.md deleted file mode 100644 index 4adc722a7e..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/functions/list-executions.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val functions = Functions(client) - -val result = functions.listExecutions( - functionId = "<FUNCTION_ID>", - queries = listOf(), // (optional) - search = "<SEARCH>", // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/graphql/mutation.md b/docs/examples/1.6.x/client-android/kotlin/graphql/mutation.md deleted file mode 100644 index 2036e8e225..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/graphql/mutation.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Graphql - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val graphql = Graphql(client) - -val result = graphql.mutation( - query = mapOf( "a" to "b" ), -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/graphql/query.md b/docs/examples/1.6.x/client-android/kotlin/graphql/query.md deleted file mode 100644 index 4a37ff3334..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/graphql/query.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Graphql - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val graphql = Graphql(client) - -val result = graphql.query( - query = mapOf( "a" to "b" ), -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/get.md b/docs/examples/1.6.x/client-android/kotlin/locale/get.md deleted file mode 100644 index aeee656f38..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/locale/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val locale = Locale(client) - -val result = locale.get() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-codes.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-codes.md deleted file mode 100644 index 312ee65435..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/locale/list-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val locale = Locale(client) - -val result = locale.listCodes() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-continents.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-continents.md deleted file mode 100644 index fa72e8e558..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/locale/list-continents.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val locale = Locale(client) - -val result = locale.listContinents() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-e-u.md deleted file mode 100644 index fc78895b8f..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-e-u.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val locale = Locale(client) - -val result = locale.listCountriesEU() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-phones.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-phones.md deleted file mode 100644 index c91603de3a..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/locale/list-countries-phones.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val locale = Locale(client) - -val result = locale.listCountriesPhones() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-countries.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-countries.md deleted file mode 100644 index 8447eae584..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/locale/list-countries.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val locale = Locale(client) - -val result = locale.listCountries() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-currencies.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-currencies.md deleted file mode 100644 index 631cd0d3ef..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/locale/list-currencies.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val locale = Locale(client) - -val result = locale.listCurrencies() diff --git a/docs/examples/1.6.x/client-android/kotlin/locale/list-languages.md b/docs/examples/1.6.x/client-android/kotlin/locale/list-languages.md deleted file mode 100644 index c6c1560b08..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/locale/list-languages.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val locale = Locale(client) - -val result = locale.listLanguages() diff --git a/docs/examples/1.6.x/client-android/kotlin/messaging/create-subscriber.md b/docs/examples/1.6.x/client-android/kotlin/messaging/create-subscriber.md deleted file mode 100644 index e0798af1ee..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/messaging/create-subscriber.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val messaging = Messaging(client) - -val result = messaging.createSubscriber( - topicId = "<TOPIC_ID>", - subscriberId = "<SUBSCRIBER_ID>", - targetId = "<TARGET_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-android/kotlin/messaging/delete-subscriber.md deleted file mode 100644 index cf84d81bf7..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/messaging/delete-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val messaging = Messaging(client) - -val result = messaging.deleteSubscriber( - topicId = "<TOPIC_ID>", - subscriberId = "<SUBSCRIBER_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/create-file.md b/docs/examples/1.6.x/client-android/kotlin/storage/create-file.md deleted file mode 100644 index d9b50e5251..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/storage/create-file.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.models.InputFile -import io.appwrite.services.Storage - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val storage = Storage(client) - -val result = storage.createFile( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>", - file = InputFile.fromPath("file.png"), - permissions = listOf("read("any")"), // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/delete-file.md b/docs/examples/1.6.x/client-android/kotlin/storage/delete-file.md deleted file mode 100644 index 6309658b7a..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/storage/delete-file.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val storage = Storage(client) - -val result = storage.deleteFile( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/get-file-download.md b/docs/examples/1.6.x/client-android/kotlin/storage/get-file-download.md deleted file mode 100644 index 305fdb9fc5..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/storage/get-file-download.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val storage = Storage(client) - -val result = storage.getFileDownload( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/get-file-preview.md b/docs/examples/1.6.x/client-android/kotlin/storage/get-file-preview.md deleted file mode 100644 index 9cd86ff4ff..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/storage/get-file-preview.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val storage = Storage(client) - -val result = storage.getFilePreview( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>", - width = 0, // (optional) - height = 0, // (optional) - gravity = ImageGravity.CENTER, // (optional) - quality = 0, // (optional) - borderWidth = 0, // (optional) - borderColor = "", // (optional) - borderRadius = 0, // (optional) - opacity = 0, // (optional) - rotation = -360, // (optional) - background = "", // (optional) - output = ImageFormat.JPG, // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/get-file-view.md b/docs/examples/1.6.x/client-android/kotlin/storage/get-file-view.md deleted file mode 100644 index b8769cd5e1..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/storage/get-file-view.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val storage = Storage(client) - -val result = storage.getFileView( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/get-file.md b/docs/examples/1.6.x/client-android/kotlin/storage/get-file.md deleted file mode 100644 index 4fab8a6690..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/storage/get-file.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val storage = Storage(client) - -val result = storage.getFile( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/list-files.md b/docs/examples/1.6.x/client-android/kotlin/storage/list-files.md deleted file mode 100644 index 78d875e730..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/storage/list-files.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val storage = Storage(client) - -val result = storage.listFiles( - bucketId = "<BUCKET_ID>", - queries = listOf(), // (optional) - search = "<SEARCH>", // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/storage/update-file.md b/docs/examples/1.6.x/client-android/kotlin/storage/update-file.md deleted file mode 100644 index 7f34dee16d..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/storage/update-file.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val storage = Storage(client) - -val result = storage.updateFile( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>", - name = "<NAME>", // (optional) - permissions = listOf("read("any")"), // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/create-membership.md b/docs/examples/1.6.x/client-android/kotlin/teams/create-membership.md deleted file mode 100644 index 5858c23496..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/create-membership.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.createMembership( - teamId = "<TEAM_ID>", - roles = listOf(), - email = "email@example.com", // (optional) - userId = "<USER_ID>", // (optional) - phone = "+12065550100", // (optional) - url = "https://example.com", // (optional) - name = "<NAME>", // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/create.md b/docs/examples/1.6.x/client-android/kotlin/teams/create.md deleted file mode 100644 index a45c22c3a6..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/create.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.create( - teamId = "<TEAM_ID>", - name = "<NAME>", - roles = listOf(), // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/delete-membership.md b/docs/examples/1.6.x/client-android/kotlin/teams/delete-membership.md deleted file mode 100644 index 0d191e663f..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/delete-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.deleteMembership( - teamId = "<TEAM_ID>", - membershipId = "<MEMBERSHIP_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/delete.md b/docs/examples/1.6.x/client-android/kotlin/teams/delete.md deleted file mode 100644 index 87a3026704..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.delete( - teamId = "<TEAM_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/get-membership.md b/docs/examples/1.6.x/client-android/kotlin/teams/get-membership.md deleted file mode 100644 index 25e8b3ab7c..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/get-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.getMembership( - teamId = "<TEAM_ID>", - membershipId = "<MEMBERSHIP_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/get-prefs.md b/docs/examples/1.6.x/client-android/kotlin/teams/get-prefs.md deleted file mode 100644 index 447c4f2ab7..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/get-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.getPrefs( - teamId = "<TEAM_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/get.md b/docs/examples/1.6.x/client-android/kotlin/teams/get.md deleted file mode 100644 index aa18a3142d..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.get( - teamId = "<TEAM_ID>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/list-memberships.md b/docs/examples/1.6.x/client-android/kotlin/teams/list-memberships.md deleted file mode 100644 index 2f83d8cd1c..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/list-memberships.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.listMemberships( - teamId = "<TEAM_ID>", - queries = listOf(), // (optional) - search = "<SEARCH>", // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/list.md b/docs/examples/1.6.x/client-android/kotlin/teams/list.md deleted file mode 100644 index 569e607e03..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.list( - queries = listOf(), // (optional) - search = "<SEARCH>", // (optional) -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/update-membership-status.md b/docs/examples/1.6.x/client-android/kotlin/teams/update-membership-status.md deleted file mode 100644 index 8d091aa78e..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/update-membership-status.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.updateMembershipStatus( - teamId = "<TEAM_ID>", - membershipId = "<MEMBERSHIP_ID>", - userId = "<USER_ID>", - secret = "<SECRET>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/update-membership.md b/docs/examples/1.6.x/client-android/kotlin/teams/update-membership.md deleted file mode 100644 index 1f6c2d32f0..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/update-membership.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.updateMembership( - teamId = "<TEAM_ID>", - membershipId = "<MEMBERSHIP_ID>", - roles = listOf(), -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/update-name.md b/docs/examples/1.6.x/client-android/kotlin/teams/update-name.md deleted file mode 100644 index 470ab17bbb..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/update-name.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.updateName( - teamId = "<TEAM_ID>", - name = "<NAME>", -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-android/kotlin/teams/update-prefs.md b/docs/examples/1.6.x/client-android/kotlin/teams/update-prefs.md deleted file mode 100644 index 6ef809e5b0..0000000000 --- a/docs/examples/1.6.x/client-android/kotlin/teams/update-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client(context) - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val teams = Teams(client) - -val result = teams.updatePrefs( - teamId = "<TEAM_ID>", - prefs = mapOf( "a" to "b" ), -) \ No newline at end of file diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-apple/examples/account/create-anonymous-session.md deleted file mode 100644 index 6392cc4728..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.createAnonymousSession() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-apple/examples/account/create-email-password-session.md deleted file mode 100644 index 2ff62e4c3d..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-email-password-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.createEmailPasswordSession( - email: "email@example.com", - password: "password" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-email-token.md b/docs/examples/1.6.x/client-apple/examples/account/create-email-token.md deleted file mode 100644 index 1da4ecb425..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-email-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.createEmailToken( - userId: "<USER_ID>", - email: "email@example.com", - phrase: false // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-apple/examples/account/create-j-w-t.md deleted file mode 100644 index ade54e673e..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-j-w-t.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let jwt = try await account.createJWT() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-apple/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 83d763c871..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.createMagicURLToken( - userId: "<USER_ID>", - email: "email@example.com", - url: "https://example.com", // optional - phrase: false // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-apple/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 0bf8badb19..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let mfaType = try await account.createMfaAuthenticator( - type: .totp -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-apple/examples/account/create-mfa-challenge.md deleted file mode 100644 index 3798884fde..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let mfaChallenge = try await account.createMfaChallenge( - factor: .email -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-apple/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index 7f54ce5096..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let mfaRecoveryCodes = try await account.createMfaRecoveryCodes() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2session.md deleted file mode 100644 index 640b17dc22..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2session.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let success = try await account.createOAuth2Session( - provider: .amazon, - success: "https://example.com", // optional - failure: "https://example.com", // optional - scopes: [] // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2token.md deleted file mode 100644 index 4224c6b4c3..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let success = try await account.createOAuth2Token( - provider: .amazon, - success: "https://example.com", // optional - failure: "https://example.com", // optional - scopes: [] // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-apple/examples/account/create-phone-token.md deleted file mode 100644 index f8cff783f4..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-phone-token.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.createPhoneToken( - userId: "<USER_ID>", - phone: "+12065550100" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-apple/examples/account/create-phone-verification.md deleted file mode 100644 index 7f70d610ee..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-phone-verification.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.createPhoneVerification() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-push-target.md b/docs/examples/1.6.x/client-apple/examples/account/create-push-target.md deleted file mode 100644 index 4221cea941..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-push-target.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let target = try await account.createPushTarget( - targetId: "<TARGET_ID>", - identifier: "<IDENTIFIER>", - providerId: "<PROVIDER_ID>" // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-recovery.md b/docs/examples/1.6.x/client-apple/examples/account/create-recovery.md deleted file mode 100644 index b53e7ee0c2..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-recovery.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.createRecovery( - email: "email@example.com", - url: "https://example.com" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-session.md b/docs/examples/1.6.x/client-apple/examples/account/create-session.md deleted file mode 100644 index 2bdecc74d3..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.createSession( - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create-verification.md b/docs/examples/1.6.x/client-apple/examples/account/create-verification.md deleted file mode 100644 index 6e0ef05e05..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.createVerification( - url: "https://example.com" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/create.md b/docs/examples/1.6.x/client-apple/examples/account/create.md deleted file mode 100644 index cb8dd109bb..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/create.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let user = try await account.create( - userId: "<USER_ID>", - email: "email@example.com", - password: "", - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/delete-identity.md b/docs/examples/1.6.x/client-apple/examples/account/delete-identity.md deleted file mode 100644 index 1cca046bc2..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/delete-identity.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let result = try await account.deleteIdentity( - identityId: "<IDENTITY_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-apple/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 805c673a78..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let result = try await account.deleteMfaAuthenticator( - type: .totp -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-apple/examples/account/delete-push-target.md deleted file mode 100644 index 4b5a8e6837..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/delete-push-target.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let result = try await account.deletePushTarget( - targetId: "<TARGET_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/delete-session.md b/docs/examples/1.6.x/client-apple/examples/account/delete-session.md deleted file mode 100644 index 0fa94094fb..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/delete-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let result = try await account.deleteSession( - sessionId: "<SESSION_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-apple/examples/account/delete-sessions.md deleted file mode 100644 index cb49194862..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/delete-sessions.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let result = try await account.deleteSessions() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-apple/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index 978fadd160..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let mfaRecoveryCodes = try await account.getMfaRecoveryCodes() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/get-prefs.md b/docs/examples/1.6.x/client-apple/examples/account/get-prefs.md deleted file mode 100644 index c9d4f62ebc..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/get-prefs.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let preferences = try await account.getPrefs() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/get-session.md b/docs/examples/1.6.x/client-apple/examples/account/get-session.md deleted file mode 100644 index b3a521973e..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/get-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.getSession( - sessionId: "<SESSION_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/get.md b/docs/examples/1.6.x/client-apple/examples/account/get.md deleted file mode 100644 index 1a4f52e295..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/get.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let user = try await account.get() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/list-identities.md b/docs/examples/1.6.x/client-apple/examples/account/list-identities.md deleted file mode 100644 index 94f5a8467d..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/list-identities.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let identityList = try await account.listIdentities( - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/list-logs.md b/docs/examples/1.6.x/client-apple/examples/account/list-logs.md deleted file mode 100644 index 7d903695b3..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/list-logs.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let logList = try await account.listLogs( - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-apple/examples/account/list-mfa-factors.md deleted file mode 100644 index 050ea14752..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let mfaFactors = try await account.listMfaFactors() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/list-sessions.md b/docs/examples/1.6.x/client-apple/examples/account/list-sessions.md deleted file mode 100644 index 891de058b2..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/list-sessions.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let sessionList = try await account.listSessions() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-email.md b/docs/examples/1.6.x/client-apple/examples/account/update-email.md deleted file mode 100644 index 7d5811d7a8..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-email.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let user = try await account.updateEmail( - email: "email@example.com", - password: "password" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-apple/examples/account/update-m-f-a.md deleted file mode 100644 index dddf0bc971..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-m-f-a.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let user = try await account.updateMFA( - mfa: false -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-apple/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 6571266959..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.updateMagicURLSession( - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-apple/examples/account/update-mfa-authenticator.md deleted file mode 100644 index 10da12d217..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let user = try await account.updateMfaAuthenticator( - type: .totp, - otp: "<OTP>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-apple/examples/account/update-mfa-challenge.md deleted file mode 100644 index e75d9b647c..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let result = try await account.updateMfaChallenge( - challengeId: "<CHALLENGE_ID>", - otp: "<OTP>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-apple/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index 374c2f746f..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let mfaRecoveryCodes = try await account.updateMfaRecoveryCodes() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-name.md b/docs/examples/1.6.x/client-apple/examples/account/update-name.md deleted file mode 100644 index 6fe2f5e61d..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-name.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let user = try await account.updateName( - name: "<NAME>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-password.md b/docs/examples/1.6.x/client-apple/examples/account/update-password.md deleted file mode 100644 index cc1fe3d438..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-password.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let user = try await account.updatePassword( - password: "", - oldPassword: "password" // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-apple/examples/account/update-phone-session.md deleted file mode 100644 index df1feae1e3..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-phone-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.updatePhoneSession( - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-apple/examples/account/update-phone-verification.md deleted file mode 100644 index d18c1e4841..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.updatePhoneVerification( - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-phone.md b/docs/examples/1.6.x/client-apple/examples/account/update-phone.md deleted file mode 100644 index ba22584e66..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-phone.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let user = try await account.updatePhone( - phone: "+12065550100", - password: "password" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-prefs.md b/docs/examples/1.6.x/client-apple/examples/account/update-prefs.md deleted file mode 100644 index b71f73d3e9..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let user = try await account.updatePrefs( - prefs: [:] -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-push-target.md b/docs/examples/1.6.x/client-apple/examples/account/update-push-target.md deleted file mode 100644 index 70e206240d..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-push-target.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let target = try await account.updatePushTarget( - targetId: "<TARGET_ID>", - identifier: "<IDENTIFIER>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-recovery.md b/docs/examples/1.6.x/client-apple/examples/account/update-recovery.md deleted file mode 100644 index 9386ca0ae9..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.updateRecovery( - userId: "<USER_ID>", - secret: "<SECRET>", - password: "" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-session.md b/docs/examples/1.6.x/client-apple/examples/account/update-session.md deleted file mode 100644 index d5d8a202de..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.updateSession( - sessionId: "<SESSION_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-status.md b/docs/examples/1.6.x/client-apple/examples/account/update-status.md deleted file mode 100644 index b654314d76..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-status.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let user = try await account.updateStatus() - diff --git a/docs/examples/1.6.x/client-apple/examples/account/update-verification.md b/docs/examples/1.6.x/client-apple/examples/account/update-verification.md deleted file mode 100644 index 6915a0c3e5..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/account/update-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.updateVerification( - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-browser.md deleted file mode 100644 index 3ce39028b6..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/avatars/get-browser.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let avatars = Avatars(client) - -let bytes = try await avatars.getBrowser( - code: .avantBrowser, - width: 0, // optional - height: 0, // optional - quality: 0 // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-credit-card.md deleted file mode 100644 index 76191aa64f..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let avatars = Avatars(client) - -let bytes = try await avatars.getCreditCard( - code: .americanExpress, - width: 0, // optional - height: 0, // optional - quality: 0 // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-favicon.md deleted file mode 100644 index 549b12364b..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/avatars/get-favicon.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let avatars = Avatars(client) - -let bytes = try await avatars.getFavicon( - url: "https://example.com" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-flag.md deleted file mode 100644 index bdf8dd0493..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/avatars/get-flag.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let avatars = Avatars(client) - -let bytes = try await avatars.getFlag( - code: .afghanistan, - width: 0, // optional - height: 0, // optional - quality: 0 // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-image.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-image.md deleted file mode 100644 index 5098493a45..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/avatars/get-image.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let avatars = Avatars(client) - -let bytes = try await avatars.getImage( - url: "https://example.com", - width: 0, // optional - height: 0 // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-initials.md deleted file mode 100644 index 02aafd89f0..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/avatars/get-initials.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let avatars = Avatars(client) - -let bytes = try await avatars.getInitials( - name: "<NAME>", // optional - width: 0, // optional - height: 0, // optional - background: "" // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-apple/examples/avatars/get-q-r.md deleted file mode 100644 index 9a1e414b35..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/avatars/get-q-r.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let avatars = Avatars(client) - -let bytes = try await avatars.getQR( - text: "<TEXT>", - size: 1, // optional - margin: 0, // optional - download: false // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/databases/create-document.md b/docs/examples/1.6.x/client-apple/examples/databases/create-document.md deleted file mode 100644 index ea5161de06..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/databases/create-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let databases = Databases(client) - -let document = try await databases.createDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - data: [:], - permissions: ["read("any")"] // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/databases/delete-document.md b/docs/examples/1.6.x/client-apple/examples/databases/delete-document.md deleted file mode 100644 index f97130378b..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/databases/delete-document.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let databases = Databases(client) - -let result = try await databases.deleteDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/databases/get-document.md b/docs/examples/1.6.x/client-apple/examples/databases/get-document.md deleted file mode 100644 index 2355b938fe..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/databases/get-document.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let databases = Databases(client) - -let document = try await databases.getDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/databases/list-documents.md b/docs/examples/1.6.x/client-apple/examples/databases/list-documents.md deleted file mode 100644 index bbb60ef9ad..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/databases/list-documents.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let databases = Databases(client) - -let documentList = try await databases.listDocuments( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/databases/update-document.md b/docs/examples/1.6.x/client-apple/examples/databases/update-document.md deleted file mode 100644 index 768787e2b3..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/databases/update-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let databases = Databases(client) - -let document = try await databases.updateDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - data: [:], // optional - permissions: ["read("any")"] // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/functions/create-execution.md b/docs/examples/1.6.x/client-apple/examples/functions/create-execution.md deleted file mode 100644 index 2f2d32d19e..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/functions/create-execution.md +++ /dev/null @@ -1,19 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let functions = Functions(client) - -let execution = try await functions.createExecution( - functionId: "<FUNCTION_ID>", - body: "<BODY>", // optional - async: false, // optional - path: "<PATH>", // optional - method: .gET, // optional - headers: [:], // optional - scheduledAt: "" // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/functions/get-execution.md b/docs/examples/1.6.x/client-apple/examples/functions/get-execution.md deleted file mode 100644 index b711ce210d..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/functions/get-execution.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let functions = Functions(client) - -let execution = try await functions.getExecution( - functionId: "<FUNCTION_ID>", - executionId: "<EXECUTION_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/functions/list-executions.md b/docs/examples/1.6.x/client-apple/examples/functions/list-executions.md deleted file mode 100644 index 043c8911ae..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/functions/list-executions.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let functions = Functions(client) - -let executionList = try await functions.listExecutions( - functionId: "<FUNCTION_ID>", - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/graphql/mutation.md b/docs/examples/1.6.x/client-apple/examples/graphql/mutation.md deleted file mode 100644 index 29434c6bb0..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/graphql/mutation.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let graphql = Graphql(client) - -let any = try await graphql.mutation( - query: [:] -) - diff --git a/docs/examples/1.6.x/client-apple/examples/graphql/query.md b/docs/examples/1.6.x/client-apple/examples/graphql/query.md deleted file mode 100644 index 85c6ab4e53..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/graphql/query.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let graphql = Graphql(client) - -let any = try await graphql.query( - query: [:] -) - diff --git a/docs/examples/1.6.x/client-apple/examples/locale/get.md b/docs/examples/1.6.x/client-apple/examples/locale/get.md deleted file mode 100644 index 6c352fbef3..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/locale/get.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let locale = Locale(client) - -let locale = try await locale.get() - diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-codes.md b/docs/examples/1.6.x/client-apple/examples/locale/list-codes.md deleted file mode 100644 index 2f168d9b4d..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/locale/list-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let locale = Locale(client) - -let localeCodeList = try await locale.listCodes() - diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-continents.md b/docs/examples/1.6.x/client-apple/examples/locale/list-continents.md deleted file mode 100644 index 714d9e1ee1..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/locale/list-continents.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let locale = Locale(client) - -let continentList = try await locale.listContinents() - diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-apple/examples/locale/list-countries-e-u.md deleted file mode 100644 index d390094bbd..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let locale = Locale(client) - -let countryList = try await locale.listCountriesEU() - diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-apple/examples/locale/list-countries-phones.md deleted file mode 100644 index 96060b5ae7..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let locale = Locale(client) - -let phoneList = try await locale.listCountriesPhones() - diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-countries.md b/docs/examples/1.6.x/client-apple/examples/locale/list-countries.md deleted file mode 100644 index fc9b18accf..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/locale/list-countries.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let locale = Locale(client) - -let countryList = try await locale.listCountries() - diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-apple/examples/locale/list-currencies.md deleted file mode 100644 index d316235bfc..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/locale/list-currencies.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let locale = Locale(client) - -let currencyList = try await locale.listCurrencies() - diff --git a/docs/examples/1.6.x/client-apple/examples/locale/list-languages.md b/docs/examples/1.6.x/client-apple/examples/locale/list-languages.md deleted file mode 100644 index 62e929aac7..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/locale/list-languages.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let locale = Locale(client) - -let languageList = try await locale.listLanguages() - diff --git a/docs/examples/1.6.x/client-apple/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-apple/examples/messaging/create-subscriber.md deleted file mode 100644 index 1a135e8766..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let messaging = Messaging(client) - -let subscriber = try await messaging.createSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>", - targetId: "<TARGET_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-apple/examples/messaging/delete-subscriber.md deleted file mode 100644 index fe6261a13f..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let messaging = Messaging(client) - -let result = try await messaging.deleteSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/storage/create-file.md b/docs/examples/1.6.x/client-apple/examples/storage/create-file.md deleted file mode 100644 index 07f3ea78c2..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/storage/create-file.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let storage = Storage(client) - -let file = try await storage.createFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - file: InputFile.fromPath("file.png"), - permissions: ["read("any")"] // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/storage/delete-file.md b/docs/examples/1.6.x/client-apple/examples/storage/delete-file.md deleted file mode 100644 index 323b92e84a..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/storage/delete-file.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let storage = Storage(client) - -let result = try await storage.deleteFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-apple/examples/storage/get-file-download.md deleted file mode 100644 index 32c033be4a..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/storage/get-file-download.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let storage = Storage(client) - -let bytes = try await storage.getFileDownload( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-apple/examples/storage/get-file-preview.md deleted file mode 100644 index 4b66426448..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/storage/get-file-preview.md +++ /dev/null @@ -1,25 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let storage = Storage(client) - -let bytes = try await storage.getFilePreview( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - width: 0, // optional - height: 0, // optional - gravity: .center, // optional - quality: 0, // optional - borderWidth: 0, // optional - borderColor: "", // optional - borderRadius: 0, // optional - opacity: 0, // optional - rotation: -360, // optional - background: "", // optional - output: .jpg // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-apple/examples/storage/get-file-view.md deleted file mode 100644 index c0a949dfa0..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/storage/get-file-view.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let storage = Storage(client) - -let bytes = try await storage.getFileView( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/storage/get-file.md b/docs/examples/1.6.x/client-apple/examples/storage/get-file.md deleted file mode 100644 index bf2e60f603..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/storage/get-file.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let storage = Storage(client) - -let file = try await storage.getFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/storage/list-files.md b/docs/examples/1.6.x/client-apple/examples/storage/list-files.md deleted file mode 100644 index d03995ebbd..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/storage/list-files.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let storage = Storage(client) - -let fileList = try await storage.listFiles( - bucketId: "<BUCKET_ID>", - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/storage/update-file.md b/docs/examples/1.6.x/client-apple/examples/storage/update-file.md deleted file mode 100644 index e71eecc2c5..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/storage/update-file.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let storage = Storage(client) - -let file = try await storage.updateFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - name: "<NAME>", // optional - permissions: ["read("any")"] // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/create-membership.md b/docs/examples/1.6.x/client-apple/examples/teams/create-membership.md deleted file mode 100644 index e57eca8cba..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/create-membership.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let membership = try await teams.createMembership( - teamId: "<TEAM_ID>", - roles: [], - email: "email@example.com", // optional - userId: "<USER_ID>", // optional - phone: "+12065550100", // optional - url: "https://example.com", // optional - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/create.md b/docs/examples/1.6.x/client-apple/examples/teams/create.md deleted file mode 100644 index 4ae559b8a3..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/create.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let team = try await teams.create( - teamId: "<TEAM_ID>", - name: "<NAME>", - roles: [] // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-apple/examples/teams/delete-membership.md deleted file mode 100644 index a7cdaa8731..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/delete-membership.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let result = try await teams.deleteMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/delete.md b/docs/examples/1.6.x/client-apple/examples/teams/delete.md deleted file mode 100644 index f7e3265e35..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let result = try await teams.delete( - teamId: "<TEAM_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/get-membership.md b/docs/examples/1.6.x/client-apple/examples/teams/get-membership.md deleted file mode 100644 index 0fb4b51416..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/get-membership.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let membership = try await teams.getMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-apple/examples/teams/get-prefs.md deleted file mode 100644 index 151cb3ffe2..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let preferences = try await teams.getPrefs( - teamId: "<TEAM_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/get.md b/docs/examples/1.6.x/client-apple/examples/teams/get.md deleted file mode 100644 index 361837875d..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let team = try await teams.get( - teamId: "<TEAM_ID>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-apple/examples/teams/list-memberships.md deleted file mode 100644 index a0573b6e96..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/list-memberships.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let membershipList = try await teams.listMemberships( - teamId: "<TEAM_ID>", - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/list.md b/docs/examples/1.6.x/client-apple/examples/teams/list.md deleted file mode 100644 index bbd2dd6056..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/list.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let teamList = try await teams.list( - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-apple/examples/teams/update-membership-status.md deleted file mode 100644 index 25a1246407..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/update-membership-status.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let membership = try await teams.updateMembershipStatus( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>", - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/update-membership.md b/docs/examples/1.6.x/client-apple/examples/teams/update-membership.md deleted file mode 100644 index 0a52d6c547..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/update-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let membership = try await teams.updateMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>", - roles: [] -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/update-name.md b/docs/examples/1.6.x/client-apple/examples/teams/update-name.md deleted file mode 100644 index 245919d60f..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let team = try await teams.updateName( - teamId: "<TEAM_ID>", - name: "<NAME>" -) - diff --git a/docs/examples/1.6.x/client-apple/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-apple/examples/teams/update-prefs.md deleted file mode 100644 index 2e71dde1cc..0000000000 --- a/docs/examples/1.6.x/client-apple/examples/teams/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let teams = Teams(client) - -let preferences = try await teams.updatePrefs( - teamId: "<TEAM_ID>", - prefs: [:] -) - diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-flutter/examples/account/create-anonymous-session.md deleted file mode 100644 index 173b07afd2..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.createAnonymousSession(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-flutter/examples/account/create-email-password-session.md deleted file mode 100644 index 6b49879093..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-email-password-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.createEmailPasswordSession( - email: 'email@example.com', - password: 'password', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-email-token.md b/docs/examples/1.6.x/client-flutter/examples/account/create-email-token.md deleted file mode 100644 index 497d91a4ce..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-email-token.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.createEmailToken( - userId: '<USER_ID>', - email: 'email@example.com', - phrase: false, // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-flutter/examples/account/create-j-w-t.md deleted file mode 100644 index 5af6e3d3a8..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-j-w-t.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Jwt result = await account.createJWT(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-flutter/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 8ac49e8282..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.createMagicURLToken( - userId: '<USER_ID>', - email: 'email@example.com', - url: 'https://example.com', // optional - phrase: false, // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 4ea7989886..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -MfaType result = await account.createMfaAuthenticator( - type: AuthenticatorType.totp, -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-challenge.md deleted file mode 100644 index bbd95ea729..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -MfaChallenge result = await account.createMfaChallenge( - factor: AuthenticationFactor.email, -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index aa3b78b12d..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -MfaRecoveryCodes result = await account.createMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2session.md deleted file mode 100644 index 2679f9eb6e..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2session.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -await account.createOAuth2Session( - provider: OAuthProvider.amazon, - success: 'https://example.com', // optional - failure: 'https://example.com', // optional - scopes: [], // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2token.md deleted file mode 100644 index 4f62b8116d..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -await account.createOAuth2Token( - provider: OAuthProvider.amazon, - success: 'https://example.com', // optional - failure: 'https://example.com', // optional - scopes: [], // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-flutter/examples/account/create-phone-token.md deleted file mode 100644 index 5a096ceb8c..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-phone-token.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.createPhoneToken( - userId: '<USER_ID>', - phone: '+12065550100', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-flutter/examples/account/create-phone-verification.md deleted file mode 100644 index f80bbaadac..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-phone-verification.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.createPhoneVerification(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-push-target.md b/docs/examples/1.6.x/client-flutter/examples/account/create-push-target.md deleted file mode 100644 index 33a98cf77c..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-push-target.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Target result = await account.createPushTarget( - targetId: '<TARGET_ID>', - identifier: '<IDENTIFIER>', - providerId: '<PROVIDER_ID>', // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-recovery.md b/docs/examples/1.6.x/client-flutter/examples/account/create-recovery.md deleted file mode 100644 index 70c52faa77..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-recovery.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.createRecovery( - email: 'email@example.com', - url: 'https://example.com', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-session.md b/docs/examples/1.6.x/client-flutter/examples/account/create-session.md deleted file mode 100644 index b8170cc176..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.createSession( - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create-verification.md b/docs/examples/1.6.x/client-flutter/examples/account/create-verification.md deleted file mode 100644 index 99ba3cbe4e..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create-verification.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.createVerification( - url: 'https://example.com', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/create.md b/docs/examples/1.6.x/client-flutter/examples/account/create.md deleted file mode 100644 index 324d0d995f..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/create.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -User result = await account.create( - userId: '<USER_ID>', - email: 'email@example.com', - password: '', - name: '<NAME>', // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/delete-identity.md b/docs/examples/1.6.x/client-flutter/examples/account/delete-identity.md deleted file mode 100644 index ae5cd50dac..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/delete-identity.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -await account.deleteIdentity( - identityId: '<IDENTITY_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-flutter/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 66a0e89727..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -await account.deleteMfaAuthenticator( - type: AuthenticatorType.totp, -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-flutter/examples/account/delete-push-target.md deleted file mode 100644 index d80c97ecea..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/delete-push-target.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -await account.deletePushTarget( - targetId: '<TARGET_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/delete-session.md b/docs/examples/1.6.x/client-flutter/examples/account/delete-session.md deleted file mode 100644 index 5bf9811550..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/delete-session.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -await account.deleteSession( - sessionId: '<SESSION_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-flutter/examples/account/delete-sessions.md deleted file mode 100644 index c00d285691..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/delete-sessions.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -await account.deleteSessions(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-flutter/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index f4e99b6e2d..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -MfaRecoveryCodes result = await account.getMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/get-prefs.md b/docs/examples/1.6.x/client-flutter/examples/account/get-prefs.md deleted file mode 100644 index 2790e097bc..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/get-prefs.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Preferences result = await account.getPrefs(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/get-session.md b/docs/examples/1.6.x/client-flutter/examples/account/get-session.md deleted file mode 100644 index 0be63f7225..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/get-session.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.getSession( - sessionId: '<SESSION_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/get.md b/docs/examples/1.6.x/client-flutter/examples/account/get.md deleted file mode 100644 index 0bd26c0273..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/get.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -User result = await account.get(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/list-identities.md b/docs/examples/1.6.x/client-flutter/examples/account/list-identities.md deleted file mode 100644 index 758b054b9a..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/list-identities.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -IdentityList result = await account.listIdentities( - queries: [], // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/list-logs.md b/docs/examples/1.6.x/client-flutter/examples/account/list-logs.md deleted file mode 100644 index 7a4ac11ab1..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/list-logs.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -LogList result = await account.listLogs( - queries: [], // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-flutter/examples/account/list-mfa-factors.md deleted file mode 100644 index d66e8862b1..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -MfaFactors result = await account.listMfaFactors(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/list-sessions.md b/docs/examples/1.6.x/client-flutter/examples/account/list-sessions.md deleted file mode 100644 index 4c363ccf63..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/list-sessions.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -SessionList result = await account.listSessions(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-email.md b/docs/examples/1.6.x/client-flutter/examples/account/update-email.md deleted file mode 100644 index 2b5b73ec78..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-email.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -User result = await account.updateEmail( - email: 'email@example.com', - password: 'password', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-flutter/examples/account/update-m-f-a.md deleted file mode 100644 index 5f65b7e90d..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-m-f-a.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -User result = await account.updateMFA( - mfa: false, -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-flutter/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 0f584d7514..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.updateMagicURLSession( - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-authenticator.md deleted file mode 100644 index 9fb8f54cb5..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -User result = await account.updateMfaAuthenticator( - type: AuthenticatorType.totp, - otp: '<OTP>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-challenge.md deleted file mode 100644 index 6eac346670..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - - result = await account.updateMfaChallenge( - challengeId: '<CHALLENGE_ID>', - otp: '<OTP>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index 29c0cff280..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -MfaRecoveryCodes result = await account.updateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-name.md b/docs/examples/1.6.x/client-flutter/examples/account/update-name.md deleted file mode 100644 index bf8048d079..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-name.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -User result = await account.updateName( - name: '<NAME>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-password.md b/docs/examples/1.6.x/client-flutter/examples/account/update-password.md deleted file mode 100644 index 0e4106012d..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-password.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -User result = await account.updatePassword( - password: '', - oldPassword: 'password', // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-flutter/examples/account/update-phone-session.md deleted file mode 100644 index 1ea87ddf84..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-phone-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.updatePhoneSession( - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-flutter/examples/account/update-phone-verification.md deleted file mode 100644 index d6681a633d..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-phone-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.updatePhoneVerification( - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-phone.md b/docs/examples/1.6.x/client-flutter/examples/account/update-phone.md deleted file mode 100644 index 0e530464de..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-phone.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -User result = await account.updatePhone( - phone: '+12065550100', - password: 'password', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-prefs.md b/docs/examples/1.6.x/client-flutter/examples/account/update-prefs.md deleted file mode 100644 index 15d3a8f530..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-prefs.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -User result = await account.updatePrefs( - prefs: {}, -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-push-target.md b/docs/examples/1.6.x/client-flutter/examples/account/update-push-target.md deleted file mode 100644 index 78d1b7929a..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-push-target.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Target result = await account.updatePushTarget( - targetId: '<TARGET_ID>', - identifier: '<IDENTIFIER>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-recovery.md b/docs/examples/1.6.x/client-flutter/examples/account/update-recovery.md deleted file mode 100644 index d12c24d3d6..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-recovery.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.updateRecovery( - userId: '<USER_ID>', - secret: '<SECRET>', - password: '', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-session.md b/docs/examples/1.6.x/client-flutter/examples/account/update-session.md deleted file mode 100644 index bb600667ba..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-session.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.updateSession( - sessionId: '<SESSION_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-status.md b/docs/examples/1.6.x/client-flutter/examples/account/update-status.md deleted file mode 100644 index da59e537c4..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-status.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -User result = await account.updateStatus(); diff --git a/docs/examples/1.6.x/client-flutter/examples/account/update-verification.md b/docs/examples/1.6.x/client-flutter/examples/account/update-verification.md deleted file mode 100644 index 98174f9f2f..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/account/update-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.updateVerification( - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-browser.md deleted file mode 100644 index 20b039a3d7..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/avatars/get-browser.md +++ /dev/null @@ -1,33 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Avatars avatars = Avatars(client); - -// Downloading file -UInt8List bytes = await avatars.getBrowser( - code: Browser.avantBrowser, - width: 0, // optional - height: 0, // optional - quality: 0, // optional -) - -final file = File('path_to_file/filename.ext'); -file.writeAsBytesSync(bytes); - -// Displaying image preview -FutureBuilder( - future: avatars.getBrowser( - code: Browser.avantBrowser, - width:0 , // optional - height:0 , // optional - quality:0 , // optional -), // Works for both public file and private file, for private files you need to be logged in - builder: (context, snapshot) { - return snapshot.hasData && snapshot.data != null - ? Image.memory(snapshot.data) - : CircularProgressIndicator(); - } -); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-credit-card.md deleted file mode 100644 index 9f645f40a5..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,33 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Avatars avatars = Avatars(client); - -// Downloading file -UInt8List bytes = await avatars.getCreditCard( - code: CreditCard.americanExpress, - width: 0, // optional - height: 0, // optional - quality: 0, // optional -) - -final file = File('path_to_file/filename.ext'); -file.writeAsBytesSync(bytes); - -// Displaying image preview -FutureBuilder( - future: avatars.getCreditCard( - code: CreditCard.americanExpress, - width:0 , // optional - height:0 , // optional - quality:0 , // optional -), // Works for both public file and private file, for private files you need to be logged in - builder: (context, snapshot) { - return snapshot.hasData && snapshot.data != null - ? Image.memory(snapshot.data) - : CircularProgressIndicator(); - } -); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-favicon.md deleted file mode 100644 index b4003ee0dd..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/avatars/get-favicon.md +++ /dev/null @@ -1,27 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Avatars avatars = Avatars(client); - -// Downloading file -UInt8List bytes = await avatars.getFavicon( - url: 'https://example.com', -) - -final file = File('path_to_file/filename.ext'); -file.writeAsBytesSync(bytes); - -// Displaying image preview -FutureBuilder( - future: avatars.getFavicon( - url:'https://example.com' , -), // Works for both public file and private file, for private files you need to be logged in - builder: (context, snapshot) { - return snapshot.hasData && snapshot.data != null - ? Image.memory(snapshot.data) - : CircularProgressIndicator(); - } -); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-flag.md deleted file mode 100644 index 9751ae2320..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/avatars/get-flag.md +++ /dev/null @@ -1,33 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Avatars avatars = Avatars(client); - -// Downloading file -UInt8List bytes = await avatars.getFlag( - code: Flag.afghanistan, - width: 0, // optional - height: 0, // optional - quality: 0, // optional -) - -final file = File('path_to_file/filename.ext'); -file.writeAsBytesSync(bytes); - -// Displaying image preview -FutureBuilder( - future: avatars.getFlag( - code: Flag.afghanistan, - width:0 , // optional - height:0 , // optional - quality:0 , // optional -), // Works for both public file and private file, for private files you need to be logged in - builder: (context, snapshot) { - return snapshot.hasData && snapshot.data != null - ? Image.memory(snapshot.data) - : CircularProgressIndicator(); - } -); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-image.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-image.md deleted file mode 100644 index 4c1404188f..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/avatars/get-image.md +++ /dev/null @@ -1,31 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Avatars avatars = Avatars(client); - -// Downloading file -UInt8List bytes = await avatars.getImage( - url: 'https://example.com', - width: 0, // optional - height: 0, // optional -) - -final file = File('path_to_file/filename.ext'); -file.writeAsBytesSync(bytes); - -// Displaying image preview -FutureBuilder( - future: avatars.getImage( - url:'https://example.com' , - width:0 , // optional - height:0 , // optional -), // Works for both public file and private file, for private files you need to be logged in - builder: (context, snapshot) { - return snapshot.hasData && snapshot.data != null - ? Image.memory(snapshot.data) - : CircularProgressIndicator(); - } -); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-initials.md deleted file mode 100644 index c7df00f111..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/avatars/get-initials.md +++ /dev/null @@ -1,33 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Avatars avatars = Avatars(client); - -// Downloading file -UInt8List bytes = await avatars.getInitials( - name: '<NAME>', // optional - width: 0, // optional - height: 0, // optional - background: '', // optional -) - -final file = File('path_to_file/filename.ext'); -file.writeAsBytesSync(bytes); - -// Displaying image preview -FutureBuilder( - future: avatars.getInitials( - name:'<NAME>' , // optional - width:0 , // optional - height:0 , // optional - background:'' , // optional -), // Works for both public file and private file, for private files you need to be logged in - builder: (context, snapshot) { - return snapshot.hasData && snapshot.data != null - ? Image.memory(snapshot.data) - : CircularProgressIndicator(); - } -); diff --git a/docs/examples/1.6.x/client-flutter/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-flutter/examples/avatars/get-q-r.md deleted file mode 100644 index fa4c3f41d6..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/avatars/get-q-r.md +++ /dev/null @@ -1,33 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Avatars avatars = Avatars(client); - -// Downloading file -UInt8List bytes = await avatars.getQR( - text: '<TEXT>', - size: 1, // optional - margin: 0, // optional - download: false, // optional -) - -final file = File('path_to_file/filename.ext'); -file.writeAsBytesSync(bytes); - -// Displaying image preview -FutureBuilder( - future: avatars.getQR( - text:'<TEXT>' , - size:1 , // optional - margin:0 , // optional - download:false , // optional -), // Works for both public file and private file, for private files you need to be logged in - builder: (context, snapshot) { - return snapshot.hasData && snapshot.data != null - ? Image.memory(snapshot.data) - : CircularProgressIndicator(); - } -); diff --git a/docs/examples/1.6.x/client-flutter/examples/databases/create-document.md b/docs/examples/1.6.x/client-flutter/examples/databases/create-document.md deleted file mode 100644 index 7970d0330f..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/databases/create-document.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Databases databases = Databases(client); - -Document result = await databases.createDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>', - data: {}, - permissions: ["read("any")"], // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/databases/delete-document.md b/docs/examples/1.6.x/client-flutter/examples/databases/delete-document.md deleted file mode 100644 index 138a5aeb5a..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/databases/delete-document.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Databases databases = Databases(client); - -await databases.deleteDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/databases/get-document.md b/docs/examples/1.6.x/client-flutter/examples/databases/get-document.md deleted file mode 100644 index 7cdd4b04a5..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/databases/get-document.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Databases databases = Databases(client); - -Document result = await databases.getDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>', - queries: [], // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/databases/list-documents.md b/docs/examples/1.6.x/client-flutter/examples/databases/list-documents.md deleted file mode 100644 index ec23cf0e0e..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/databases/list-documents.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Databases databases = Databases(client); - -DocumentList result = await databases.listDocuments( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - queries: [], // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/databases/update-document.md b/docs/examples/1.6.x/client-flutter/examples/databases/update-document.md deleted file mode 100644 index b4179209f3..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/databases/update-document.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Databases databases = Databases(client); - -Document result = await databases.updateDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>', - data: {}, // optional - permissions: ["read("any")"], // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/functions/create-execution.md b/docs/examples/1.6.x/client-flutter/examples/functions/create-execution.md deleted file mode 100644 index d53f4bf9d4..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/functions/create-execution.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Functions functions = Functions(client); - -Execution result = await functions.createExecution( - functionId: '<FUNCTION_ID>', - body: '<BODY>', // optional - xasync: false, // optional - path: '<PATH>', // optional - method: ExecutionMethod.gET, // optional - headers: {}, // optional - scheduledAt: '', // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/functions/get-execution.md b/docs/examples/1.6.x/client-flutter/examples/functions/get-execution.md deleted file mode 100644 index 84747806fd..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/functions/get-execution.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Functions functions = Functions(client); - -Execution result = await functions.getExecution( - functionId: '<FUNCTION_ID>', - executionId: '<EXECUTION_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/functions/list-executions.md b/docs/examples/1.6.x/client-flutter/examples/functions/list-executions.md deleted file mode 100644 index a99078ce9d..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/functions/list-executions.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Functions functions = Functions(client); - -ExecutionList result = await functions.listExecutions( - functionId: '<FUNCTION_ID>', - queries: [], // optional - search: '<SEARCH>', // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/graphql/mutation.md b/docs/examples/1.6.x/client-flutter/examples/graphql/mutation.md deleted file mode 100644 index bde93e5048..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/graphql/mutation.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Graphql graphql = Graphql(client); - -Any result = await graphql.mutation( - query: {}, -); diff --git a/docs/examples/1.6.x/client-flutter/examples/graphql/query.md b/docs/examples/1.6.x/client-flutter/examples/graphql/query.md deleted file mode 100644 index 35088d914e..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/graphql/query.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Graphql graphql = Graphql(client); - -Any result = await graphql.query( - query: {}, -); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/get.md b/docs/examples/1.6.x/client-flutter/examples/locale/get.md deleted file mode 100644 index 81ca122971..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/locale/get.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Locale locale = Locale(client); - -Locale result = await locale.get(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-codes.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-codes.md deleted file mode 100644 index 5b6d975503..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/locale/list-codes.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Locale locale = Locale(client); - -LocaleCodeList result = await locale.listCodes(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-continents.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-continents.md deleted file mode 100644 index c4a4ef85ea..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/locale/list-continents.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Locale locale = Locale(client); - -ContinentList result = await locale.listContinents(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-e-u.md deleted file mode 100644 index eee429419f..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Locale locale = Locale(client); - -CountryList result = await locale.listCountriesEU(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-phones.md deleted file mode 100644 index 5136d62ad0..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Locale locale = Locale(client); - -PhoneList result = await locale.listCountriesPhones(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-countries.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-countries.md deleted file mode 100644 index c3eed1ec9d..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/locale/list-countries.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Locale locale = Locale(client); - -CountryList result = await locale.listCountries(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-currencies.md deleted file mode 100644 index e2300b4e7b..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/locale/list-currencies.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Locale locale = Locale(client); - -CurrencyList result = await locale.listCurrencies(); diff --git a/docs/examples/1.6.x/client-flutter/examples/locale/list-languages.md b/docs/examples/1.6.x/client-flutter/examples/locale/list-languages.md deleted file mode 100644 index 83284e2f5d..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/locale/list-languages.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Locale locale = Locale(client); - -LanguageList result = await locale.listLanguages(); diff --git a/docs/examples/1.6.x/client-flutter/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-flutter/examples/messaging/create-subscriber.md deleted file mode 100644 index 85822f8e0f..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Messaging messaging = Messaging(client); - -Subscriber result = await messaging.createSubscriber( - topicId: '<TOPIC_ID>', - subscriberId: '<SUBSCRIBER_ID>', - targetId: '<TARGET_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-flutter/examples/messaging/delete-subscriber.md deleted file mode 100644 index 8551b2efb5..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Messaging messaging = Messaging(client); - -await messaging.deleteSubscriber( - topicId: '<TOPIC_ID>', - subscriberId: '<SUBSCRIBER_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/create-file.md b/docs/examples/1.6.x/client-flutter/examples/storage/create-file.md deleted file mode 100644 index 77468915b1..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/storage/create-file.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'dart:io'; -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Storage storage = Storage(client); - -File result = await storage.createFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', - file: InputFile(path: './path-to-files/image.jpg', filename: 'image.jpg'), - permissions: ["read("any")"], // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/delete-file.md b/docs/examples/1.6.x/client-flutter/examples/storage/delete-file.md deleted file mode 100644 index 5e2525ea5b..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/storage/delete-file.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Storage storage = Storage(client); - -await storage.deleteFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-flutter/examples/storage/get-file-download.md deleted file mode 100644 index d8d18aa42e..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/storage/get-file-download.md +++ /dev/null @@ -1,29 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Storage storage = Storage(client); - -// Downloading file -UInt8List bytes = await storage.getFileDownload( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', -) - -final file = File('path_to_file/filename.ext'); -file.writeAsBytesSync(bytes); - -// Displaying image preview -FutureBuilder( - future: storage.getFileDownload( - bucketId:'<BUCKET_ID>' , - fileId:'<FILE_ID>' , -), // Works for both public file and private file, for private files you need to be logged in - builder: (context, snapshot) { - return snapshot.hasData && snapshot.data != null - ? Image.memory(snapshot.data) - : CircularProgressIndicator(); - } -); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-flutter/examples/storage/get-file-preview.md deleted file mode 100644 index 09c8ddaeac..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/storage/get-file-preview.md +++ /dev/null @@ -1,51 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Storage storage = Storage(client); - -// Downloading file -UInt8List bytes = await storage.getFilePreview( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', - width: 0, // optional - height: 0, // optional - gravity: ImageGravity.center, // optional - quality: 0, // optional - borderWidth: 0, // optional - borderColor: '', // optional - borderRadius: 0, // optional - opacity: 0, // optional - rotation: -360, // optional - background: '', // optional - output: ImageFormat.jpg, // optional -) - -final file = File('path_to_file/filename.ext'); -file.writeAsBytesSync(bytes); - -// Displaying image preview -FutureBuilder( - future: storage.getFilePreview( - bucketId:'<BUCKET_ID>' , - fileId:'<FILE_ID>' , - width:0 , // optional - height:0 , // optional - gravity: ImageGravity.center, // optional - quality:0 , // optional - borderWidth:0 , // optional - borderColor:'' , // optional - borderRadius:0 , // optional - opacity:0 , // optional - rotation:-360 , // optional - background:'' , // optional - output: ImageFormat.jpg, // optional -), // Works for both public file and private file, for private files you need to be logged in - builder: (context, snapshot) { - return snapshot.hasData && snapshot.data != null - ? Image.memory(snapshot.data) - : CircularProgressIndicator(); - } -); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-flutter/examples/storage/get-file-view.md deleted file mode 100644 index 802bfa89ef..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/storage/get-file-view.md +++ /dev/null @@ -1,29 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Storage storage = Storage(client); - -// Downloading file -UInt8List bytes = await storage.getFileView( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', -) - -final file = File('path_to_file/filename.ext'); -file.writeAsBytesSync(bytes); - -// Displaying image preview -FutureBuilder( - future: storage.getFileView( - bucketId:'<BUCKET_ID>' , - fileId:'<FILE_ID>' , -), // Works for both public file and private file, for private files you need to be logged in - builder: (context, snapshot) { - return snapshot.hasData && snapshot.data != null - ? Image.memory(snapshot.data) - : CircularProgressIndicator(); - } -); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/get-file.md b/docs/examples/1.6.x/client-flutter/examples/storage/get-file.md deleted file mode 100644 index 6127932b87..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/storage/get-file.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Storage storage = Storage(client); - -File result = await storage.getFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/list-files.md b/docs/examples/1.6.x/client-flutter/examples/storage/list-files.md deleted file mode 100644 index a72d279fe5..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/storage/list-files.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Storage storage = Storage(client); - -FileList result = await storage.listFiles( - bucketId: '<BUCKET_ID>', - queries: [], // optional - search: '<SEARCH>', // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/storage/update-file.md b/docs/examples/1.6.x/client-flutter/examples/storage/update-file.md deleted file mode 100644 index 320f24fb1e..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/storage/update-file.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Storage storage = Storage(client); - -File result = await storage.updateFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', - name: '<NAME>', // optional - permissions: ["read("any")"], // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/create-membership.md b/docs/examples/1.6.x/client-flutter/examples/teams/create-membership.md deleted file mode 100644 index b59c69c1ee..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/create-membership.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -Membership result = await teams.createMembership( - teamId: '<TEAM_ID>', - roles: [], - email: 'email@example.com', // optional - userId: '<USER_ID>', // optional - phone: '+12065550100', // optional - url: 'https://example.com', // optional - name: '<NAME>', // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/create.md b/docs/examples/1.6.x/client-flutter/examples/teams/create.md deleted file mode 100644 index 2cd7e4b2b2..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/create.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -Team result = await teams.create( - teamId: '<TEAM_ID>', - name: '<NAME>', - roles: [], // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-flutter/examples/teams/delete-membership.md deleted file mode 100644 index 6dfe00fda6..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/delete-membership.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -await teams.deleteMembership( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/delete.md b/docs/examples/1.6.x/client-flutter/examples/teams/delete.md deleted file mode 100644 index 3f6de53a4b..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/delete.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -await teams.delete( - teamId: '<TEAM_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/get-membership.md b/docs/examples/1.6.x/client-flutter/examples/teams/get-membership.md deleted file mode 100644 index 120c1294a0..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/get-membership.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -Membership result = await teams.getMembership( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-flutter/examples/teams/get-prefs.md deleted file mode 100644 index a8d41f2880..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/get-prefs.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -Preferences result = await teams.getPrefs( - teamId: '<TEAM_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/get.md b/docs/examples/1.6.x/client-flutter/examples/teams/get.md deleted file mode 100644 index c29cefa4a1..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -Team result = await teams.get( - teamId: '<TEAM_ID>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-flutter/examples/teams/list-memberships.md deleted file mode 100644 index 98557687f2..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/list-memberships.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -MembershipList result = await teams.listMemberships( - teamId: '<TEAM_ID>', - queries: [], // optional - search: '<SEARCH>', // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/list.md b/docs/examples/1.6.x/client-flutter/examples/teams/list.md deleted file mode 100644 index 3b70d3450d..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/list.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -TeamList result = await teams.list( - queries: [], // optional - search: '<SEARCH>', // optional -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-flutter/examples/teams/update-membership-status.md deleted file mode 100644 index 4e397747bb..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/update-membership-status.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -Membership result = await teams.updateMembershipStatus( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>', - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/update-membership.md b/docs/examples/1.6.x/client-flutter/examples/teams/update-membership.md deleted file mode 100644 index 93514b96e3..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/update-membership.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -Membership result = await teams.updateMembership( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>', - roles: [], -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/update-name.md b/docs/examples/1.6.x/client-flutter/examples/teams/update-name.md deleted file mode 100644 index 13623107eb..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/update-name.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -Team result = await teams.updateName( - teamId: '<TEAM_ID>', - name: '<NAME>', -); diff --git a/docs/examples/1.6.x/client-flutter/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-flutter/examples/teams/update-prefs.md deleted file mode 100644 index 071bd95129..0000000000 --- a/docs/examples/1.6.x/client-flutter/examples/teams/update-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:appwrite/appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Teams teams = Teams(client); - -Preferences result = await teams.updatePrefs( - teamId: '<TEAM_ID>', - prefs: {}, -); diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-graphql/examples/account/create-anonymous-session.md deleted file mode 100644 index 92c12acee5..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,33 +0,0 @@ -mutation { - accountCreateAnonymousSession { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-graphql/examples/account/create-email-password-session.md deleted file mode 100644 index 931bb4add0..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-email-password-session.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountCreateEmailPasswordSession( - email: "email@example.com", - password: "password" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-email-token.md b/docs/examples/1.6.x/client-graphql/examples/account/create-email-token.md deleted file mode 100644 index de320b45ed..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-email-token.md +++ /dev/null @@ -1,14 +0,0 @@ -mutation { - accountCreateEmailToken( - userId: "<USER_ID>", - email: "email@example.com", - phrase: false - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-graphql/examples/account/create-j-w-t.md deleted file mode 100644 index a5204f1256..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-j-w-t.md +++ /dev/null @@ -1,5 +0,0 @@ -mutation { - accountCreateJWT { - jwt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-graphql/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 4024a5b3a9..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,15 +0,0 @@ -mutation { - accountCreateMagicURLToken( - userId: "<USER_ID>", - email: "email@example.com", - url: "https://example.com", - phrase: false - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 6b29292494..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - accountCreateMfaAuthenticator( - type: "totp" - ) { - secret - uri - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-challenge.md deleted file mode 100644 index eb5cba127d..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,10 +0,0 @@ -mutation { - accountCreateMfaChallenge( - factor: "email" - ) { - _id - _createdAt - userId - expire - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index f39b7d080d..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,5 +0,0 @@ -mutation { - accountCreateMfaRecoveryCodes { - recoveryCodes - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-graphql/examples/account/create-phone-token.md deleted file mode 100644 index b56c4eb4e4..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-phone-token.md +++ /dev/null @@ -1,13 +0,0 @@ -mutation { - accountCreatePhoneToken( - userId: "<USER_ID>", - phone: "+12065550100" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-graphql/examples/account/create-phone-verification.md deleted file mode 100644 index a4cad59b1a..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-phone-verification.md +++ /dev/null @@ -1,10 +0,0 @@ -mutation { - accountCreatePhoneVerification { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-push-target.md b/docs/examples/1.6.x/client-graphql/examples/account/create-push-target.md deleted file mode 100644 index 8a0fad387c..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-push-target.md +++ /dev/null @@ -1,16 +0,0 @@ -mutation { - accountCreatePushTarget( - targetId: "<TARGET_ID>", - identifier: "<IDENTIFIER>", - providerId: "<PROVIDER_ID>" - ) { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-recovery.md b/docs/examples/1.6.x/client-graphql/examples/account/create-recovery.md deleted file mode 100644 index ad31fd82d7..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-recovery.md +++ /dev/null @@ -1,13 +0,0 @@ -mutation { - accountCreateRecovery( - email: "email@example.com", - url: "https://example.com" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-session.md b/docs/examples/1.6.x/client-graphql/examples/account/create-session.md deleted file mode 100644 index f473d14207..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-session.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountCreateSession( - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create-verification.md b/docs/examples/1.6.x/client-graphql/examples/account/create-verification.md deleted file mode 100644 index df50dda529..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -mutation { - accountCreateVerification( - url: "https://example.com" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/create.md b/docs/examples/1.6.x/client-graphql/examples/account/create.md deleted file mode 100644 index 3f8e3c3cf7..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/create.md +++ /dev/null @@ -1,39 +0,0 @@ -mutation { - accountCreate( - userId: "<USER_ID>", - email: "email@example.com", - password: "", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/delete-identity.md b/docs/examples/1.6.x/client-graphql/examples/account/delete-identity.md deleted file mode 100644 index f3c2e2e7b9..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/delete-identity.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - accountDeleteIdentity( - identityId: "<IDENTITY_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-graphql/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index fc5486623a..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - accountDeleteMfaAuthenticator( - type: "totp" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-graphql/examples/account/delete-push-target.md deleted file mode 100644 index 894c0b2e02..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/delete-push-target.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - accountDeletePushTarget( - targetId: "<TARGET_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/delete-session.md b/docs/examples/1.6.x/client-graphql/examples/account/delete-session.md deleted file mode 100644 index 09aff38fdd..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/delete-session.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - accountDeleteSession( - sessionId: "<SESSION_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-graphql/examples/account/delete-sessions.md deleted file mode 100644 index b0d61daa81..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/delete-sessions.md +++ /dev/null @@ -1,5 +0,0 @@ -mutation { - accountDeleteSessions { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-graphql/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index e2de72b57f..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,5 +0,0 @@ -query { - accountGetMfaRecoveryCodes { - recoveryCodes - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/get-prefs.md b/docs/examples/1.6.x/client-graphql/examples/account/get-prefs.md deleted file mode 100644 index 6cb48d2b58..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/get-prefs.md +++ /dev/null @@ -1,5 +0,0 @@ -query { - accountGetPrefs { - data - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/get-session.md b/docs/examples/1.6.x/client-graphql/examples/account/get-session.md deleted file mode 100644 index 65c824f68b..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/get-session.md +++ /dev/null @@ -1,35 +0,0 @@ -query { - accountGetSession( - sessionId: "<SESSION_ID>" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/get.md b/docs/examples/1.6.x/client-graphql/examples/account/get.md deleted file mode 100644 index e4db8f0e41..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/get.md +++ /dev/null @@ -1,34 +0,0 @@ -query { - accountGet { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/list-identities.md b/docs/examples/1.6.x/client-graphql/examples/account/list-identities.md deleted file mode 100644 index b7a2a6d39a..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/list-identities.md +++ /dev/null @@ -1,19 +0,0 @@ -query { - accountListIdentities( - queries: [] - ) { - total - identities { - _id - _createdAt - _updatedAt - userId - provider - providerUid - providerEmail - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/list-logs.md b/docs/examples/1.6.x/client-graphql/examples/account/list-logs.md deleted file mode 100644 index 1e17b2f69f..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/list-logs.md +++ /dev/null @@ -1,30 +0,0 @@ -query { - accountListLogs( - queries: [] - ) { - total - logs { - event - userId - userEmail - userName - mode - ip - time - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-graphql/examples/account/list-mfa-factors.md deleted file mode 100644 index 2a78b901b3..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,8 +0,0 @@ -query { - accountListMfaFactors { - totp - phone - email - recoveryCode - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/list-sessions.md b/docs/examples/1.6.x/client-graphql/examples/account/list-sessions.md deleted file mode 100644 index 6d45f1d4ae..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/list-sessions.md +++ /dev/null @@ -1,36 +0,0 @@ -query { - accountListSessions { - total - sessions { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-email.md b/docs/examples/1.6.x/client-graphql/examples/account/update-email.md deleted file mode 100644 index b207bad4bb..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-email.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - accountUpdateEmail( - email: "email@example.com", - password: "password" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-graphql/examples/account/update-m-f-a.md deleted file mode 100644 index d2cd3d6ae5..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-m-f-a.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountUpdateMFA( - mfa: false - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-graphql/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 075bc91d17..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountUpdateMagicURLSession( - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-authenticator.md deleted file mode 100644 index c74062c7d4..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - accountUpdateMfaAuthenticator( - type: "totp", - otp: "<OTP>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-challenge.md deleted file mode 100644 index 8237431bcf..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - accountUpdateMfaChallenge( - challengeId: "<CHALLENGE_ID>", - otp: "<OTP>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index e706d2b9d7..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,5 +0,0 @@ -mutation { - accountUpdateMfaRecoveryCodes { - recoveryCodes - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-name.md b/docs/examples/1.6.x/client-graphql/examples/account/update-name.md deleted file mode 100644 index 850b5760a0..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-name.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountUpdateName( - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-password.md b/docs/examples/1.6.x/client-graphql/examples/account/update-password.md deleted file mode 100644 index 5904da0842..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-password.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - accountUpdatePassword( - password: "", - oldPassword: "password" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-graphql/examples/account/update-phone-session.md deleted file mode 100644 index 199e774ab0..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-phone-session.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountUpdatePhoneSession( - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-graphql/examples/account/update-phone-verification.md deleted file mode 100644 index dd62298bb9..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -mutation { - accountUpdatePhoneVerification( - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-phone.md b/docs/examples/1.6.x/client-graphql/examples/account/update-phone.md deleted file mode 100644 index 408a203300..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-phone.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - accountUpdatePhone( - phone: "+12065550100", - password: "password" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-prefs.md b/docs/examples/1.6.x/client-graphql/examples/account/update-prefs.md deleted file mode 100644 index 40db7b43db..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-prefs.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountUpdatePrefs( - prefs: "{}" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-push-target.md b/docs/examples/1.6.x/client-graphql/examples/account/update-push-target.md deleted file mode 100644 index 059702dc97..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-push-target.md +++ /dev/null @@ -1,15 +0,0 @@ -mutation { - accountUpdatePushTarget( - targetId: "<TARGET_ID>", - identifier: "<IDENTIFIER>" - ) { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-recovery.md b/docs/examples/1.6.x/client-graphql/examples/account/update-recovery.md deleted file mode 100644 index 2d15fdcaa1..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -mutation { - accountUpdateRecovery( - userId: "<USER_ID>", - secret: "<SECRET>", - password: "" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-session.md b/docs/examples/1.6.x/client-graphql/examples/account/update-session.md deleted file mode 100644 index 29a8979872..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-session.md +++ /dev/null @@ -1,35 +0,0 @@ -mutation { - accountUpdateSession( - sessionId: "<SESSION_ID>" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-status.md b/docs/examples/1.6.x/client-graphql/examples/account/update-status.md deleted file mode 100644 index aca8c098e7..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-status.md +++ /dev/null @@ -1,34 +0,0 @@ -mutation { - accountUpdateStatus { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/account/update-verification.md b/docs/examples/1.6.x/client-graphql/examples/account/update-verification.md deleted file mode 100644 index 11e63c7da3..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/account/update-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -mutation { - accountUpdateVerification( - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-browser.md deleted file mode 100644 index 817e1e54c2..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/avatars/get-browser.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - avatarsGetBrowser( - code: "aa", - width: 0, - height: 0, - quality: 0 - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-credit-card.md deleted file mode 100644 index e4b5dc18d9..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - avatarsGetCreditCard( - code: "amex", - width: 0, - height: 0, - quality: 0 - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-favicon.md deleted file mode 100644 index bfea71f498..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/avatars/get-favicon.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - avatarsGetFavicon( - url: "https://example.com" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-flag.md deleted file mode 100644 index 1502128581..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/avatars/get-flag.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - avatarsGetFlag( - code: "af", - width: 0, - height: 0, - quality: 0 - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-image.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-image.md deleted file mode 100644 index 3b9aa104dc..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/avatars/get-image.md +++ /dev/null @@ -1,9 +0,0 @@ -query { - avatarsGetImage( - url: "https://example.com", - width: 0, - height: 0 - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-initials.md deleted file mode 100644 index 51ae36136b..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/avatars/get-initials.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - avatarsGetInitials( - name: "<NAME>", - width: 0, - height: 0, - background: "" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-graphql/examples/avatars/get-q-r.md deleted file mode 100644 index a19f218412..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/avatars/get-q-r.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - avatarsGetQR( - text: "<TEXT>", - size: 1, - margin: 0, - download: false - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/databases/create-document.md b/docs/examples/1.6.x/client-graphql/examples/databases/create-document.md deleted file mode 100644 index 4e2d90660b..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/databases/create-document.md +++ /dev/null @@ -1,17 +0,0 @@ -mutation { - databasesCreateDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - data: "{}", - permissions: ["read("any")"] - ) { - _id - _collectionId - _databaseId - _createdAt - _updatedAt - _permissions - data - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/databases/delete-document.md b/docs/examples/1.6.x/client-graphql/examples/databases/delete-document.md deleted file mode 100644 index 848371bca0..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/databases/delete-document.md +++ /dev/null @@ -1,9 +0,0 @@ -mutation { - databasesDeleteDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/databases/get-document.md b/docs/examples/1.6.x/client-graphql/examples/databases/get-document.md deleted file mode 100644 index 7cff0a18c1..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/databases/get-document.md +++ /dev/null @@ -1,16 +0,0 @@ -query { - databasesGetDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - queries: [] - ) { - _id - _collectionId - _databaseId - _createdAt - _updatedAt - _permissions - data - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/databases/list-documents.md b/docs/examples/1.6.x/client-graphql/examples/databases/list-documents.md deleted file mode 100644 index 077d7c8f12..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/databases/list-documents.md +++ /dev/null @@ -1,18 +0,0 @@ -query { - databasesListDocuments( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - queries: [] - ) { - total - documents { - _id - _collectionId - _databaseId - _createdAt - _updatedAt - _permissions - data - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/databases/update-document.md b/docs/examples/1.6.x/client-graphql/examples/databases/update-document.md deleted file mode 100644 index 5e80894620..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/databases/update-document.md +++ /dev/null @@ -1,17 +0,0 @@ -mutation { - databasesUpdateDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - data: "{}", - permissions: ["read("any")"] - ) { - _id - _collectionId - _databaseId - _createdAt - _updatedAt - _permissions - data - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/functions/create-execution.md b/docs/examples/1.6.x/client-graphql/examples/functions/create-execution.md deleted file mode 100644 index be459ee5ab..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/functions/create-execution.md +++ /dev/null @@ -1,34 +0,0 @@ -mutation { - functionsCreateExecution( - functionId: "<FUNCTION_ID>", - body: "<BODY>", - async: false, - path: "<PATH>", - method: "GET", - headers: "{}", - scheduledAt: "" - ) { - _id - _createdAt - _updatedAt - _permissions - functionId - trigger - status - requestMethod - requestPath - requestHeaders { - name - value - } - responseStatusCode - responseBody - responseHeaders { - name - value - } - logs - errors - duration - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/functions/get-execution.md b/docs/examples/1.6.x/client-graphql/examples/functions/get-execution.md deleted file mode 100644 index f9f8ef0552..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/functions/get-execution.md +++ /dev/null @@ -1,29 +0,0 @@ -query { - functionsGetExecution( - functionId: "<FUNCTION_ID>", - executionId: "<EXECUTION_ID>" - ) { - _id - _createdAt - _updatedAt - _permissions - functionId - trigger - status - requestMethod - requestPath - requestHeaders { - name - value - } - responseStatusCode - responseBody - responseHeaders { - name - value - } - logs - errors - duration - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/functions/list-executions.md b/docs/examples/1.6.x/client-graphql/examples/functions/list-executions.md deleted file mode 100644 index 745ec32377..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/functions/list-executions.md +++ /dev/null @@ -1,33 +0,0 @@ -query { - functionsListExecutions( - functionId: "<FUNCTION_ID>", - queries: [], - search: "<SEARCH>" - ) { - total - executions { - _id - _createdAt - _updatedAt - _permissions - functionId - trigger - status - requestMethod - requestPath - requestHeaders { - name - value - } - responseStatusCode - responseBody - responseHeaders { - name - value - } - logs - errors - duration - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/get.md b/docs/examples/1.6.x/client-graphql/examples/locale/get.md deleted file mode 100644 index 2b2bbcc1f1..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/locale/get.md +++ /dev/null @@ -1,11 +0,0 @@ -query { - localeGet { - ip - countryCode - country - continentCode - continent - eu - currency - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-codes.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-codes.md deleted file mode 100644 index 0164cc3782..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/locale/list-codes.md +++ /dev/null @@ -1,9 +0,0 @@ -query { - localeListCodes { - total - localeCodes { - code - name - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-continents.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-continents.md deleted file mode 100644 index 41f672c565..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/locale/list-continents.md +++ /dev/null @@ -1,9 +0,0 @@ -query { - localeListContinents { - total - continents { - name - code - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-e-u.md deleted file mode 100644 index 00cd4652f9..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,9 +0,0 @@ -query { - localeListCountriesEU { - total - countries { - name - code - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-phones.md deleted file mode 100644 index 33d2296850..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - localeListCountriesPhones { - total - phones { - code - countryCode - countryName - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-countries.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-countries.md deleted file mode 100644 index 9312bc94b1..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/locale/list-countries.md +++ /dev/null @@ -1,9 +0,0 @@ -query { - localeListCountries { - total - countries { - name - code - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-currencies.md deleted file mode 100644 index cde3ab488a..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/locale/list-currencies.md +++ /dev/null @@ -1,14 +0,0 @@ -query { - localeListCurrencies { - total - currencies { - symbol - name - symbolNative - decimalDigits - rounding - code - namePlural - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/locale/list-languages.md b/docs/examples/1.6.x/client-graphql/examples/locale/list-languages.md deleted file mode 100644 index b0d76c522b..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/locale/list-languages.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - localeListLanguages { - total - languages { - name - code - nativeName - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-graphql/examples/messaging/create-subscriber.md deleted file mode 100644 index b2712ebb48..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,26 +0,0 @@ -mutation { - messagingCreateSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>", - targetId: "<TARGET_ID>" - ) { - _id - _createdAt - _updatedAt - targetId - target { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - userId - userName - topicId - providerType - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-graphql/examples/messaging/delete-subscriber.md deleted file mode 100644 index ededffcaac..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - messagingDeleteSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/create-file.md b/docs/examples/1.6.x/client-graphql/examples/storage/create-file.md deleted file mode 100644 index ef4b5d1eb3..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/storage/create-file.md +++ /dev/null @@ -1,25 +0,0 @@ -POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> -Content-Length: *Length of your entity body in bytes* - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="operations" - -{ "query": "mutation { storageCreateFile(bucketId: $bucketId, fileId: $fileId, file: $file, permissions: $permissions) { id }" }, "variables": { "bucketId": "<BUCKET_ID>", "fileId": "<FILE_ID>", "file": null, "permissions": ["read("any")"] } } - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="map" - -{ "0": ["variables.file"], } - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="0"; filename="file.ext" - -File contents - ---cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/delete-file.md b/docs/examples/1.6.x/client-graphql/examples/storage/delete-file.md deleted file mode 100644 index 17ec89931a..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/storage/delete-file.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - storageDeleteFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-graphql/examples/storage/get-file-download.md deleted file mode 100644 index 8325e8a230..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/storage/get-file-download.md +++ /dev/null @@ -1,8 +0,0 @@ -query { - storageGetFileDownload( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-graphql/examples/storage/get-file-preview.md deleted file mode 100644 index df32e88350..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/storage/get-file-preview.md +++ /dev/null @@ -1,19 +0,0 @@ -query { - storageGetFilePreview( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - width: 0, - height: 0, - gravity: "center", - quality: 0, - borderWidth: 0, - borderColor: "", - borderRadius: 0, - opacity: 0, - rotation: -360, - background: "", - output: "jpg" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-graphql/examples/storage/get-file-view.md deleted file mode 100644 index 434328a1ec..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/storage/get-file-view.md +++ /dev/null @@ -1,8 +0,0 @@ -query { - storageGetFileView( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/get-file.md b/docs/examples/1.6.x/client-graphql/examples/storage/get-file.md deleted file mode 100644 index 60886b0f6f..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/storage/get-file.md +++ /dev/null @@ -1,18 +0,0 @@ -query { - storageGetFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" - ) { - _id - bucketId - _createdAt - _updatedAt - _permissions - name - signature - mimeType - sizeOriginal - chunksTotal - chunksUploaded - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/list-files.md b/docs/examples/1.6.x/client-graphql/examples/storage/list-files.md deleted file mode 100644 index 774cc51b97..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/storage/list-files.md +++ /dev/null @@ -1,22 +0,0 @@ -query { - storageListFiles( - bucketId: "<BUCKET_ID>", - queries: [], - search: "<SEARCH>" - ) { - total - files { - _id - bucketId - _createdAt - _updatedAt - _permissions - name - signature - mimeType - sizeOriginal - chunksTotal - chunksUploaded - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/storage/update-file.md b/docs/examples/1.6.x/client-graphql/examples/storage/update-file.md deleted file mode 100644 index b7832048c7..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/storage/update-file.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - storageUpdateFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - name: "<NAME>", - permissions: ["read("any")"] - ) { - _id - bucketId - _createdAt - _updatedAt - _permissions - name - signature - mimeType - sizeOriginal - chunksTotal - chunksUploaded - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/create-membership.md b/docs/examples/1.6.x/client-graphql/examples/teams/create-membership.md deleted file mode 100644 index fe741f080d..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/create-membership.md +++ /dev/null @@ -1,25 +0,0 @@ -mutation { - teamsCreateMembership( - teamId: "<TEAM_ID>", - roles: [], - email: "email@example.com", - userId: "<USER_ID>", - phone: "+12065550100", - url: "https://example.com", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - userId - userName - userEmail - teamId - teamName - invited - joined - confirm - mfa - roles - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/create.md b/docs/examples/1.6.x/client-graphql/examples/teams/create.md deleted file mode 100644 index 1f2a7ab3f2..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/create.md +++ /dev/null @@ -1,16 +0,0 @@ -mutation { - teamsCreate( - teamId: "<TEAM_ID>", - name: "<NAME>", - roles: [] - ) { - _id - _createdAt - _updatedAt - name - total - prefs { - data - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-graphql/examples/teams/delete-membership.md deleted file mode 100644 index e391b6f6fa..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/delete-membership.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - teamsDeleteMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/delete.md b/docs/examples/1.6.x/client-graphql/examples/teams/delete.md deleted file mode 100644 index df0d36c5b5..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/delete.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - teamsDelete( - teamId: "<TEAM_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/get-membership.md b/docs/examples/1.6.x/client-graphql/examples/teams/get-membership.md deleted file mode 100644 index c33528609e..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/get-membership.md +++ /dev/null @@ -1,20 +0,0 @@ -query { - teamsGetMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>" - ) { - _id - _createdAt - _updatedAt - userId - userName - userEmail - teamId - teamName - invited - joined - confirm - mfa - roles - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-graphql/examples/teams/get-prefs.md deleted file mode 100644 index fe498079cf..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/get-prefs.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - teamsGetPrefs( - teamId: "<TEAM_ID>" - ) { - data - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/get.md b/docs/examples/1.6.x/client-graphql/examples/teams/get.md deleted file mode 100644 index a3fbb491e0..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/get.md +++ /dev/null @@ -1,14 +0,0 @@ -query { - teamsGet( - teamId: "<TEAM_ID>" - ) { - _id - _createdAt - _updatedAt - name - total - prefs { - data - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-graphql/examples/teams/list-memberships.md deleted file mode 100644 index bf7f0d1eed..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/list-memberships.md +++ /dev/null @@ -1,24 +0,0 @@ -query { - teamsListMemberships( - teamId: "<TEAM_ID>", - queries: [], - search: "<SEARCH>" - ) { - total - memberships { - _id - _createdAt - _updatedAt - userId - userName - userEmail - teamId - teamName - invited - joined - confirm - mfa - roles - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/list.md b/docs/examples/1.6.x/client-graphql/examples/teams/list.md deleted file mode 100644 index e7005b5326..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/list.md +++ /dev/null @@ -1,18 +0,0 @@ -query { - teamsList( - queries: [], - search: "<SEARCH>" - ) { - total - teams { - _id - _createdAt - _updatedAt - name - total - prefs { - data - } - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-graphql/examples/teams/update-membership-status.md deleted file mode 100644 index 9b24450a86..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/update-membership-status.md +++ /dev/null @@ -1,22 +0,0 @@ -mutation { - teamsUpdateMembershipStatus( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>", - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - _updatedAt - userId - userName - userEmail - teamId - teamName - invited - joined - confirm - mfa - roles - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/update-membership.md b/docs/examples/1.6.x/client-graphql/examples/teams/update-membership.md deleted file mode 100644 index 1c6a04f078..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/update-membership.md +++ /dev/null @@ -1,21 +0,0 @@ -mutation { - teamsUpdateMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>", - roles: [] - ) { - _id - _createdAt - _updatedAt - userId - userName - userEmail - teamId - teamName - invited - joined - confirm - mfa - roles - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/update-name.md b/docs/examples/1.6.x/client-graphql/examples/teams/update-name.md deleted file mode 100644 index c40543b5cd..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/update-name.md +++ /dev/null @@ -1,15 +0,0 @@ -mutation { - teamsUpdateName( - teamId: "<TEAM_ID>", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - total - prefs { - data - } - } -} diff --git a/docs/examples/1.6.x/client-graphql/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-graphql/examples/teams/update-prefs.md deleted file mode 100644 index 95737e33f9..0000000000 --- a/docs/examples/1.6.x/client-graphql/examples/teams/update-prefs.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - teamsUpdatePrefs( - teamId: "<TEAM_ID>", - prefs: "{}" - ) { - data - } -} diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-react-native/examples/account/create-anonymous-session.md deleted file mode 100644 index d855c379d4..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createAnonymousSession(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-react-native/examples/account/create-email-password-session.md deleted file mode 100644 index 9600a094c9..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-email-password-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createEmailPasswordSession( - 'email@example.com', // email - 'password' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-email-token.md b/docs/examples/1.6.x/client-react-native/examples/account/create-email-token.md deleted file mode 100644 index 46756da4b1..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-email-token.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createEmailToken( - '<USER_ID>', // userId - 'email@example.com', // email - false // phrase (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-react-native/examples/account/create-j-w-t.md deleted file mode 100644 index e8c7ea61aa..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-j-w-t.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createJWT(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-react-native/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 10d687f8f9..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMagicURLToken( - '<USER_ID>', // userId - 'email@example.com', // email - 'https://example.com', // url (optional) - false // phrase (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-authenticator.md deleted file mode 100644 index cd0a0db104..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account, AuthenticatorType } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMfaAuthenticator( - AuthenticatorType.Totp // type -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-challenge.md deleted file mode 100644 index 0a4d0e7965..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account, AuthenticationFactor } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMfaChallenge( - AuthenticationFactor.Email // factor -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index 3282913816..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMfaRecoveryCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2session.md deleted file mode 100644 index 06d96a2e2c..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2session.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account, OAuthProvider } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -account.createOAuth2Session( - OAuthProvider.Amazon, // provider - 'https://example.com', // success (optional) - 'https://example.com', // failure (optional) - [] // scopes (optional) -); - diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2token.md deleted file mode 100644 index 8711a64697..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account, OAuthProvider } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -account.createOAuth2Token( - OAuthProvider.Amazon, // provider - 'https://example.com', // success (optional) - 'https://example.com', // failure (optional) - [] // scopes (optional) -); - diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-react-native/examples/account/create-phone-token.md deleted file mode 100644 index 7e888fe5f5..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-phone-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createPhoneToken( - '<USER_ID>', // userId - '+12065550100' // phone -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-react-native/examples/account/create-phone-verification.md deleted file mode 100644 index f87609a889..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-phone-verification.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createPhoneVerification(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-push-target.md b/docs/examples/1.6.x/client-react-native/examples/account/create-push-target.md deleted file mode 100644 index 23edfc5a8c..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-push-target.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createPushTarget( - '<TARGET_ID>', // targetId - '<IDENTIFIER>', // identifier - '<PROVIDER_ID>' // providerId (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-recovery.md b/docs/examples/1.6.x/client-react-native/examples/account/create-recovery.md deleted file mode 100644 index f720d29aff..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createRecovery( - 'email@example.com', // email - 'https://example.com' // url -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-session.md b/docs/examples/1.6.x/client-react-native/examples/account/create-session.md deleted file mode 100644 index ffa927c1f7..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create-verification.md b/docs/examples/1.6.x/client-react-native/examples/account/create-verification.md deleted file mode 100644 index b0ccc747cc..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createVerification( - 'https://example.com' // url -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/create.md b/docs/examples/1.6.x/client-react-native/examples/account/create.md deleted file mode 100644 index 28392f294b..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/create.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.create( - '<USER_ID>', // userId - 'email@example.com', // email - '', // password - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/delete-identity.md b/docs/examples/1.6.x/client-react-native/examples/account/delete-identity.md deleted file mode 100644 index d64d421779..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/delete-identity.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteIdentity( - '<IDENTITY_ID>' // identityId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-react-native/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 576f6ab71a..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account, AuthenticatorType } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteMfaAuthenticator( - AuthenticatorType.Totp // type -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-react-native/examples/account/delete-push-target.md deleted file mode 100644 index 06d5ca4281..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/delete-push-target.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deletePushTarget( - '<TARGET_ID>' // targetId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/delete-session.md b/docs/examples/1.6.x/client-react-native/examples/account/delete-session.md deleted file mode 100644 index 19c15ac240..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/delete-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteSession( - '<SESSION_ID>' // sessionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-react-native/examples/account/delete-sessions.md deleted file mode 100644 index 707894f87e..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/delete-sessions.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteSessions(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-react-native/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index 037c9f89b1..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.getMfaRecoveryCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/get-prefs.md b/docs/examples/1.6.x/client-react-native/examples/account/get-prefs.md deleted file mode 100644 index 1e287b1356..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/get-prefs.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.getPrefs(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/get-session.md b/docs/examples/1.6.x/client-react-native/examples/account/get-session.md deleted file mode 100644 index 5702e1cfa1..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/get-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.getSession( - '<SESSION_ID>' // sessionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/get.md b/docs/examples/1.6.x/client-react-native/examples/account/get.md deleted file mode 100644 index f6eb57d485..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.get(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/list-identities.md b/docs/examples/1.6.x/client-react-native/examples/account/list-identities.md deleted file mode 100644 index ed979959bc..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/list-identities.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listIdentities( - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/list-logs.md b/docs/examples/1.6.x/client-react-native/examples/account/list-logs.md deleted file mode 100644 index cbe8c1553e..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/list-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listLogs( - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-react-native/examples/account/list-mfa-factors.md deleted file mode 100644 index 1903b161a7..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listMfaFactors(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/list-sessions.md b/docs/examples/1.6.x/client-react-native/examples/account/list-sessions.md deleted file mode 100644 index 2a361ad9f9..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/list-sessions.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listSessions(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-email.md b/docs/examples/1.6.x/client-react-native/examples/account/update-email.md deleted file mode 100644 index 1fe1395f48..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-email.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateEmail( - 'email@example.com', // email - 'password' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-react-native/examples/account/update-m-f-a.md deleted file mode 100644 index a6b7d64cf7..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-m-f-a.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMFA( - false // mfa -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-react-native/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 93b3df9d6d..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMagicURLSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-authenticator.md deleted file mode 100644 index babd600ded..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account, AuthenticatorType } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMfaAuthenticator( - AuthenticatorType.Totp, // type - '<OTP>' // otp -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-challenge.md deleted file mode 100644 index 6fe5336d95..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMfaChallenge( - '<CHALLENGE_ID>', // challengeId - '<OTP>' // otp -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index ecd05692ef..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMfaRecoveryCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-name.md b/docs/examples/1.6.x/client-react-native/examples/account/update-name.md deleted file mode 100644 index 6643ba6d33..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateName( - '<NAME>' // name -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-password.md b/docs/examples/1.6.x/client-react-native/examples/account/update-password.md deleted file mode 100644 index b462b0429a..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-password.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePassword( - '', // password - 'password' // oldPassword (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-react-native/examples/account/update-phone-session.md deleted file mode 100644 index ed9729a11b..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-phone-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePhoneSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-react-native/examples/account/update-phone-verification.md deleted file mode 100644 index 65caeddd8e..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-phone-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePhoneVerification( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-phone.md b/docs/examples/1.6.x/client-react-native/examples/account/update-phone.md deleted file mode 100644 index 8e08328e76..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-phone.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePhone( - '+12065550100', // phone - 'password' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-prefs.md b/docs/examples/1.6.x/client-react-native/examples/account/update-prefs.md deleted file mode 100644 index e5e7012bed..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePrefs( - {} // prefs -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-push-target.md b/docs/examples/1.6.x/client-react-native/examples/account/update-push-target.md deleted file mode 100644 index a795acd58d..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-push-target.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePushTarget( - '<TARGET_ID>', // targetId - '<IDENTIFIER>' // identifier -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-recovery.md b/docs/examples/1.6.x/client-react-native/examples/account/update-recovery.md deleted file mode 100644 index 8956b4d9d1..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-recovery.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateRecovery( - '<USER_ID>', // userId - '<SECRET>', // secret - '' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-session.md b/docs/examples/1.6.x/client-react-native/examples/account/update-session.md deleted file mode 100644 index 57d4593f34..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateSession( - '<SESSION_ID>' // sessionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-status.md b/docs/examples/1.6.x/client-react-native/examples/account/update-status.md deleted file mode 100644 index 2cb1045ff8..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-status.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateStatus(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/account/update-verification.md b/docs/examples/1.6.x/client-react-native/examples/account/update-verification.md deleted file mode 100644 index 80e885764b..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/account/update-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateVerification( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-browser.md deleted file mode 100644 index 404f9af77b..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/avatars/get-browser.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars, Browser } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getBrowser( - Browser.AvantBrowser, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-credit-card.md deleted file mode 100644 index a34ab2b603..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars, CreditCard } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getCreditCard( - CreditCard.AmericanExpress, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-favicon.md deleted file mode 100644 index c3ad663aff..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/avatars/get-favicon.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Avatars } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getFavicon( - 'https://example.com' // url -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-flag.md deleted file mode 100644 index 23698ac670..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/avatars/get-flag.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars, Flag } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getFlag( - Flag.Afghanistan, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-image.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-image.md deleted file mode 100644 index 915f5b0d4a..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/avatars/get-image.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Avatars } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getImage( - 'https://example.com', // url - 0, // width (optional) - 0 // height (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-initials.md deleted file mode 100644 index c5190514f4..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/avatars/get-initials.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getInitials( - '<NAME>', // name (optional) - 0, // width (optional) - 0, // height (optional) - '' // background (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-react-native/examples/avatars/get-q-r.md deleted file mode 100644 index 1191da7787..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/avatars/get-q-r.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getQR( - '<TEXT>', // text - 1, // size (optional) - 0, // margin (optional) - false // download (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/databases/create-document.md b/docs/examples/1.6.x/client-react-native/examples/databases/create-document.md deleted file mode 100644 index 9c6a747254..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/databases/create-document.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - {}, // data - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/databases/delete-document.md b/docs/examples/1.6.x/client-react-native/examples/databases/delete-document.md deleted file mode 100644 index dad2ecdf4e..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/databases/delete-document.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.deleteDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>' // documentId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/databases/get-document.md b/docs/examples/1.6.x/client-react-native/examples/databases/get-document.md deleted file mode 100644 index aa63eb2378..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/databases/get-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.getDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/databases/list-documents.md b/docs/examples/1.6.x/client-react-native/examples/databases/list-documents.md deleted file mode 100644 index 2de7ad2441..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/databases/list-documents.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.listDocuments( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/databases/update-document.md b/docs/examples/1.6.x/client-react-native/examples/databases/update-document.md deleted file mode 100644 index 7c8f51d4e9..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/databases/update-document.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - {}, // data (optional) - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/functions/create-execution.md b/docs/examples/1.6.x/client-react-native/examples/functions/create-execution.md deleted file mode 100644 index 3d2c88768e..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/functions/create-execution.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Functions, ExecutionMethod } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.createExecution( - '<FUNCTION_ID>', // functionId - '<BODY>', // body (optional) - false, // async (optional) - '<PATH>', // path (optional) - ExecutionMethod.GET, // method (optional) - {}, // headers (optional) - '' // scheduledAt (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/functions/get-execution.md b/docs/examples/1.6.x/client-react-native/examples/functions/get-execution.md deleted file mode 100644 index 4b9a00256e..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/functions/get-execution.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.getExecution( - '<FUNCTION_ID>', // functionId - '<EXECUTION_ID>' // executionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/functions/list-executions.md b/docs/examples/1.6.x/client-react-native/examples/functions/list-executions.md deleted file mode 100644 index 5bf1c15a3b..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/functions/list-executions.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Functions } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.listExecutions( - '<FUNCTION_ID>', // functionId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/graphql/mutation.md b/docs/examples/1.6.x/client-react-native/examples/graphql/mutation.md deleted file mode 100644 index 836d33adf9..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/graphql/mutation.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Graphql } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const graphql = new Graphql(client); - -const result = await graphql.mutation( - {} // query -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/graphql/query.md b/docs/examples/1.6.x/client-react-native/examples/graphql/query.md deleted file mode 100644 index a6a34d4ceb..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/graphql/query.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Graphql } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const graphql = new Graphql(client); - -const result = await graphql.query( - {} // query -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/get.md b/docs/examples/1.6.x/client-react-native/examples/locale/get.md deleted file mode 100644 index 151e125104..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/locale/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.get(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-codes.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-codes.md deleted file mode 100644 index ade8c98a27..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/locale/list-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-continents.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-continents.md deleted file mode 100644 index 8924cbacef..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/locale/list-continents.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listContinents(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-e-u.md deleted file mode 100644 index 24677ef501..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCountriesEU(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-phones.md deleted file mode 100644 index 2c4a2331cc..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCountriesPhones(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-countries.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-countries.md deleted file mode 100644 index 785faab399..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/locale/list-countries.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCountries(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-currencies.md deleted file mode 100644 index 20a876e8f7..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/locale/list-currencies.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCurrencies(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/locale/list-languages.md b/docs/examples/1.6.x/client-react-native/examples/locale/list-languages.md deleted file mode 100644 index e15eb61bc0..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/locale/list-languages.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listLanguages(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-react-native/examples/messaging/create-subscriber.md deleted file mode 100644 index c6a1f94c32..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Messaging } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>', // subscriberId - '<TARGET_ID>' // targetId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-react-native/examples/messaging/delete-subscriber.md deleted file mode 100644 index 4232dccbcb..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.deleteSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>' // subscriberId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/create-file.md b/docs/examples/1.6.x/client-react-native/examples/storage/create-file.md deleted file mode 100644 index abeee020e7..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/storage/create-file.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Storage } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.createFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - await pickSingle(), // file - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/delete-file.md b/docs/examples/1.6.x/client-react-native/examples/storage/delete-file.md deleted file mode 100644 index af7136c87b..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/storage/delete-file.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.deleteFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-react-native/examples/storage/get-file-download.md deleted file mode 100644 index 740cb26058..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/storage/get-file-download.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = storage.getFileDownload( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-react-native/examples/storage/get-file-preview.md deleted file mode 100644 index 0fb97a1633..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/storage/get-file-preview.md +++ /dev/null @@ -1,25 +0,0 @@ -import { Client, Storage, ImageGravity, ImageFormat } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = storage.getFilePreview( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - 0, // width (optional) - 0, // height (optional) - ImageGravity.Center, // gravity (optional) - 0, // quality (optional) - 0, // borderWidth (optional) - '', // borderColor (optional) - 0, // borderRadius (optional) - 0, // opacity (optional) - -360, // rotation (optional) - '', // background (optional) - ImageFormat.Jpg // output (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-react-native/examples/storage/get-file-view.md deleted file mode 100644 index 4628bc0992..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/storage/get-file-view.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = storage.getFileView( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/get-file.md b/docs/examples/1.6.x/client-react-native/examples/storage/get-file.md deleted file mode 100644 index 3f9c4a0498..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/storage/get-file.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.getFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/list-files.md b/docs/examples/1.6.x/client-react-native/examples/storage/list-files.md deleted file mode 100644 index 0d81716948..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/storage/list-files.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Storage } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.listFiles( - '<BUCKET_ID>', // bucketId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/storage/update-file.md b/docs/examples/1.6.x/client-react-native/examples/storage/update-file.md deleted file mode 100644 index 4e6ed70572..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/storage/update-file.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Storage } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.updateFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - '<NAME>', // name (optional) - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/create-membership.md b/docs/examples/1.6.x/client-react-native/examples/teams/create-membership.md deleted file mode 100644 index 0759c035a8..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/create-membership.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.createMembership( - '<TEAM_ID>', // teamId - [], // roles - 'email@example.com', // email (optional) - '<USER_ID>', // userId (optional) - '+12065550100', // phone (optional) - 'https://example.com', // url (optional) - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/create.md b/docs/examples/1.6.x/client-react-native/examples/teams/create.md deleted file mode 100644 index 3e24dcab9e..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/create.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.create( - '<TEAM_ID>', // teamId - '<NAME>', // name - [] // roles (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-react-native/examples/teams/delete-membership.md deleted file mode 100644 index 92b00c71f1..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/delete-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.deleteMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>' // membershipId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/delete.md b/docs/examples/1.6.x/client-react-native/examples/teams/delete.md deleted file mode 100644 index e51e465173..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.delete( - '<TEAM_ID>' // teamId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/get-membership.md b/docs/examples/1.6.x/client-react-native/examples/teams/get-membership.md deleted file mode 100644 index b5fb0dd481..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/get-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.getMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>' // membershipId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-react-native/examples/teams/get-prefs.md deleted file mode 100644 index 1baee59dee..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/get-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.getPrefs( - '<TEAM_ID>' // teamId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/get.md b/docs/examples/1.6.x/client-react-native/examples/teams/get.md deleted file mode 100644 index a4aabd072d..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.get( - '<TEAM_ID>' // teamId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-react-native/examples/teams/list-memberships.md deleted file mode 100644 index 7d16a57c21..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/list-memberships.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.listMemberships( - '<TEAM_ID>', // teamId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/list.md b/docs/examples/1.6.x/client-react-native/examples/teams/list.md deleted file mode 100644 index fcf459e244..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-react-native/examples/teams/update-membership-status.md deleted file mode 100644 index e60e31b4fb..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/update-membership-status.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updateMembershipStatus( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>', // membershipId - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/update-membership.md b/docs/examples/1.6.x/client-react-native/examples/teams/update-membership.md deleted file mode 100644 index 4201207a14..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/update-membership.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updateMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>', // membershipId - [] // roles -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/update-name.md b/docs/examples/1.6.x/client-react-native/examples/teams/update-name.md deleted file mode 100644 index a8ecbc27ca..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/update-name.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updateName( - '<TEAM_ID>', // teamId - '<NAME>' // name -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-react-native/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-react-native/examples/teams/update-prefs.md deleted file mode 100644 index 944ed43281..0000000000 --- a/docs/examples/1.6.x/client-react-native/examples/teams/update-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "react-native-appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updatePrefs( - '<TEAM_ID>', // teamId - {} // prefs -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-rest/examples/account/create-anonymous-session.md deleted file mode 100644 index 772e31903e..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,6 +0,0 @@ -POST /v1/account/sessions/anonymous HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-rest/examples/account/create-email-password-session.md deleted file mode 100644 index bee865dac0..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-email-password-session.md +++ /dev/null @@ -1,10 +0,0 @@ -POST /v1/account/sessions/email HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "email": "email@example.com", - "password": "password" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-email-token.md b/docs/examples/1.6.x/client-rest/examples/account/create-email-token.md deleted file mode 100644 index 206711b906..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-email-token.md +++ /dev/null @@ -1,11 +0,0 @@ -POST /v1/account/tokens/email HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "phrase": false -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-rest/examples/account/create-j-w-t.md deleted file mode 100644 index 83169a46f9..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-j-w-t.md +++ /dev/null @@ -1,6 +0,0 @@ -POST /v1/account/jwts HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-rest/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 43b946c7b6..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/account/tokens/magic-url HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "url": "https://example.com", - "phrase": false -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-rest/examples/account/create-mfa-authenticator.md deleted file mode 100644 index baacbbe18b..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,8 +0,0 @@ -POST /v1/account/mfa/authenticators/{type} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-rest/examples/account/create-mfa-challenge.md deleted file mode 100644 index 991710a0cb..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,9 +0,0 @@ -POST /v1/account/mfa/challenge HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "factor": "email" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-rest/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index b7214f244d..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,8 +0,0 @@ -POST /v1/account/mfa/recovery-codes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2session.md deleted file mode 100644 index d7b113f675..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2session.md +++ /dev/null @@ -1,6 +0,0 @@ -GET /v1/account/sessions/oauth2/{provider} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2token.md deleted file mode 100644 index 99abb6d4a9..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,6 +0,0 @@ -GET /v1/account/tokens/oauth2/{provider} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-rest/examples/account/create-phone-token.md deleted file mode 100644 index 4a9a99c949..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-phone-token.md +++ /dev/null @@ -1,10 +0,0 @@ -POST /v1/account/tokens/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "phone": "+12065550100" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-rest/examples/account/create-phone-verification.md deleted file mode 100644 index 3811b6a523..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-phone-verification.md +++ /dev/null @@ -1,8 +0,0 @@ -POST /v1/account/verification/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-push-target.md b/docs/examples/1.6.x/client-rest/examples/account/create-push-target.md deleted file mode 100644 index 0c92fa059e..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-push-target.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/account/targets/push HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: - -{ - "targetId": "<TARGET_ID>", - "identifier": "<IDENTIFIER>", - "providerId": "<PROVIDER_ID>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-recovery.md b/docs/examples/1.6.x/client-rest/examples/account/create-recovery.md deleted file mode 100644 index f8f0a9cdd6..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-recovery.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/account/recovery HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "email": "email@example.com", - "url": "https://example.com" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-session.md b/docs/examples/1.6.x/client-rest/examples/account/create-session.md deleted file mode 100644 index 2a9108c0f4..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-session.md +++ /dev/null @@ -1,10 +0,0 @@ -POST /v1/account/sessions/token HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create-verification.md b/docs/examples/1.6.x/client-rest/examples/account/create-verification.md deleted file mode 100644 index 7582b81d01..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create-verification.md +++ /dev/null @@ -1,11 +0,0 @@ -POST /v1/account/verification HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "url": "https://example.com" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/create.md b/docs/examples/1.6.x/client-rest/examples/account/create.md deleted file mode 100644 index ec4b11df00..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/create.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/account HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "password": , - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/delete-identity.md b/docs/examples/1.6.x/client-rest/examples/account/delete-identity.md deleted file mode 100644 index 01df4d7e90..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/delete-identity.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/account/identities/{identityId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-rest/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 25b1733019..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/account/mfa/authenticators/{type} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-rest/examples/account/delete-push-target.md deleted file mode 100644 index fa972cedb3..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/delete-push-target.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/account/targets/{targetId}/push HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: - diff --git a/docs/examples/1.6.x/client-rest/examples/account/delete-session.md b/docs/examples/1.6.x/client-rest/examples/account/delete-session.md deleted file mode 100644 index f8d4c0035f..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/delete-session.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/account/sessions/{sessionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-rest/examples/account/delete-sessions.md deleted file mode 100644 index 1e9d00b1ca..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/delete-sessions.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/account/sessions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-rest/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index cb27036775..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/mfa/recovery-codes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/get-prefs.md b/docs/examples/1.6.x/client-rest/examples/account/get-prefs.md deleted file mode 100644 index c0513aa8b6..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/get-prefs.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/prefs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/get-session.md b/docs/examples/1.6.x/client-rest/examples/account/get-session.md deleted file mode 100644 index 64950545ec..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/get-session.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/sessions/{sessionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/get.md b/docs/examples/1.6.x/client-rest/examples/account/get.md deleted file mode 100644 index 40841841e5..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/get.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/list-identities.md b/docs/examples/1.6.x/client-rest/examples/account/list-identities.md deleted file mode 100644 index 2ea442b347..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/list-identities.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/identities HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/list-logs.md b/docs/examples/1.6.x/client-rest/examples/account/list-logs.md deleted file mode 100644 index 9d1589e9a2..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/list-logs.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/logs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-rest/examples/account/list-mfa-factors.md deleted file mode 100644 index 5b12a4948a..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/mfa/factors HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/list-sessions.md b/docs/examples/1.6.x/client-rest/examples/account/list-sessions.md deleted file mode 100644 index 39ee92bb20..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/list-sessions.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/sessions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-email.md b/docs/examples/1.6.x/client-rest/examples/account/update-email.md deleted file mode 100644 index 4c9723d856..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-email.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/account/email HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "email": "email@example.com", - "password": "password" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-rest/examples/account/update-m-f-a.md deleted file mode 100644 index 668cc887a0..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-m-f-a.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/account/mfa HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "mfa": false -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-rest/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index b568b35c55..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,10 +0,0 @@ -PUT /v1/account/sessions/magic-url HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-rest/examples/account/update-mfa-authenticator.md deleted file mode 100644 index 3048091fb7..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,11 +0,0 @@ -PUT /v1/account/mfa/authenticators/{type} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "otp": "<OTP>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-rest/examples/account/update-mfa-challenge.md deleted file mode 100644 index 33d5fe45d5..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,12 +0,0 @@ -PUT /v1/account/mfa/challenge HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "challengeId": "<CHALLENGE_ID>", - "otp": "<OTP>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-rest/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index 353908edcf..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,8 +0,0 @@ -PATCH /v1/account/mfa/recovery-codes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-name.md b/docs/examples/1.6.x/client-rest/examples/account/update-name.md deleted file mode 100644 index 43d100c8f5..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-name.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/account/name HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-password.md b/docs/examples/1.6.x/client-rest/examples/account/update-password.md deleted file mode 100644 index e35d9a8c76..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-password.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/account/password HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "password": , - "oldPassword": "password" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-rest/examples/account/update-phone-session.md deleted file mode 100644 index 540267f6d8..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-phone-session.md +++ /dev/null @@ -1,10 +0,0 @@ -PUT /v1/account/sessions/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-rest/examples/account/update-phone-verification.md deleted file mode 100644 index 301f0b1057..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-phone-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -PUT /v1/account/verification/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-phone.md b/docs/examples/1.6.x/client-rest/examples/account/update-phone.md deleted file mode 100644 index ea35a1b8ca..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-phone.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/account/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "phone": "+12065550100", - "password": "password" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-prefs.md b/docs/examples/1.6.x/client-rest/examples/account/update-prefs.md deleted file mode 100644 index 87af8ec625..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-prefs.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/account/prefs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "prefs": {} -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-push-target.md b/docs/examples/1.6.x/client-rest/examples/account/update-push-target.md deleted file mode 100644 index c3121581d7..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-push-target.md +++ /dev/null @@ -1,10 +0,0 @@ -PUT /v1/account/targets/{targetId}/push HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: - -{ - "identifier": "<IDENTIFIER>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-recovery.md b/docs/examples/1.6.x/client-rest/examples/account/update-recovery.md deleted file mode 100644 index 77ae28a33d..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-recovery.md +++ /dev/null @@ -1,13 +0,0 @@ -PUT /v1/account/recovery HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>", - "password": -} diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-session.md b/docs/examples/1.6.x/client-rest/examples/account/update-session.md deleted file mode 100644 index d8a7b97f3c..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-session.md +++ /dev/null @@ -1,8 +0,0 @@ -PATCH /v1/account/sessions/{sessionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-status.md b/docs/examples/1.6.x/client-rest/examples/account/update-status.md deleted file mode 100644 index b10060a866..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-status.md +++ /dev/null @@ -1,8 +0,0 @@ -PATCH /v1/account/status HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/account/update-verification.md b/docs/examples/1.6.x/client-rest/examples/account/update-verification.md deleted file mode 100644 index cd6c2f9e88..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/account/update-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -PUT /v1/account/verification HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-browser.md deleted file mode 100644 index 130e05757a..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/avatars/get-browser.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/avatars/browsers/{code} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-credit-card.md deleted file mode 100644 index 1f6b38fd87..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/avatars/credit-cards/{code} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-favicon.md deleted file mode 100644 index 6aafed5f0d..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/avatars/get-favicon.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/avatars/favicon HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-flag.md deleted file mode 100644 index e3af6e099d..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/avatars/get-flag.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/avatars/flags/{code} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-image.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-image.md deleted file mode 100644 index 8d20675f53..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/avatars/get-image.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/avatars/image HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-initials.md deleted file mode 100644 index 41cd233524..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/avatars/get-initials.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/avatars/initials HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-rest/examples/avatars/get-q-r.md deleted file mode 100644 index b90d67dc59..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/avatars/get-q-r.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/avatars/qr HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/databases/create-document.md b/docs/examples/1.6.x/client-rest/examples/databases/create-document.md deleted file mode 100644 index 50de44da45..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/databases/create-document.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "documentId": "<DOCUMENT_ID>", - "data": {}, - "permissions": ["read(\"any\")"] -} diff --git a/docs/examples/1.6.x/client-rest/examples/databases/delete-document.md b/docs/examples/1.6.x/client-rest/examples/databases/delete-document.md deleted file mode 100644 index bd877ffd96..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/databases/delete-document.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/databases/get-document.md b/docs/examples/1.6.x/client-rest/examples/databases/get-document.md deleted file mode 100644 index 6de3095a04..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/databases/get-document.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/databases/list-documents.md b/docs/examples/1.6.x/client-rest/examples/databases/list-documents.md deleted file mode 100644 index c338837769..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/databases/list-documents.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/databases/update-document.md b/docs/examples/1.6.x/client-rest/examples/databases/update-document.md deleted file mode 100644 index 4c5882f582..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/databases/update-document.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "data": {}, - "permissions": ["read(\"any\")"] -} diff --git a/docs/examples/1.6.x/client-rest/examples/functions/create-execution.md b/docs/examples/1.6.x/client-rest/examples/functions/create-execution.md deleted file mode 100644 index 541d13c30e..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/functions/create-execution.md +++ /dev/null @@ -1,16 +0,0 @@ -POST /v1/functions/{functionId}/executions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "body": "<BODY>", - "async": false, - "path": "<PATH>", - "method": "GET", - "headers": {}, - "scheduledAt": -} diff --git a/docs/examples/1.6.x/client-rest/examples/functions/get-execution.md b/docs/examples/1.6.x/client-rest/examples/functions/get-execution.md deleted file mode 100644 index d59c883178..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/functions/get-execution.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/functions/{functionId}/executions/{executionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/functions/list-executions.md b/docs/examples/1.6.x/client-rest/examples/functions/list-executions.md deleted file mode 100644 index 3c43c0f341..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/functions/list-executions.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/functions/{functionId}/executions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/graphql/mutation.md b/docs/examples/1.6.x/client-rest/examples/graphql/mutation.md deleted file mode 100644 index 573dc07757..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/graphql/mutation.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/graphql/mutation HTTP/1.1 -Host: cloud.appwrite.io -X-Sdk-Graphql: true -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "query": {} -} diff --git a/docs/examples/1.6.x/client-rest/examples/graphql/query.md b/docs/examples/1.6.x/client-rest/examples/graphql/query.md deleted file mode 100644 index 270ec569bf..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/graphql/query.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/graphql HTTP/1.1 -Host: cloud.appwrite.io -X-Sdk-Graphql: true -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "query": {} -} diff --git a/docs/examples/1.6.x/client-rest/examples/locale/get.md b/docs/examples/1.6.x/client-rest/examples/locale/get.md deleted file mode 100644 index c00b16494d..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/locale/get.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/locale HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-codes.md b/docs/examples/1.6.x/client-rest/examples/locale/list-codes.md deleted file mode 100644 index e10c3674be..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/locale/list-codes.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/locale/codes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-continents.md b/docs/examples/1.6.x/client-rest/examples/locale/list-continents.md deleted file mode 100644 index 3b698d0fd3..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/locale/list-continents.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/locale/continents HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-rest/examples/locale/list-countries-e-u.md deleted file mode 100644 index 912c285b19..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/locale/countries/eu HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-rest/examples/locale/list-countries-phones.md deleted file mode 100644 index b99bf997d0..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/locale/countries/phones HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-countries.md b/docs/examples/1.6.x/client-rest/examples/locale/list-countries.md deleted file mode 100644 index ab51b4c691..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/locale/list-countries.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/locale/countries HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-rest/examples/locale/list-currencies.md deleted file mode 100644 index f89cfed892..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/locale/list-currencies.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/locale/currencies HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/locale/list-languages.md b/docs/examples/1.6.x/client-rest/examples/locale/list-languages.md deleted file mode 100644 index 724aadbdd4..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/locale/list-languages.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/locale/languages HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-rest/examples/messaging/create-subscriber.md deleted file mode 100644 index 8f4e462189..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-JWT: <YOUR_JWT> -X-Appwrite-Session: - -{ - "subscriberId": "<SUBSCRIBER_ID>", - "targetId": "<TARGET_ID>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-rest/examples/messaging/delete-subscriber.md deleted file mode 100644 index 55497e0987..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-JWT: <YOUR_JWT> -X-Appwrite-Session: - diff --git a/docs/examples/1.6.x/client-rest/examples/storage/create-file.md b/docs/examples/1.6.x/client-rest/examples/storage/create-file.md deleted file mode 100644 index bde7a9dea5..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/storage/create-file.md +++ /dev/null @@ -1,26 +0,0 @@ -POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> -Content-Length: *Length of your entity body in bytes* - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="fileId" - -"<FILE_ID>" - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="file" - -cf 94 84 24 8d c4 91 10 0f dc 54 26 6c 8e 4b bc -e8 ee 55 94 29 e7 94 89 19 26 28 01 26 29 3f 16... - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="permissions[]" - -["read(\"any\")"] - ---cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/client-rest/examples/storage/delete-file.md b/docs/examples/1.6.x/client-rest/examples/storage/delete-file.md deleted file mode 100644 index 5c8d28d9a4..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/storage/delete-file.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-rest/examples/storage/get-file-download.md deleted file mode 100644 index 4ddc88e346..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/storage/get-file-download.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/storage/buckets/{bucketId}/files/{fileId}/download HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-rest/examples/storage/get-file-preview.md deleted file mode 100644 index 3e73987a17..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/storage/get-file-preview.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/storage/buckets/{bucketId}/files/{fileId}/preview HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-rest/examples/storage/get-file-view.md deleted file mode 100644 index ad1069da81..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/storage/get-file-view.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/storage/buckets/{bucketId}/files/{fileId}/view HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/storage/get-file.md b/docs/examples/1.6.x/client-rest/examples/storage/get-file.md deleted file mode 100644 index 91b68c1256..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/storage/get-file.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/storage/list-files.md b/docs/examples/1.6.x/client-rest/examples/storage/list-files.md deleted file mode 100644 index 5147eaaaed..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/storage/list-files.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/storage/buckets/{bucketId}/files HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/storage/update-file.md b/docs/examples/1.6.x/client-rest/examples/storage/update-file.md deleted file mode 100644 index f3f68f4ece..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/storage/update-file.md +++ /dev/null @@ -1,12 +0,0 @@ -PUT /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "name": "<NAME>", - "permissions": ["read(\"any\")"] -} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/create-membership.md b/docs/examples/1.6.x/client-rest/examples/teams/create-membership.md deleted file mode 100644 index 84dbc980fc..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/create-membership.md +++ /dev/null @@ -1,16 +0,0 @@ -POST /v1/teams/{teamId}/memberships HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "email": "email@example.com", - "userId": "<USER_ID>", - "phone": "+12065550100", - "roles": [], - "url": "https://example.com", - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/create.md b/docs/examples/1.6.x/client-rest/examples/teams/create.md deleted file mode 100644 index 3a63ba1f82..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/create.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/teams HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "teamId": "<TEAM_ID>", - "name": "<NAME>", - "roles": [] -} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-rest/examples/teams/delete-membership.md deleted file mode 100644 index 66f87aebea..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/delete-membership.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/teams/delete.md b/docs/examples/1.6.x/client-rest/examples/teams/delete.md deleted file mode 100644 index 1c4e209c63..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/delete.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/teams/{teamId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/teams/get-membership.md b/docs/examples/1.6.x/client-rest/examples/teams/get-membership.md deleted file mode 100644 index a05c53298a..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/get-membership.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-rest/examples/teams/get-prefs.md deleted file mode 100644 index d143f6b904..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/get-prefs.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/teams/{teamId}/prefs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/teams/get.md b/docs/examples/1.6.x/client-rest/examples/teams/get.md deleted file mode 100644 index a7c2a0e9b7..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/get.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/teams/{teamId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-rest/examples/teams/list-memberships.md deleted file mode 100644 index 8350fb4cb3..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/list-memberships.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/teams/{teamId}/memberships HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/teams/list.md b/docs/examples/1.6.x/client-rest/examples/teams/list.md deleted file mode 100644 index 64ad9d801b..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/list.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/teams HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/client-rest/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-rest/examples/teams/update-membership-status.md deleted file mode 100644 index 5cc6b91536..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/update-membership-status.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/teams/{teamId}/memberships/{membershipId}/status HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/update-membership.md b/docs/examples/1.6.x/client-rest/examples/teams/update-membership.md deleted file mode 100644 index a2838a5853..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/update-membership.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "roles": [] -} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/update-name.md b/docs/examples/1.6.x/client-rest/examples/teams/update-name.md deleted file mode 100644 index 33f1c13a99..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/update-name.md +++ /dev/null @@ -1,11 +0,0 @@ -PUT /v1/teams/{teamId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/client-rest/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-rest/examples/teams/update-prefs.md deleted file mode 100644 index d6b42128be..0000000000 --- a/docs/examples/1.6.x/client-rest/examples/teams/update-prefs.md +++ /dev/null @@ -1,11 +0,0 @@ -PUT /v1/teams/{teamId}/prefs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "prefs": {} -} diff --git a/docs/examples/1.6.x/client-web/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/client-web/examples/account/create-anonymous-session.md deleted file mode 100644 index 436b1039bd..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createAnonymousSession(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-email-password-session.md b/docs/examples/1.6.x/client-web/examples/account/create-email-password-session.md deleted file mode 100644 index 9f207531cc..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-email-password-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createEmailPasswordSession( - 'email@example.com', // email - 'password' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-email-token.md b/docs/examples/1.6.x/client-web/examples/account/create-email-token.md deleted file mode 100644 index be13a771ac..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-email-token.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createEmailToken( - '<USER_ID>', // userId - 'email@example.com', // email - false // phrase (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-j-w-t.md b/docs/examples/1.6.x/client-web/examples/account/create-j-w-t.md deleted file mode 100644 index 41dfe9c999..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-j-w-t.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createJWT(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/client-web/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 1b8cfe0ad5..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMagicURLToken( - '<USER_ID>', // userId - 'email@example.com', // email - 'https://example.com', // url (optional) - false // phrase (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/client-web/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 5899ee71a7..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account, AuthenticatorType } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMfaAuthenticator( - AuthenticatorType.Totp // type -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/client-web/examples/account/create-mfa-challenge.md deleted file mode 100644 index 1b1d5e9110..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account, AuthenticationFactor } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMfaChallenge( - AuthenticationFactor.Email // factor -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/client-web/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index de5c4f6ea9..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMfaRecoveryCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/client-web/examples/account/create-o-auth2session.md deleted file mode 100644 index 1d1808bb36..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-o-auth2session.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account, OAuthProvider } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -account.createOAuth2Session( - OAuthProvider.Amazon, // provider - 'https://example.com', // success (optional) - 'https://example.com', // failure (optional) - [] // scopes (optional) -); - diff --git a/docs/examples/1.6.x/client-web/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/client-web/examples/account/create-o-auth2token.md deleted file mode 100644 index be599de1f6..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account, OAuthProvider } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -account.createOAuth2Token( - OAuthProvider.Amazon, // provider - 'https://example.com', // success (optional) - 'https://example.com', // failure (optional) - [] // scopes (optional) -); - diff --git a/docs/examples/1.6.x/client-web/examples/account/create-phone-token.md b/docs/examples/1.6.x/client-web/examples/account/create-phone-token.md deleted file mode 100644 index 80ac3169d4..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-phone-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createPhoneToken( - '<USER_ID>', // userId - '+12065550100' // phone -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-phone-verification.md b/docs/examples/1.6.x/client-web/examples/account/create-phone-verification.md deleted file mode 100644 index 008c725552..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-phone-verification.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createPhoneVerification(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-push-target.md b/docs/examples/1.6.x/client-web/examples/account/create-push-target.md deleted file mode 100644 index 7b3dba20b3..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-push-target.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createPushTarget( - '<TARGET_ID>', // targetId - '<IDENTIFIER>', // identifier - '<PROVIDER_ID>' // providerId (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-recovery.md b/docs/examples/1.6.x/client-web/examples/account/create-recovery.md deleted file mode 100644 index 6c7bf498aa..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createRecovery( - 'email@example.com', // email - 'https://example.com' // url -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-session.md b/docs/examples/1.6.x/client-web/examples/account/create-session.md deleted file mode 100644 index af03174675..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create-verification.md b/docs/examples/1.6.x/client-web/examples/account/create-verification.md deleted file mode 100644 index 04d924327e..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createVerification( - 'https://example.com' // url -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/create.md b/docs/examples/1.6.x/client-web/examples/account/create.md deleted file mode 100644 index 95f6bc7cb0..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/create.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.create( - '<USER_ID>', // userId - 'email@example.com', // email - '', // password - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/delete-identity.md b/docs/examples/1.6.x/client-web/examples/account/delete-identity.md deleted file mode 100644 index f2c3b9b593..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/delete-identity.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteIdentity( - '<IDENTITY_ID>' // identityId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/client-web/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 339aae0d92..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account, AuthenticatorType } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteMfaAuthenticator( - AuthenticatorType.Totp // type -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/delete-push-target.md b/docs/examples/1.6.x/client-web/examples/account/delete-push-target.md deleted file mode 100644 index 00b20d4481..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/delete-push-target.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deletePushTarget( - '<TARGET_ID>' // targetId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/delete-session.md b/docs/examples/1.6.x/client-web/examples/account/delete-session.md deleted file mode 100644 index 55671b3e9b..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/delete-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteSession( - '<SESSION_ID>' // sessionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/delete-sessions.md b/docs/examples/1.6.x/client-web/examples/account/delete-sessions.md deleted file mode 100644 index e2c836c827..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/delete-sessions.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteSessions(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/client-web/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index de1ec84a00..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.getMfaRecoveryCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/get-prefs.md b/docs/examples/1.6.x/client-web/examples/account/get-prefs.md deleted file mode 100644 index f44caf2779..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/get-prefs.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.getPrefs(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/get-session.md b/docs/examples/1.6.x/client-web/examples/account/get-session.md deleted file mode 100644 index 0acd251b28..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/get-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.getSession( - '<SESSION_ID>' // sessionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/get.md b/docs/examples/1.6.x/client-web/examples/account/get.md deleted file mode 100644 index 239dd0586d..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.get(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/list-identities.md b/docs/examples/1.6.x/client-web/examples/account/list-identities.md deleted file mode 100644 index 9fb9f57887..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/list-identities.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listIdentities( - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/list-logs.md b/docs/examples/1.6.x/client-web/examples/account/list-logs.md deleted file mode 100644 index fc4e762b67..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/list-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listLogs( - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/client-web/examples/account/list-mfa-factors.md deleted file mode 100644 index d88379c22a..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listMfaFactors(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/list-sessions.md b/docs/examples/1.6.x/client-web/examples/account/list-sessions.md deleted file mode 100644 index cd23e3a242..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/list-sessions.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listSessions(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-email.md b/docs/examples/1.6.x/client-web/examples/account/update-email.md deleted file mode 100644 index d5cab99605..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-email.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateEmail( - 'email@example.com', // email - 'password' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-m-f-a.md b/docs/examples/1.6.x/client-web/examples/account/update-m-f-a.md deleted file mode 100644 index 3ebfbc8a8a..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-m-f-a.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMFA( - false // mfa -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/client-web/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 8acdc01c66..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMagicURLSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/client-web/examples/account/update-mfa-authenticator.md deleted file mode 100644 index 0f9bece742..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account, AuthenticatorType } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMfaAuthenticator( - AuthenticatorType.Totp, // type - '<OTP>' // otp -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/client-web/examples/account/update-mfa-challenge.md deleted file mode 100644 index c68d091660..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMfaChallenge( - '<CHALLENGE_ID>', // challengeId - '<OTP>' // otp -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/client-web/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index 35b4a73b14..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMfaRecoveryCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-name.md b/docs/examples/1.6.x/client-web/examples/account/update-name.md deleted file mode 100644 index 6f8f1582ea..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateName( - '<NAME>' // name -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-password.md b/docs/examples/1.6.x/client-web/examples/account/update-password.md deleted file mode 100644 index 30337387ca..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-password.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePassword( - '', // password - 'password' // oldPassword (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-phone-session.md b/docs/examples/1.6.x/client-web/examples/account/update-phone-session.md deleted file mode 100644 index 8d0d760e43..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-phone-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePhoneSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-phone-verification.md b/docs/examples/1.6.x/client-web/examples/account/update-phone-verification.md deleted file mode 100644 index af205e6e56..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-phone-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePhoneVerification( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-phone.md b/docs/examples/1.6.x/client-web/examples/account/update-phone.md deleted file mode 100644 index 134bfe6052..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-phone.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePhone( - '+12065550100', // phone - 'password' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-prefs.md b/docs/examples/1.6.x/client-web/examples/account/update-prefs.md deleted file mode 100644 index 6d25ac9dbd..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePrefs( - {} // prefs -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-push-target.md b/docs/examples/1.6.x/client-web/examples/account/update-push-target.md deleted file mode 100644 index 6009b63961..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-push-target.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePushTarget( - '<TARGET_ID>', // targetId - '<IDENTIFIER>' // identifier -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-recovery.md b/docs/examples/1.6.x/client-web/examples/account/update-recovery.md deleted file mode 100644 index db10194734..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-recovery.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateRecovery( - '<USER_ID>', // userId - '<SECRET>', // secret - '' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-session.md b/docs/examples/1.6.x/client-web/examples/account/update-session.md deleted file mode 100644 index 7ace994fa8..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateSession( - '<SESSION_ID>' // sessionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-status.md b/docs/examples/1.6.x/client-web/examples/account/update-status.md deleted file mode 100644 index 5cc295dad0..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-status.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateStatus(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/account/update-verification.md b/docs/examples/1.6.x/client-web/examples/account/update-verification.md deleted file mode 100644 index 17b23e7455..0000000000 --- a/docs/examples/1.6.x/client-web/examples/account/update-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateVerification( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-browser.md b/docs/examples/1.6.x/client-web/examples/avatars/get-browser.md deleted file mode 100644 index 7339297953..0000000000 --- a/docs/examples/1.6.x/client-web/examples/avatars/get-browser.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars, Browser } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getBrowser( - Browser.AvantBrowser, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/client-web/examples/avatars/get-credit-card.md deleted file mode 100644 index c998ff8c14..0000000000 --- a/docs/examples/1.6.x/client-web/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars, CreditCard } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getCreditCard( - CreditCard.AmericanExpress, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-favicon.md b/docs/examples/1.6.x/client-web/examples/avatars/get-favicon.md deleted file mode 100644 index a4b002c66e..0000000000 --- a/docs/examples/1.6.x/client-web/examples/avatars/get-favicon.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Avatars } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getFavicon( - 'https://example.com' // url -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-flag.md b/docs/examples/1.6.x/client-web/examples/avatars/get-flag.md deleted file mode 100644 index 6c00b33b10..0000000000 --- a/docs/examples/1.6.x/client-web/examples/avatars/get-flag.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars, Flag } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getFlag( - Flag.Afghanistan, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-image.md b/docs/examples/1.6.x/client-web/examples/avatars/get-image.md deleted file mode 100644 index 31a44ea129..0000000000 --- a/docs/examples/1.6.x/client-web/examples/avatars/get-image.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Avatars } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getImage( - 'https://example.com', // url - 0, // width (optional) - 0 // height (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-initials.md b/docs/examples/1.6.x/client-web/examples/avatars/get-initials.md deleted file mode 100644 index 0597c168d0..0000000000 --- a/docs/examples/1.6.x/client-web/examples/avatars/get-initials.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getInitials( - '<NAME>', // name (optional) - 0, // width (optional) - 0, // height (optional) - '' // background (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/avatars/get-q-r.md b/docs/examples/1.6.x/client-web/examples/avatars/get-q-r.md deleted file mode 100644 index cdd31ad84e..0000000000 --- a/docs/examples/1.6.x/client-web/examples/avatars/get-q-r.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getQR( - '<TEXT>', // text - 1, // size (optional) - 0, // margin (optional) - false // download (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/databases/create-document.md b/docs/examples/1.6.x/client-web/examples/databases/create-document.md deleted file mode 100644 index 4c819110b5..0000000000 --- a/docs/examples/1.6.x/client-web/examples/databases/create-document.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - {}, // data - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/databases/delete-document.md b/docs/examples/1.6.x/client-web/examples/databases/delete-document.md deleted file mode 100644 index b29fcec8e3..0000000000 --- a/docs/examples/1.6.x/client-web/examples/databases/delete-document.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.deleteDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>' // documentId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/databases/get-document.md b/docs/examples/1.6.x/client-web/examples/databases/get-document.md deleted file mode 100644 index 9b043c82b9..0000000000 --- a/docs/examples/1.6.x/client-web/examples/databases/get-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.getDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/databases/list-documents.md b/docs/examples/1.6.x/client-web/examples/databases/list-documents.md deleted file mode 100644 index a8154c22db..0000000000 --- a/docs/examples/1.6.x/client-web/examples/databases/list-documents.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.listDocuments( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/databases/update-document.md b/docs/examples/1.6.x/client-web/examples/databases/update-document.md deleted file mode 100644 index d6c4d720fd..0000000000 --- a/docs/examples/1.6.x/client-web/examples/databases/update-document.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - {}, // data (optional) - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/functions/create-execution.md b/docs/examples/1.6.x/client-web/examples/functions/create-execution.md deleted file mode 100644 index 7db9557c6b..0000000000 --- a/docs/examples/1.6.x/client-web/examples/functions/create-execution.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Functions, ExecutionMethod } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.createExecution( - '<FUNCTION_ID>', // functionId - '<BODY>', // body (optional) - false, // async (optional) - '<PATH>', // path (optional) - ExecutionMethod.GET, // method (optional) - {}, // headers (optional) - '' // scheduledAt (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/functions/get-execution.md b/docs/examples/1.6.x/client-web/examples/functions/get-execution.md deleted file mode 100644 index d558d5fbf2..0000000000 --- a/docs/examples/1.6.x/client-web/examples/functions/get-execution.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.getExecution( - '<FUNCTION_ID>', // functionId - '<EXECUTION_ID>' // executionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/functions/list-executions.md b/docs/examples/1.6.x/client-web/examples/functions/list-executions.md deleted file mode 100644 index 830e3e16ac..0000000000 --- a/docs/examples/1.6.x/client-web/examples/functions/list-executions.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Functions } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.listExecutions( - '<FUNCTION_ID>', // functionId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/graphql/mutation.md b/docs/examples/1.6.x/client-web/examples/graphql/mutation.md deleted file mode 100644 index 5b65286fb9..0000000000 --- a/docs/examples/1.6.x/client-web/examples/graphql/mutation.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Graphql } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const graphql = new Graphql(client); - -const result = await graphql.mutation( - {} // query -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/graphql/query.md b/docs/examples/1.6.x/client-web/examples/graphql/query.md deleted file mode 100644 index 9de8dd77e9..0000000000 --- a/docs/examples/1.6.x/client-web/examples/graphql/query.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Graphql } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const graphql = new Graphql(client); - -const result = await graphql.query( - {} // query -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/get.md b/docs/examples/1.6.x/client-web/examples/locale/get.md deleted file mode 100644 index cf6b1047ca..0000000000 --- a/docs/examples/1.6.x/client-web/examples/locale/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.get(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-codes.md b/docs/examples/1.6.x/client-web/examples/locale/list-codes.md deleted file mode 100644 index 8a6097918b..0000000000 --- a/docs/examples/1.6.x/client-web/examples/locale/list-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-continents.md b/docs/examples/1.6.x/client-web/examples/locale/list-continents.md deleted file mode 100644 index b76e6d5246..0000000000 --- a/docs/examples/1.6.x/client-web/examples/locale/list-continents.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listContinents(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/client-web/examples/locale/list-countries-e-u.md deleted file mode 100644 index 6f0bd36b0c..0000000000 --- a/docs/examples/1.6.x/client-web/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCountriesEU(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/client-web/examples/locale/list-countries-phones.md deleted file mode 100644 index fb2f9b1df9..0000000000 --- a/docs/examples/1.6.x/client-web/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCountriesPhones(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-countries.md b/docs/examples/1.6.x/client-web/examples/locale/list-countries.md deleted file mode 100644 index 28dc75f4a2..0000000000 --- a/docs/examples/1.6.x/client-web/examples/locale/list-countries.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCountries(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-currencies.md b/docs/examples/1.6.x/client-web/examples/locale/list-currencies.md deleted file mode 100644 index bf6b42c27f..0000000000 --- a/docs/examples/1.6.x/client-web/examples/locale/list-currencies.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCurrencies(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/locale/list-languages.md b/docs/examples/1.6.x/client-web/examples/locale/list-languages.md deleted file mode 100644 index 29bd0dad3d..0000000000 --- a/docs/examples/1.6.x/client-web/examples/locale/list-languages.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listLanguages(); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/client-web/examples/messaging/create-subscriber.md deleted file mode 100644 index 231197717b..0000000000 --- a/docs/examples/1.6.x/client-web/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Messaging } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>', // subscriberId - '<TARGET_ID>' // targetId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/client-web/examples/messaging/delete-subscriber.md deleted file mode 100644 index 76c71ef2f2..0000000000 --- a/docs/examples/1.6.x/client-web/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.deleteSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>' // subscriberId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/storage/create-file.md b/docs/examples/1.6.x/client-web/examples/storage/create-file.md deleted file mode 100644 index d6617e40b9..0000000000 --- a/docs/examples/1.6.x/client-web/examples/storage/create-file.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Storage } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.createFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - document.getElementById('uploader').files[0], // file - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/storage/delete-file.md b/docs/examples/1.6.x/client-web/examples/storage/delete-file.md deleted file mode 100644 index e45af2ca5d..0000000000 --- a/docs/examples/1.6.x/client-web/examples/storage/delete-file.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.deleteFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/storage/get-file-download.md b/docs/examples/1.6.x/client-web/examples/storage/get-file-download.md deleted file mode 100644 index f2bdbbd26d..0000000000 --- a/docs/examples/1.6.x/client-web/examples/storage/get-file-download.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = storage.getFileDownload( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/storage/get-file-preview.md b/docs/examples/1.6.x/client-web/examples/storage/get-file-preview.md deleted file mode 100644 index 66b30ca539..0000000000 --- a/docs/examples/1.6.x/client-web/examples/storage/get-file-preview.md +++ /dev/null @@ -1,25 +0,0 @@ -import { Client, Storage, ImageGravity, ImageFormat } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = storage.getFilePreview( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - 0, // width (optional) - 0, // height (optional) - ImageGravity.Center, // gravity (optional) - 0, // quality (optional) - 0, // borderWidth (optional) - '', // borderColor (optional) - 0, // borderRadius (optional) - 0, // opacity (optional) - -360, // rotation (optional) - '', // background (optional) - ImageFormat.Jpg // output (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/storage/get-file-view.md b/docs/examples/1.6.x/client-web/examples/storage/get-file-view.md deleted file mode 100644 index d83fca52e9..0000000000 --- a/docs/examples/1.6.x/client-web/examples/storage/get-file-view.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = storage.getFileView( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(result); diff --git a/docs/examples/1.6.x/client-web/examples/storage/get-file.md b/docs/examples/1.6.x/client-web/examples/storage/get-file.md deleted file mode 100644 index 093017df67..0000000000 --- a/docs/examples/1.6.x/client-web/examples/storage/get-file.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.getFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/storage/list-files.md b/docs/examples/1.6.x/client-web/examples/storage/list-files.md deleted file mode 100644 index b3416759dc..0000000000 --- a/docs/examples/1.6.x/client-web/examples/storage/list-files.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Storage } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.listFiles( - '<BUCKET_ID>', // bucketId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/storage/update-file.md b/docs/examples/1.6.x/client-web/examples/storage/update-file.md deleted file mode 100644 index 0136fb770f..0000000000 --- a/docs/examples/1.6.x/client-web/examples/storage/update-file.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Storage } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.updateFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - '<NAME>', // name (optional) - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/create-membership.md b/docs/examples/1.6.x/client-web/examples/teams/create-membership.md deleted file mode 100644 index f158f98be2..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/create-membership.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.createMembership( - '<TEAM_ID>', // teamId - [], // roles - 'email@example.com', // email (optional) - '<USER_ID>', // userId (optional) - '+12065550100', // phone (optional) - 'https://example.com', // url (optional) - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/create.md b/docs/examples/1.6.x/client-web/examples/teams/create.md deleted file mode 100644 index 154c1795a2..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/create.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.create( - '<TEAM_ID>', // teamId - '<NAME>', // name - [] // roles (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/delete-membership.md b/docs/examples/1.6.x/client-web/examples/teams/delete-membership.md deleted file mode 100644 index c6e60a6692..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/delete-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.deleteMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>' // membershipId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/delete.md b/docs/examples/1.6.x/client-web/examples/teams/delete.md deleted file mode 100644 index b15112ebac..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.delete( - '<TEAM_ID>' // teamId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/get-membership.md b/docs/examples/1.6.x/client-web/examples/teams/get-membership.md deleted file mode 100644 index c1ccff2e87..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/get-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.getMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>' // membershipId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/get-prefs.md b/docs/examples/1.6.x/client-web/examples/teams/get-prefs.md deleted file mode 100644 index 6498106c30..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/get-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.getPrefs( - '<TEAM_ID>' // teamId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/get.md b/docs/examples/1.6.x/client-web/examples/teams/get.md deleted file mode 100644 index 9131f99079..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.get( - '<TEAM_ID>' // teamId -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/list-memberships.md b/docs/examples/1.6.x/client-web/examples/teams/list-memberships.md deleted file mode 100644 index 2f76c01492..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/list-memberships.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.listMemberships( - '<TEAM_ID>', // teamId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/list.md b/docs/examples/1.6.x/client-web/examples/teams/list.md deleted file mode 100644 index 3c362673bd..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/update-membership-status.md b/docs/examples/1.6.x/client-web/examples/teams/update-membership-status.md deleted file mode 100644 index e4d67e36d4..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/update-membership-status.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updateMembershipStatus( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>', // membershipId - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/update-membership.md b/docs/examples/1.6.x/client-web/examples/teams/update-membership.md deleted file mode 100644 index a1bac018a9..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/update-membership.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updateMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>', // membershipId - [] // roles -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/update-name.md b/docs/examples/1.6.x/client-web/examples/teams/update-name.md deleted file mode 100644 index a65b7c465e..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/update-name.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updateName( - '<TEAM_ID>', // teamId - '<NAME>' // name -); - -console.log(response); diff --git a/docs/examples/1.6.x/client-web/examples/teams/update-prefs.md b/docs/examples/1.6.x/client-web/examples/teams/update-prefs.md deleted file mode 100644 index 002b4eb447..0000000000 --- a/docs/examples/1.6.x/client-web/examples/teams/update-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "appwrite"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updatePrefs( - '<TEAM_ID>', // teamId - {} // prefs -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/console-cli/examples/account/create-anonymous-session.md deleted file mode 100644 index a7eb9c5be3..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-anonymous-session.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account createAnonymousSession diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-email-password-session.md b/docs/examples/1.6.x/console-cli/examples/account/create-email-password-session.md deleted file mode 100644 index 951293b4b2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-email-password-session.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account createEmailPasswordSession \ - --email email@example.com \ - --password password diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-email-token.md b/docs/examples/1.6.x/console-cli/examples/account/create-email-token.md deleted file mode 100644 index 0aaf2476c9..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-email-token.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite account createEmailToken \ - --userId <USER_ID> \ - --email email@example.com \ - diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-j-w-t.md b/docs/examples/1.6.x/console-cli/examples/account/create-j-w-t.md deleted file mode 100644 index 7b5337993d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-j-w-t.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account createJWT diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/console-cli/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 69203b085d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite account createMagicURLToken \ - --userId <USER_ID> \ - --email email@example.com \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/console-cli/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 7634217700..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account createMfaAuthenticator \ - --type totp diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/console-cli/examples/account/create-mfa-challenge.md deleted file mode 100644 index 8696be7ec1..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account createMfaChallenge \ - --factor email diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index 0ef25446fd..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account createMfaRecoveryCodes diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2session.md deleted file mode 100644 index 9159b8f25f..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2session.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite account createOAuth2Session \ - --provider amazon \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2token.md deleted file mode 100644 index b36f350d99..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite account createOAuth2Token \ - --provider amazon \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-phone-token.md b/docs/examples/1.6.x/console-cli/examples/account/create-phone-token.md deleted file mode 100644 index 23f7f19cac..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-phone-token.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account createPhoneToken \ - --userId <USER_ID> \ - --phone +12065550100 diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-phone-verification.md b/docs/examples/1.6.x/console-cli/examples/account/create-phone-verification.md deleted file mode 100644 index 3c4402ba1f..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-phone-verification.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account createPhoneVerification diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-push-target.md b/docs/examples/1.6.x/console-cli/examples/account/create-push-target.md deleted file mode 100644 index 41c380b288..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-push-target.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite account createPushTarget \ - --targetId <TARGET_ID> \ - --identifier <IDENTIFIER> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-recovery.md b/docs/examples/1.6.x/console-cli/examples/account/create-recovery.md deleted file mode 100644 index ea8c145abb..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-recovery.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account createRecovery \ - --email email@example.com \ - --url https://example.com diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-session.md b/docs/examples/1.6.x/console-cli/examples/account/create-session.md deleted file mode 100644 index 426713ef50..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-session.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account createSession \ - --userId <USER_ID> \ - --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/account/create-verification.md b/docs/examples/1.6.x/console-cli/examples/account/create-verification.md deleted file mode 100644 index 402038b4b6..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create-verification.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account createVerification \ - --url https://example.com diff --git a/docs/examples/1.6.x/console-cli/examples/account/create.md b/docs/examples/1.6.x/console-cli/examples/account/create.md deleted file mode 100644 index 09686a2454..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/create.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite account create \ - --userId <USER_ID> \ - --email email@example.com \ - --password '' \ - diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete-identity.md b/docs/examples/1.6.x/console-cli/examples/account/delete-identity.md deleted file mode 100644 index acd8511dfb..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/delete-identity.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account deleteIdentity \ - --identityId <IDENTITY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/console-cli/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index d4664855b5..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account deleteMfaAuthenticator \ - --type totp diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete-push-target.md b/docs/examples/1.6.x/console-cli/examples/account/delete-push-target.md deleted file mode 100644 index 610ea232d8..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/delete-push-target.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account deletePushTarget \ - --targetId <TARGET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete-session.md b/docs/examples/1.6.x/console-cli/examples/account/delete-session.md deleted file mode 100644 index 9774552408..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/delete-session.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account deleteSession \ - --sessionId <SESSION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete-sessions.md b/docs/examples/1.6.x/console-cli/examples/account/delete-sessions.md deleted file mode 100644 index dd11877a5d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/delete-sessions.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account deleteSessions diff --git a/docs/examples/1.6.x/console-cli/examples/account/delete.md b/docs/examples/1.6.x/console-cli/examples/account/delete.md deleted file mode 100644 index dac412f7c2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/delete.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account delete diff --git a/docs/examples/1.6.x/console-cli/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index 0e61d658de..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account getMfaRecoveryCodes diff --git a/docs/examples/1.6.x/console-cli/examples/account/get-prefs.md b/docs/examples/1.6.x/console-cli/examples/account/get-prefs.md deleted file mode 100644 index 6569925d99..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/get-prefs.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account getPrefs diff --git a/docs/examples/1.6.x/console-cli/examples/account/get-session.md b/docs/examples/1.6.x/console-cli/examples/account/get-session.md deleted file mode 100644 index 120dc8277f..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/get-session.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account getSession \ - --sessionId <SESSION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/account/get.md b/docs/examples/1.6.x/console-cli/examples/account/get.md deleted file mode 100644 index c8b46e34c7..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/get.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account get diff --git a/docs/examples/1.6.x/console-cli/examples/account/list-identities.md b/docs/examples/1.6.x/console-cli/examples/account/list-identities.md deleted file mode 100644 index 877b443ea8..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/list-identities.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account listIdentities \ - diff --git a/docs/examples/1.6.x/console-cli/examples/account/list-logs.md b/docs/examples/1.6.x/console-cli/examples/account/list-logs.md deleted file mode 100644 index e92f49063a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/list-logs.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account listLogs \ - diff --git a/docs/examples/1.6.x/console-cli/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/console-cli/examples/account/list-mfa-factors.md deleted file mode 100644 index a29f287d24..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/list-mfa-factors.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account listMfaFactors diff --git a/docs/examples/1.6.x/console-cli/examples/account/list-sessions.md b/docs/examples/1.6.x/console-cli/examples/account/list-sessions.md deleted file mode 100644 index 87cbab0f66..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/list-sessions.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account listSessions diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-email.md b/docs/examples/1.6.x/console-cli/examples/account/update-email.md deleted file mode 100644 index 81938ff3a9..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-email.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account updateEmail \ - --email email@example.com \ - --password password diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-m-f-a.md b/docs/examples/1.6.x/console-cli/examples/account/update-m-f-a.md deleted file mode 100644 index f714d4dbe9..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-m-f-a.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account updateMFA \ - --mfa false diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/console-cli/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 919bd70a30..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account updateMagicURLSession \ - --userId <USER_ID> \ - --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/console-cli/examples/account/update-mfa-authenticator.md deleted file mode 100644 index b51796a79e..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account updateMfaAuthenticator \ - --type totp \ - --otp <OTP> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/console-cli/examples/account/update-mfa-challenge.md deleted file mode 100644 index 37e09ef4e8..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account updateMfaChallenge \ - --challengeId <CHALLENGE_ID> \ - --otp <OTP> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index a129ca6f98..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account updateMfaRecoveryCodes diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-name.md b/docs/examples/1.6.x/console-cli/examples/account/update-name.md deleted file mode 100644 index 6f3b5977f4..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-name.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account updateName \ - --name <NAME> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-password.md b/docs/examples/1.6.x/console-cli/examples/account/update-password.md deleted file mode 100644 index 340baec562..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-password.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account updatePassword \ - --password '' \ - diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-phone-session.md b/docs/examples/1.6.x/console-cli/examples/account/update-phone-session.md deleted file mode 100644 index d70f33fab5..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-phone-session.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account updatePhoneSession \ - --userId <USER_ID> \ - --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-phone-verification.md b/docs/examples/1.6.x/console-cli/examples/account/update-phone-verification.md deleted file mode 100644 index cef2b5a40d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-phone-verification.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account updatePhoneVerification \ - --userId <USER_ID> \ - --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-phone.md b/docs/examples/1.6.x/console-cli/examples/account/update-phone.md deleted file mode 100644 index 93a619a801..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-phone.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account updatePhone \ - --phone +12065550100 \ - --password password diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-prefs.md b/docs/examples/1.6.x/console-cli/examples/account/update-prefs.md deleted file mode 100644 index 568ac66e48..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-prefs.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account updatePrefs \ - --prefs '{ "key": "value" }' diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-push-target.md b/docs/examples/1.6.x/console-cli/examples/account/update-push-target.md deleted file mode 100644 index f3aa1a906a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-push-target.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account updatePushTarget \ - --targetId <TARGET_ID> \ - --identifier <IDENTIFIER> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-recovery.md b/docs/examples/1.6.x/console-cli/examples/account/update-recovery.md deleted file mode 100644 index 903a99cc99..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-recovery.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite account updateRecovery \ - --userId <USER_ID> \ - --secret <SECRET> \ - --password '' diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-session.md b/docs/examples/1.6.x/console-cli/examples/account/update-session.md deleted file mode 100644 index 5fb6a2e8d5..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-session.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite account updateSession \ - --sessionId <SESSION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-status.md b/docs/examples/1.6.x/console-cli/examples/account/update-status.md deleted file mode 100644 index 8886dbbc6a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-status.md +++ /dev/null @@ -1 +0,0 @@ -appwrite account updateStatus diff --git a/docs/examples/1.6.x/console-cli/examples/account/update-verification.md b/docs/examples/1.6.x/console-cli/examples/account/update-verification.md deleted file mode 100644 index afdfaa8372..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/account/update-verification.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite account updateVerification \ - --userId <USER_ID> \ - --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/assistant/chat.md b/docs/examples/1.6.x/console-cli/examples/assistant/chat.md deleted file mode 100644 index cf62d30515..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/assistant/chat.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite assistant chat \ - --prompt <PROMPT> diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-browser.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-browser.md deleted file mode 100644 index 6b4f0b8007..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/avatars/get-browser.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite avatars getBrowser \ - --code aa \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-credit-card.md deleted file mode 100644 index 365568ba19..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite avatars getCreditCard \ - --code amex \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-favicon.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-favicon.md deleted file mode 100644 index c658f1a483..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/avatars/get-favicon.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite avatars getFavicon \ - --url https://example.com diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-flag.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-flag.md deleted file mode 100644 index 9f11fef840..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/avatars/get-flag.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite avatars getFlag \ - --code af \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-image.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-image.md deleted file mode 100644 index 7df150610c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/avatars/get-image.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite avatars getImage \ - --url https://example.com \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-initials.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-initials.md deleted file mode 100644 index b0b3da71c9..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/avatars/get-initials.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite avatars getInitials \ - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/avatars/get-q-r.md b/docs/examples/1.6.x/console-cli/examples/avatars/get-q-r.md deleted file mode 100644 index 01e5085732..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/avatars/get-q-r.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite avatars getQR \ - --text <TEXT> \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/console/variables.md b/docs/examples/1.6.x/console-cli/examples/console/variables.md deleted file mode 100644 index 1c67cf5ad8..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/console/variables.md +++ /dev/null @@ -1 +0,0 @@ -appwrite console variables diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-boolean-attribute.md deleted file mode 100644 index 6babbfb5af..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite databases createBooleanAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-collection.md b/docs/examples/1.6.x/console-cli/examples/databases/create-collection.md deleted file mode 100644 index d97c424d16..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-collection.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite databases createCollection \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --name <NAME> \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-datetime-attribute.md deleted file mode 100644 index f6aaf54fa2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite databases createDatetimeAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-document.md b/docs/examples/1.6.x/console-cli/examples/databases/create-document.md deleted file mode 100644 index 513cfc4f33..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-document.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite databases createDocument \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --documentId <DOCUMENT_ID> \ - --data '{ "key": "value" }' \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-email-attribute.md deleted file mode 100644 index 5c23f940de..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite databases createEmailAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-enum-attribute.md deleted file mode 100644 index 5d3c614410..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,8 +0,0 @@ -appwrite databases createEnumAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --elements one two three \ - --required false \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-float-attribute.md deleted file mode 100644 index 5a6ef4e4ef..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite databases createFloatAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-index.md b/docs/examples/1.6.x/console-cli/examples/databases/create-index.md deleted file mode 100644 index d8f96c0e55..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-index.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite databases createIndex \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --type key \ - --attributes one two three \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-integer-attribute.md deleted file mode 100644 index 791f3770c9..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite databases createIntegerAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-ip-attribute.md deleted file mode 100644 index 4f39d84bab..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite databases createIpAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-relationship-attribute.md deleted file mode 100644 index c7d8ae568a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite databases createRelationshipAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --relatedCollectionId <RELATED_COLLECTION_ID> \ - --type oneToOne \ - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-string-attribute.md deleted file mode 100644 index 37b1db644a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite databases createStringAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --size 1 \ - --required false \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/create-url-attribute.md deleted file mode 100644 index 4406ed7879..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite databases createUrlAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/create.md b/docs/examples/1.6.x/console-cli/examples/databases/create.md deleted file mode 100644 index 9e7523974f..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/create.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases create \ - --databaseId <DATABASE_ID> \ - --name <NAME> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/delete-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/delete-attribute.md deleted file mode 100644 index 88e7df985f..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/delete-attribute.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases deleteAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/delete-collection.md b/docs/examples/1.6.x/console-cli/examples/databases/delete-collection.md deleted file mode 100644 index 0db185a7d7..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/delete-collection.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite databases deleteCollection \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/delete-document.md b/docs/examples/1.6.x/console-cli/examples/databases/delete-document.md deleted file mode 100644 index 3a96d35798..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/delete-document.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases deleteDocument \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --documentId <DOCUMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/delete-index.md b/docs/examples/1.6.x/console-cli/examples/databases/delete-index.md deleted file mode 100644 index 56485e7a78..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/delete-index.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases deleteIndex \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/delete.md b/docs/examples/1.6.x/console-cli/examples/databases/delete.md deleted file mode 100644 index a24a3a04d3..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/delete.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite databases delete \ - --databaseId <DATABASE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/get-attribute.md deleted file mode 100644 index 821698011f..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/get-attribute.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases getAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-collection-usage.md b/docs/examples/1.6.x/console-cli/examples/databases/get-collection-usage.md deleted file mode 100644 index b57e6c92a9..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/get-collection-usage.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases getCollectionUsage \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-collection.md b/docs/examples/1.6.x/console-cli/examples/databases/get-collection.md deleted file mode 100644 index e763b5bbfb..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/get-collection.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite databases getCollection \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-database-usage.md b/docs/examples/1.6.x/console-cli/examples/databases/get-database-usage.md deleted file mode 100644 index 1001e9cd11..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/get-database-usage.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite databases getDatabaseUsage \ - --databaseId <DATABASE_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-document.md b/docs/examples/1.6.x/console-cli/examples/databases/get-document.md deleted file mode 100644 index 35d9615503..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/get-document.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite databases getDocument \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --documentId <DOCUMENT_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-index.md b/docs/examples/1.6.x/console-cli/examples/databases/get-index.md deleted file mode 100644 index 0071834a8c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/get-index.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases getIndex \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get-usage.md b/docs/examples/1.6.x/console-cli/examples/databases/get-usage.md deleted file mode 100644 index 53c85fc849..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/get-usage.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite databases getUsage \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/get.md b/docs/examples/1.6.x/console-cli/examples/databases/get.md deleted file mode 100644 index 35480b64cc..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/get.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite databases get \ - --databaseId <DATABASE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-attributes.md b/docs/examples/1.6.x/console-cli/examples/databases/list-attributes.md deleted file mode 100644 index a2382feb3a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/list-attributes.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases listAttributes \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-collection-logs.md b/docs/examples/1.6.x/console-cli/examples/databases/list-collection-logs.md deleted file mode 100644 index eadac47a6b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/list-collection-logs.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases listCollectionLogs \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-collections.md b/docs/examples/1.6.x/console-cli/examples/databases/list-collections.md deleted file mode 100644 index b05c330be2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/list-collections.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases listCollections \ - --databaseId <DATABASE_ID> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-document-logs.md b/docs/examples/1.6.x/console-cli/examples/databases/list-document-logs.md deleted file mode 100644 index 63b5394647..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/list-document-logs.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite databases listDocumentLogs \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --documentId <DOCUMENT_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-documents.md b/docs/examples/1.6.x/console-cli/examples/databases/list-documents.md deleted file mode 100644 index 98e389579d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/list-documents.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases listDocuments \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-indexes.md b/docs/examples/1.6.x/console-cli/examples/databases/list-indexes.md deleted file mode 100644 index 50acb4d7ad..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/list-indexes.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases listIndexes \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list-logs.md b/docs/examples/1.6.x/console-cli/examples/databases/list-logs.md deleted file mode 100644 index 38547c7c3c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/list-logs.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite databases listLogs \ - --databaseId <DATABASE_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/list.md b/docs/examples/1.6.x/console-cli/examples/databases/list.md deleted file mode 100644 index e723bc32ec..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/list.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite databases list \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-boolean-attribute.md deleted file mode 100644 index d48c3470fe..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite databases updateBooleanAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - --default false diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-collection.md b/docs/examples/1.6.x/console-cli/examples/databases/update-collection.md deleted file mode 100644 index eab3617c80..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-collection.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite databases updateCollection \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --name <NAME> \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-datetime-attribute.md deleted file mode 100644 index 9fc56373ed..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite databases updateDatetimeAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - --default '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-document.md b/docs/examples/1.6.x/console-cli/examples/databases/update-document.md deleted file mode 100644 index a4ac55bf6b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-document.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite databases updateDocument \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --documentId <DOCUMENT_ID> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-email-attribute.md deleted file mode 100644 index 9f7bffeb9c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite databases updateEmailAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - --default email@example.com diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-enum-attribute.md deleted file mode 100644 index bf562a0a82..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite databases updateEnumAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --elements one two three \ - --required false \ - --default <DEFAULT> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-float-attribute.md deleted file mode 100644 index 097dfd310a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,8 +0,0 @@ -appwrite databases updateFloatAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - --min null \ - --max null \ - --default null diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-integer-attribute.md deleted file mode 100644 index 6a6b0747a8..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,8 +0,0 @@ -appwrite databases updateIntegerAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - --min null \ - --max null \ - --default null diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-ip-attribute.md deleted file mode 100644 index 2439b5a8de..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite databases updateIpAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - --default '' diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-relationship-attribute.md deleted file mode 100644 index be03a70736..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite databases updateRelationshipAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-string-attribute.md deleted file mode 100644 index ebf45253fa..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite databases updateStringAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - --default <DEFAULT> diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/console-cli/examples/databases/update-url-attribute.md deleted file mode 100644 index aa11a588db..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite databases updateUrlAttribute \ - --databaseId <DATABASE_ID> \ - --collectionId <COLLECTION_ID> \ - --key '' \ - --required false \ - --default https://example.com diff --git a/docs/examples/1.6.x/console-cli/examples/databases/update.md b/docs/examples/1.6.x/console-cli/examples/databases/update.md deleted file mode 100644 index a1e0a844e5..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/databases/update.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite databases update \ - --databaseId <DATABASE_ID> \ - --name <NAME> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/functions/create-build.md b/docs/examples/1.6.x/console-cli/examples/functions/create-build.md deleted file mode 100644 index 5a99f7a908..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/create-build.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite functions createBuild \ - --functionId <FUNCTION_ID> \ - --deploymentId <DEPLOYMENT_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/functions/create-deployment.md b/docs/examples/1.6.x/console-cli/examples/functions/create-deployment.md deleted file mode 100644 index 6ac80bd73a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/create-deployment.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite functions createDeployment \ - --functionId <FUNCTION_ID> \ - --code 'path/to/file.png' \ - --activate false \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/functions/create-execution.md b/docs/examples/1.6.x/console-cli/examples/functions/create-execution.md deleted file mode 100644 index febe88c541..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/create-execution.md +++ /dev/null @@ -1,8 +0,0 @@ -appwrite functions createExecution \ - --functionId <FUNCTION_ID> \ - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/functions/create-variable.md b/docs/examples/1.6.x/console-cli/examples/functions/create-variable.md deleted file mode 100644 index 9a27d4cb0f..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/create-variable.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite functions createVariable \ - --functionId <FUNCTION_ID> \ - --key <KEY> \ - --value <VALUE> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/create.md b/docs/examples/1.6.x/console-cli/examples/functions/create.md deleted file mode 100644 index c75658ec7b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/create.md +++ /dev/null @@ -1,22 +0,0 @@ -appwrite functions create \ - --functionId <FUNCTION_ID> \ - --name <NAME> \ - --runtime node-14.5 \ - - - - - - - - - - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/functions/delete-deployment.md b/docs/examples/1.6.x/console-cli/examples/functions/delete-deployment.md deleted file mode 100644 index 2c9a6aa04a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/delete-deployment.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite functions deleteDeployment \ - --functionId <FUNCTION_ID> \ - --deploymentId <DEPLOYMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/delete-execution.md b/docs/examples/1.6.x/console-cli/examples/functions/delete-execution.md deleted file mode 100644 index 2926b5aaf1..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/delete-execution.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite functions deleteExecution \ - --functionId <FUNCTION_ID> \ - --executionId <EXECUTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/delete-variable.md b/docs/examples/1.6.x/console-cli/examples/functions/delete-variable.md deleted file mode 100644 index 835d125dc6..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/delete-variable.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite functions deleteVariable \ - --functionId <FUNCTION_ID> \ - --variableId <VARIABLE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/delete.md b/docs/examples/1.6.x/console-cli/examples/functions/delete.md deleted file mode 100644 index 0eea41c849..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/delete.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite functions delete \ - --functionId <FUNCTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/download-deployment.md b/docs/examples/1.6.x/console-cli/examples/functions/download-deployment.md deleted file mode 100644 index aa440b5145..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/download-deployment.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite functions downloadDeployment \ - --functionId <FUNCTION_ID> \ - --deploymentId <DEPLOYMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get-deployment.md b/docs/examples/1.6.x/console-cli/examples/functions/get-deployment.md deleted file mode 100644 index 3da1605fea..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/get-deployment.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite functions getDeployment \ - --functionId <FUNCTION_ID> \ - --deploymentId <DEPLOYMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get-execution.md b/docs/examples/1.6.x/console-cli/examples/functions/get-execution.md deleted file mode 100644 index d593f07c43..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/get-execution.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite functions getExecution \ - --functionId <FUNCTION_ID> \ - --executionId <EXECUTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get-function-usage.md b/docs/examples/1.6.x/console-cli/examples/functions/get-function-usage.md deleted file mode 100644 index 0096baeec0..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/get-function-usage.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite functions getFunctionUsage \ - --functionId <FUNCTION_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get-usage.md b/docs/examples/1.6.x/console-cli/examples/functions/get-usage.md deleted file mode 100644 index a3fe7c38de..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/get-usage.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite functions getUsage \ - diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get-variable.md b/docs/examples/1.6.x/console-cli/examples/functions/get-variable.md deleted file mode 100644 index 241a91d936..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/get-variable.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite functions getVariable \ - --functionId <FUNCTION_ID> \ - --variableId <VARIABLE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/get.md b/docs/examples/1.6.x/console-cli/examples/functions/get.md deleted file mode 100644 index f678ef7663..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/get.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite functions get \ - --functionId <FUNCTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/list-deployments.md b/docs/examples/1.6.x/console-cli/examples/functions/list-deployments.md deleted file mode 100644 index 2befb86abc..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/list-deployments.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite functions listDeployments \ - --functionId <FUNCTION_ID> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/functions/list-executions.md b/docs/examples/1.6.x/console-cli/examples/functions/list-executions.md deleted file mode 100644 index ba85ed49e6..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/list-executions.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite functions listExecutions \ - --functionId <FUNCTION_ID> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/functions/list-runtimes.md b/docs/examples/1.6.x/console-cli/examples/functions/list-runtimes.md deleted file mode 100644 index 15dc019c44..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/list-runtimes.md +++ /dev/null @@ -1 +0,0 @@ -appwrite functions listRuntimes diff --git a/docs/examples/1.6.x/console-cli/examples/functions/list-variables.md b/docs/examples/1.6.x/console-cli/examples/functions/list-variables.md deleted file mode 100644 index 21bf2eb506..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/list-variables.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite functions listVariables \ - --functionId <FUNCTION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/list.md b/docs/examples/1.6.x/console-cli/examples/functions/list.md deleted file mode 100644 index 3b7551266e..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/list.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite functions list \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/console-cli/examples/functions/update-deployment-build.md deleted file mode 100644 index ddaf1e5955..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite functions updateDeploymentBuild \ - --functionId <FUNCTION_ID> \ - --deploymentId <DEPLOYMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/update-deployment.md b/docs/examples/1.6.x/console-cli/examples/functions/update-deployment.md deleted file mode 100644 index 302068d453..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/update-deployment.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite functions updateDeployment \ - --functionId <FUNCTION_ID> \ - --deploymentId <DEPLOYMENT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/functions/update-variable.md b/docs/examples/1.6.x/console-cli/examples/functions/update-variable.md deleted file mode 100644 index 484aac13a1..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/update-variable.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite functions updateVariable \ - --functionId <FUNCTION_ID> \ - --variableId <VARIABLE_ID> \ - --key <KEY> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/functions/update.md b/docs/examples/1.6.x/console-cli/examples/functions/update.md deleted file mode 100644 index 8bad859606..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/functions/update.md +++ /dev/null @@ -1,18 +0,0 @@ -appwrite functions update \ - --functionId <FUNCTION_ID> \ - --name <NAME> \ - - - - - - - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/graphql/mutation.md b/docs/examples/1.6.x/console-cli/examples/graphql/mutation.md deleted file mode 100644 index f6127a175c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/graphql/mutation.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite graphql mutation \ - --query '{ "key": "value" }' diff --git a/docs/examples/1.6.x/console-cli/examples/graphql/query.md b/docs/examples/1.6.x/console-cli/examples/graphql/query.md deleted file mode 100644 index 1d84bcaa6a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/graphql/query.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite graphql query \ - --query '{ "key": "value" }' diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-antivirus.md b/docs/examples/1.6.x/console-cli/examples/health/get-antivirus.md deleted file mode 100644 index 96dd7e78b2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-antivirus.md +++ /dev/null @@ -1 +0,0 @@ -appwrite health getAntivirus diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-cache.md b/docs/examples/1.6.x/console-cli/examples/health/get-cache.md deleted file mode 100644 index ad1111ccf0..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-cache.md +++ /dev/null @@ -1 +0,0 @@ -appwrite health getCache diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-certificate.md b/docs/examples/1.6.x/console-cli/examples/health/get-certificate.md deleted file mode 100644 index 4659415822..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-certificate.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getCertificate \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-d-b.md b/docs/examples/1.6.x/console-cli/examples/health/get-d-b.md deleted file mode 100644 index b0ea2d3eac..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-d-b.md +++ /dev/null @@ -1 +0,0 @@ -appwrite health getDB diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/console-cli/examples/health/get-failed-jobs.md deleted file mode 100644 index 724299e384..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite health getFailedJobs \ - --name v1-database \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-pub-sub.md b/docs/examples/1.6.x/console-cli/examples/health/get-pub-sub.md deleted file mode 100644 index aa1773b35b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-pub-sub.md +++ /dev/null @@ -1 +0,0 @@ -appwrite health getPubSub diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-builds.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-builds.md deleted file mode 100644 index 7204c2c896..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-builds.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getQueueBuilds \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-certificates.md deleted file mode 100644 index 203e8650cc..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getQueueCertificates \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-databases.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-databases.md deleted file mode 100644 index f30b941cbc..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-databases.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite health getQueueDatabases \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-deletes.md deleted file mode 100644 index 1d44146dc4..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getQueueDeletes \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-functions.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-functions.md deleted file mode 100644 index 4aca467306..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-functions.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getQueueFunctions \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-logs.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-logs.md deleted file mode 100644 index 3f1386b73a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-logs.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getQueueLogs \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-mails.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-mails.md deleted file mode 100644 index a41f4c308b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-mails.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getQueueMails \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-messaging.md deleted file mode 100644 index 11b7ff832b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getQueueMessaging \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-migrations.md deleted file mode 100644 index 2f17bb56f4..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getQueueMigrations \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage-dump.md deleted file mode 100644 index 34f8abd8c0..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getQueueUsageDump \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage.md deleted file mode 100644 index d021a3faa1..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-usage.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getQueueUsage \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue-webhooks.md deleted file mode 100644 index 471175bbe4..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite health getQueueWebhooks \ - diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-queue.md b/docs/examples/1.6.x/console-cli/examples/health/get-queue.md deleted file mode 100644 index 24ad16cbaa..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-queue.md +++ /dev/null @@ -1 +0,0 @@ -appwrite health getQueue diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-storage-local.md b/docs/examples/1.6.x/console-cli/examples/health/get-storage-local.md deleted file mode 100644 index b5df39fae0..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-storage-local.md +++ /dev/null @@ -1 +0,0 @@ -appwrite health getStorageLocal diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-storage.md b/docs/examples/1.6.x/console-cli/examples/health/get-storage.md deleted file mode 100644 index eccd21acc3..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-storage.md +++ /dev/null @@ -1 +0,0 @@ -appwrite health getStorage diff --git a/docs/examples/1.6.x/console-cli/examples/health/get-time.md b/docs/examples/1.6.x/console-cli/examples/health/get-time.md deleted file mode 100644 index 067e5daf9e..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get-time.md +++ /dev/null @@ -1 +0,0 @@ -appwrite health getTime diff --git a/docs/examples/1.6.x/console-cli/examples/health/get.md b/docs/examples/1.6.x/console-cli/examples/health/get.md deleted file mode 100644 index 94c08e5aa3..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/health/get.md +++ /dev/null @@ -1 +0,0 @@ -appwrite health get diff --git a/docs/examples/1.6.x/console-cli/examples/locale/get.md b/docs/examples/1.6.x/console-cli/examples/locale/get.md deleted file mode 100644 index 2002a06c20..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/locale/get.md +++ /dev/null @@ -1 +0,0 @@ -appwrite locale get diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-codes.md b/docs/examples/1.6.x/console-cli/examples/locale/list-codes.md deleted file mode 100644 index 5586d1566c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/locale/list-codes.md +++ /dev/null @@ -1 +0,0 @@ -appwrite locale listCodes diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-continents.md b/docs/examples/1.6.x/console-cli/examples/locale/list-continents.md deleted file mode 100644 index 775af5d9df..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/locale/list-continents.md +++ /dev/null @@ -1 +0,0 @@ -appwrite locale listContinents diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/console-cli/examples/locale/list-countries-e-u.md deleted file mode 100644 index 43b7eff7ad..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1 +0,0 @@ -appwrite locale listCountriesEU diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/console-cli/examples/locale/list-countries-phones.md deleted file mode 100644 index 072516bf71..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/locale/list-countries-phones.md +++ /dev/null @@ -1 +0,0 @@ -appwrite locale listCountriesPhones diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-countries.md b/docs/examples/1.6.x/console-cli/examples/locale/list-countries.md deleted file mode 100644 index ee7101df68..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/locale/list-countries.md +++ /dev/null @@ -1 +0,0 @@ -appwrite locale listCountries diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-currencies.md b/docs/examples/1.6.x/console-cli/examples/locale/list-currencies.md deleted file mode 100644 index 01b1b3c4b2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/locale/list-currencies.md +++ /dev/null @@ -1 +0,0 @@ -appwrite locale listCurrencies diff --git a/docs/examples/1.6.x/console-cli/examples/locale/list-languages.md b/docs/examples/1.6.x/console-cli/examples/locale/list-languages.md deleted file mode 100644 index d47622c570..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/locale/list-languages.md +++ /dev/null @@ -1 +0,0 @@ -appwrite locale listLanguages diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-apns-provider.md deleted file mode 100644 index 8b369f403d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite messaging createApnsProvider \ - --providerId <PROVIDER_ID> \ - --name <NAME> \ - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-email.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-email.md deleted file mode 100644 index 2a8e03b7da..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-email.md +++ /dev/null @@ -1,13 +0,0 @@ -appwrite messaging createEmail \ - --messageId <MESSAGE_ID> \ - --subject <SUBJECT> \ - --content <CONTENT> \ - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-fcm-provider.md deleted file mode 100644 index a19dcbe28c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite messaging createFcmProvider \ - --providerId <PROVIDER_ID> \ - --name <NAME> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index 6b07359194..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,11 +0,0 @@ -appwrite messaging createMailgunProvider \ - --providerId <PROVIDER_ID> \ - --name <NAME> \ - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-msg91provider.md deleted file mode 100644 index f687e36472..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite messaging createMsg91Provider \ - --providerId <PROVIDER_ID> \ - --name <NAME> \ - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-push.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-push.md deleted file mode 100644 index e187342503..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-push.md +++ /dev/null @@ -1,17 +0,0 @@ -appwrite messaging createPush \ - --messageId <MESSAGE_ID> \ - --title <TITLE> \ - --body <BODY> \ - - - - - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index de8d059abb..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite messaging createSendgridProvider \ - --providerId <PROVIDER_ID> \ - --name <NAME> \ - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-sms.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-sms.md deleted file mode 100644 index dfc9b27ff3..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-sms.md +++ /dev/null @@ -1,8 +0,0 @@ -appwrite messaging createSms \ - --messageId <MESSAGE_ID> \ - --content <CONTENT> \ - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-smtp-provider.md deleted file mode 100644 index 13f04fe648..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -appwrite messaging createSmtpProvider \ - --providerId <PROVIDER_ID> \ - --name <NAME> \ - --host <HOST> \ - - - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-subscriber.md deleted file mode 100644 index 5e65c36df7..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite messaging createSubscriber \ - --topicId <TOPIC_ID> \ - --subscriberId <SUBSCRIBER_ID> \ - --targetId <TARGET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-telesign-provider.md deleted file mode 100644 index 783f7594fd..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite messaging createTelesignProvider \ - --providerId <PROVIDER_ID> \ - --name <NAME> \ - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index 77185c71de..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite messaging createTextmagicProvider \ - --providerId <PROVIDER_ID> \ - --name <NAME> \ - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-topic.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-topic.md deleted file mode 100644 index 1d57e1cee0..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-topic.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite messaging createTopic \ - --topicId <TOPIC_ID> \ - --name <NAME> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-twilio-provider.md deleted file mode 100644 index 91fdaae96b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite messaging createTwilioProvider \ - --providerId <PROVIDER_ID> \ - --name <NAME> \ - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/create-vonage-provider.md deleted file mode 100644 index 1939d1c04b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite messaging createVonageProvider \ - --providerId <PROVIDER_ID> \ - --name <NAME> \ - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/delete-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/delete-provider.md deleted file mode 100644 index a93885573c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/delete-provider.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite messaging deleteProvider \ - --providerId <PROVIDER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/console-cli/examples/messaging/delete-subscriber.md deleted file mode 100644 index c535154df6..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite messaging deleteSubscriber \ - --topicId <TOPIC_ID> \ - --subscriberId <SUBSCRIBER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/delete-topic.md b/docs/examples/1.6.x/console-cli/examples/messaging/delete-topic.md deleted file mode 100644 index 1fa387c6ab..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/delete-topic.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite messaging deleteTopic \ - --topicId <TOPIC_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/delete.md b/docs/examples/1.6.x/console-cli/examples/messaging/delete.md deleted file mode 100644 index 82ff141b03..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/delete.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite messaging delete \ - --messageId <MESSAGE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/get-message.md b/docs/examples/1.6.x/console-cli/examples/messaging/get-message.md deleted file mode 100644 index 0144f79699..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/get-message.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite messaging getMessage \ - --messageId <MESSAGE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/get-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/get-provider.md deleted file mode 100644 index 9da9f2d864..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/get-provider.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite messaging getProvider \ - --providerId <PROVIDER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/console-cli/examples/messaging/get-subscriber.md deleted file mode 100644 index 02f8bc0e57..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite messaging getSubscriber \ - --topicId <TOPIC_ID> \ - --subscriberId <SUBSCRIBER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/get-topic.md b/docs/examples/1.6.x/console-cli/examples/messaging/get-topic.md deleted file mode 100644 index feb2dc66b6..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/get-topic.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite messaging getTopic \ - --topicId <TOPIC_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-message-logs.md deleted file mode 100644 index 91366f35f7..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite messaging listMessageLogs \ - --messageId <MESSAGE_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-messages.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-messages.md deleted file mode 100644 index 6ab04b0fd2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/list-messages.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite messaging listMessages \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-provider-logs.md deleted file mode 100644 index 0dee2e3f4b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite messaging listProviderLogs \ - --providerId <PROVIDER_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-providers.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-providers.md deleted file mode 100644 index 0a2ce47a3f..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/list-providers.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite messaging listProviders \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index 4a04ac4373..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite messaging listSubscriberLogs \ - --subscriberId <SUBSCRIBER_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-subscribers.md deleted file mode 100644 index 2eed8bd3f0..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite messaging listSubscribers \ - --topicId <TOPIC_ID> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-targets.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-targets.md deleted file mode 100644 index 7efa50ee3b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/list-targets.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite messaging listTargets \ - --messageId <MESSAGE_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-topic-logs.md deleted file mode 100644 index f23c10aba6..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite messaging listTopicLogs \ - --topicId <TOPIC_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/list-topics.md b/docs/examples/1.6.x/console-cli/examples/messaging/list-topics.md deleted file mode 100644 index 1810a7bd7b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/list-topics.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite messaging listTopics \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-apns-provider.md deleted file mode 100644 index 9e895a066a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite messaging updateApnsProvider \ - --providerId <PROVIDER_ID> \ - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-email.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-email.md deleted file mode 100644 index 934fd29213..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-email.md +++ /dev/null @@ -1,13 +0,0 @@ -appwrite messaging updateEmail \ - --messageId <MESSAGE_ID> \ - - - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-fcm-provider.md deleted file mode 100644 index 000022361f..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite messaging updateFcmProvider \ - --providerId <PROVIDER_ID> \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index f35c5e9157..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,11 +0,0 @@ -appwrite messaging updateMailgunProvider \ - --providerId <PROVIDER_ID> \ - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-msg91provider.md deleted file mode 100644 index 8e2d604a19..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite messaging updateMsg91Provider \ - --providerId <PROVIDER_ID> \ - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-push.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-push.md deleted file mode 100644 index 70f215c935..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-push.md +++ /dev/null @@ -1,17 +0,0 @@ -appwrite messaging updatePush \ - --messageId <MESSAGE_ID> \ - - - - - - - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index 7f2e97dbf7..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite messaging updateSendgridProvider \ - --providerId <PROVIDER_ID> \ - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-sms.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-sms.md deleted file mode 100644 index a30ff43d0c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-sms.md +++ /dev/null @@ -1,8 +0,0 @@ -appwrite messaging updateSms \ - --messageId <MESSAGE_ID> \ - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-smtp-provider.md deleted file mode 100644 index 4e0f7b6b8d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -appwrite messaging updateSmtpProvider \ - --providerId <PROVIDER_ID> \ - - - - - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-telesign-provider.md deleted file mode 100644 index 0a92f2cacd..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite messaging updateTelesignProvider \ - --providerId <PROVIDER_ID> \ - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index 79160b2461..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite messaging updateTextmagicProvider \ - --providerId <PROVIDER_ID> \ - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-topic.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-topic.md deleted file mode 100644 index d10b0edde3..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-topic.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite messaging updateTopic \ - --topicId <TOPIC_ID> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-twilio-provider.md deleted file mode 100644 index c967d724af..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite messaging updateTwilioProvider \ - --providerId <PROVIDER_ID> \ - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/console-cli/examples/messaging/update-vonage-provider.md deleted file mode 100644 index 11f7963be2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite messaging updateVonageProvider \ - --providerId <PROVIDER_ID> \ - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/create-appwrite-migration.md b/docs/examples/1.6.x/console-cli/examples/migrations/create-appwrite-migration.md deleted file mode 100644 index 73e9ee62d8..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/create-appwrite-migration.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite migrations createAppwriteMigration \ - --resources one two three \ - --endpoint https://example.com \ - --projectId <PROJECT_ID> \ - --apiKey <API_KEY> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-migration.md b/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-migration.md deleted file mode 100644 index 3dfb3aeac6..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-migration.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite migrations createFirebaseMigration \ - --resources one two three \ - --serviceAccount <SERVICE_ACCOUNT> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-o-auth-migration.md b/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-o-auth-migration.md deleted file mode 100644 index 207becba03..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/create-firebase-o-auth-migration.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite migrations createFirebaseOAuthMigration \ - --resources one two three \ - --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/create-n-host-migration.md b/docs/examples/1.6.x/console-cli/examples/migrations/create-n-host-migration.md deleted file mode 100644 index d959897109..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/create-n-host-migration.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite migrations createNHostMigration \ - --resources one two three \ - --subdomain <SUBDOMAIN> \ - --region <REGION> \ - --adminSecret <ADMIN_SECRET> \ - --database <DATABASE> \ - --username <USERNAME> \ - --password <PASSWORD> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/create-supabase-migration.md b/docs/examples/1.6.x/console-cli/examples/migrations/create-supabase-migration.md deleted file mode 100644 index 0620f3ba2e..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/create-supabase-migration.md +++ /dev/null @@ -1,8 +0,0 @@ -appwrite migrations createSupabaseMigration \ - --resources one two three \ - --endpoint https://example.com \ - --apiKey <API_KEY> \ - --databaseHost <DATABASE_HOST> \ - --username <USERNAME> \ - --password <PASSWORD> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/delete-firebase-auth.md b/docs/examples/1.6.x/console-cli/examples/migrations/delete-firebase-auth.md deleted file mode 100644 index d58abd9878..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/delete-firebase-auth.md +++ /dev/null @@ -1 +0,0 @@ -appwrite migrations deleteFirebaseAuth diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/delete.md b/docs/examples/1.6.x/console-cli/examples/migrations/delete.md deleted file mode 100644 index 9dac1aa3db..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/delete.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite migrations delete \ - --migrationId <MIGRATION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get-appwrite-report.md b/docs/examples/1.6.x/console-cli/examples/migrations/get-appwrite-report.md deleted file mode 100644 index 745e9fb98c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/get-appwrite-report.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite migrations getAppwriteReport \ - --resources one two three \ - --endpoint https://example.com \ - --projectID <PROJECT_ID> \ - --key <KEY> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report-o-auth.md b/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report-o-auth.md deleted file mode 100644 index 0bdbf3e435..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report-o-auth.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite migrations getFirebaseReportOAuth \ - --resources one two three \ - --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report.md b/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report.md deleted file mode 100644 index 73c7e1ca14..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/get-firebase-report.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite migrations getFirebaseReport \ - --resources one two three \ - --serviceAccount <SERVICE_ACCOUNT> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get-n-host-report.md b/docs/examples/1.6.x/console-cli/examples/migrations/get-n-host-report.md deleted file mode 100644 index 6b7e2eaff2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/get-n-host-report.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite migrations getNHostReport \ - --resources one two three \ - --subdomain <SUBDOMAIN> \ - --region <REGION> \ - --adminSecret <ADMIN_SECRET> \ - --database <DATABASE> \ - --username <USERNAME> \ - --password <PASSWORD> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get-supabase-report.md b/docs/examples/1.6.x/console-cli/examples/migrations/get-supabase-report.md deleted file mode 100644 index 9754f38e24..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/get-supabase-report.md +++ /dev/null @@ -1,8 +0,0 @@ -appwrite migrations getSupabaseReport \ - --resources one two three \ - --endpoint https://example.com \ - --apiKey <API_KEY> \ - --databaseHost <DATABASE_HOST> \ - --username <USERNAME> \ - --password <PASSWORD> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/get.md b/docs/examples/1.6.x/console-cli/examples/migrations/get.md deleted file mode 100644 index 8810646c7e..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/get.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite migrations get \ - --migrationId <MIGRATION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/list-firebase-projects.md b/docs/examples/1.6.x/console-cli/examples/migrations/list-firebase-projects.md deleted file mode 100644 index a0e59713eb..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/list-firebase-projects.md +++ /dev/null @@ -1 +0,0 @@ -appwrite migrations listFirebaseProjects diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/list.md b/docs/examples/1.6.x/console-cli/examples/migrations/list.md deleted file mode 100644 index c120a61e80..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/list.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite migrations list \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/migrations/retry.md b/docs/examples/1.6.x/console-cli/examples/migrations/retry.md deleted file mode 100644 index 518f86cee7..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/migrations/retry.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite migrations retry \ - --migrationId <MIGRATION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/project/create-variable.md b/docs/examples/1.6.x/console-cli/examples/project/create-variable.md deleted file mode 100644 index a587ac3eab..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/project/create-variable.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite project createVariable \ - --key <KEY> \ - --value <VALUE> diff --git a/docs/examples/1.6.x/console-cli/examples/project/delete-variable.md b/docs/examples/1.6.x/console-cli/examples/project/delete-variable.md deleted file mode 100644 index 7fdda874fd..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/project/delete-variable.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite project deleteVariable \ - --variableId <VARIABLE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/project/get-usage.md b/docs/examples/1.6.x/console-cli/examples/project/get-usage.md deleted file mode 100644 index 9b4c296a8c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/project/get-usage.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite project getUsage \ - --startDate '' \ - --endDate '' \ - diff --git a/docs/examples/1.6.x/console-cli/examples/project/get-variable.md b/docs/examples/1.6.x/console-cli/examples/project/get-variable.md deleted file mode 100644 index b2d482586b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/project/get-variable.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite project getVariable \ - --variableId <VARIABLE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/project/list-variables.md b/docs/examples/1.6.x/console-cli/examples/project/list-variables.md deleted file mode 100644 index bd26c7db6b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/project/list-variables.md +++ /dev/null @@ -1 +0,0 @@ -appwrite project listVariables diff --git a/docs/examples/1.6.x/console-cli/examples/project/update-variable.md b/docs/examples/1.6.x/console-cli/examples/project/update-variable.md deleted file mode 100644 index 946696418c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/project/update-variable.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite project updateVariable \ - --variableId <VARIABLE_ID> \ - --key <KEY> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create-j-w-t.md b/docs/examples/1.6.x/console-cli/examples/projects/create-j-w-t.md deleted file mode 100644 index d703d36b65..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/create-j-w-t.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite projects createJWT \ - --projectId <PROJECT_ID> \ - --scopes one two three \ - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create-key.md b/docs/examples/1.6.x/console-cli/examples/projects/create-key.md deleted file mode 100644 index fb986dcebc..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/create-key.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite projects createKey \ - --projectId <PROJECT_ID> \ - --name <NAME> \ - --scopes one two three \ - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create-platform.md b/docs/examples/1.6.x/console-cli/examples/projects/create-platform.md deleted file mode 100644 index 8727d21d64..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/create-platform.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite projects createPlatform \ - --projectId <PROJECT_ID> \ - --type web \ - --name <NAME> \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create-smtp-test.md b/docs/examples/1.6.x/console-cli/examples/projects/create-smtp-test.md deleted file mode 100644 index 66ce5880aa..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/create-smtp-test.md +++ /dev/null @@ -1,11 +0,0 @@ -appwrite projects createSmtpTest \ - --projectId <PROJECT_ID> \ - --emails one two three \ - --senderName <SENDER_NAME> \ - --senderEmail email@example.com \ - --host '' \ - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create-webhook.md b/docs/examples/1.6.x/console-cli/examples/projects/create-webhook.md deleted file mode 100644 index 03ecf4110d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/create-webhook.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite projects createWebhook \ - --projectId <PROJECT_ID> \ - --name <NAME> \ - --events one two three \ - --url '' \ - --security false \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/create.md b/docs/examples/1.6.x/console-cli/examples/projects/create.md deleted file mode 100644 index 0504785503..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/create.md +++ /dev/null @@ -1,14 +0,0 @@ -appwrite projects create \ - --projectId '' \ - --name <NAME> \ - --teamId <TEAM_ID> \ - - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete-email-template.md b/docs/examples/1.6.x/console-cli/examples/projects/delete-email-template.md deleted file mode 100644 index 01ce0fac68..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/delete-email-template.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite projects deleteEmailTemplate \ - --projectId <PROJECT_ID> \ - --type verification \ - --locale af diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete-key.md b/docs/examples/1.6.x/console-cli/examples/projects/delete-key.md deleted file mode 100644 index 6baf05706e..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/delete-key.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects deleteKey \ - --projectId <PROJECT_ID> \ - --keyId <KEY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete-platform.md b/docs/examples/1.6.x/console-cli/examples/projects/delete-platform.md deleted file mode 100644 index a85bd865ba..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/delete-platform.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects deletePlatform \ - --projectId <PROJECT_ID> \ - --platformId <PLATFORM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete-sms-template.md b/docs/examples/1.6.x/console-cli/examples/projects/delete-sms-template.md deleted file mode 100644 index 3afcf649c7..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/delete-sms-template.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite projects deleteSmsTemplate \ - --projectId <PROJECT_ID> \ - --type verification \ - --locale af diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete-webhook.md b/docs/examples/1.6.x/console-cli/examples/projects/delete-webhook.md deleted file mode 100644 index a67301ef07..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/delete-webhook.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects deleteWebhook \ - --projectId <PROJECT_ID> \ - --webhookId <WEBHOOK_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/delete.md b/docs/examples/1.6.x/console-cli/examples/projects/delete.md deleted file mode 100644 index a4ffc70c91..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/delete.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite projects delete \ - --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get-email-template.md b/docs/examples/1.6.x/console-cli/examples/projects/get-email-template.md deleted file mode 100644 index 6e4c21e52b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/get-email-template.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite projects getEmailTemplate \ - --projectId <PROJECT_ID> \ - --type verification \ - --locale af diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get-key.md b/docs/examples/1.6.x/console-cli/examples/projects/get-key.md deleted file mode 100644 index f69b51bbe2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/get-key.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects getKey \ - --projectId <PROJECT_ID> \ - --keyId <KEY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get-platform.md b/docs/examples/1.6.x/console-cli/examples/projects/get-platform.md deleted file mode 100644 index 67648be035..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/get-platform.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects getPlatform \ - --projectId <PROJECT_ID> \ - --platformId <PLATFORM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get-sms-template.md b/docs/examples/1.6.x/console-cli/examples/projects/get-sms-template.md deleted file mode 100644 index c655953c8e..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/get-sms-template.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite projects getSmsTemplate \ - --projectId <PROJECT_ID> \ - --type verification \ - --locale af diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get-webhook.md b/docs/examples/1.6.x/console-cli/examples/projects/get-webhook.md deleted file mode 100644 index 890bf37069..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/get-webhook.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects getWebhook \ - --projectId <PROJECT_ID> \ - --webhookId <WEBHOOK_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/get.md b/docs/examples/1.6.x/console-cli/examples/projects/get.md deleted file mode 100644 index 919321b81d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/get.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite projects get \ - --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/list-keys.md b/docs/examples/1.6.x/console-cli/examples/projects/list-keys.md deleted file mode 100644 index cc37680b5b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/list-keys.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite projects listKeys \ - --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/list-platforms.md b/docs/examples/1.6.x/console-cli/examples/projects/list-platforms.md deleted file mode 100644 index 5fc2ea4106..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/list-platforms.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite projects listPlatforms \ - --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/list-webhooks.md b/docs/examples/1.6.x/console-cli/examples/projects/list-webhooks.md deleted file mode 100644 index dcf9953f80..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/list-webhooks.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite projects listWebhooks \ - --projectId <PROJECT_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/list.md b/docs/examples/1.6.x/console-cli/examples/projects/list.md deleted file mode 100644 index 0d3dd7a539..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/list.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects list \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-api-status-all.md b/docs/examples/1.6.x/console-cli/examples/projects/update-api-status-all.md deleted file mode 100644 index e5f63c59a3..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-api-status-all.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updateApiStatusAll \ - --projectId <PROJECT_ID> \ - --status false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-api-status.md b/docs/examples/1.6.x/console-cli/examples/projects/update-api-status.md deleted file mode 100644 index 01120957af..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-api-status.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite projects updateApiStatus \ - --projectId <PROJECT_ID> \ - --api rest \ - --status false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-duration.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-duration.md deleted file mode 100644 index ad6f8ac97c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-duration.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updateAuthDuration \ - --projectId <PROJECT_ID> \ - --duration 0 diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-limit.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-limit.md deleted file mode 100644 index 9d01fa5a1a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-limit.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updateAuthLimit \ - --projectId <PROJECT_ID> \ - --limit 0 diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-dictionary.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-dictionary.md deleted file mode 100644 index f477bba56d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-dictionary.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updateAuthPasswordDictionary \ - --projectId <PROJECT_ID> \ - --enabled false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-history.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-history.md deleted file mode 100644 index 8b9b90a32a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-password-history.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updateAuthPasswordHistory \ - --projectId <PROJECT_ID> \ - --limit 0 diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-sessions-limit.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-sessions-limit.md deleted file mode 100644 index 2a1294d17b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-sessions-limit.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updateAuthSessionsLimit \ - --projectId <PROJECT_ID> \ - --limit 1 diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-status.md b/docs/examples/1.6.x/console-cli/examples/projects/update-auth-status.md deleted file mode 100644 index 848987b2f8..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-auth-status.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite projects updateAuthStatus \ - --projectId <PROJECT_ID> \ - --method email-password \ - --status false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-email-template.md b/docs/examples/1.6.x/console-cli/examples/projects/update-email-template.md deleted file mode 100644 index a3acd066ec..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-email-template.md +++ /dev/null @@ -1,9 +0,0 @@ -appwrite projects updateEmailTemplate \ - --projectId <PROJECT_ID> \ - --type verification \ - --locale af \ - --subject <SUBJECT> \ - --message <MESSAGE> \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-key.md b/docs/examples/1.6.x/console-cli/examples/projects/update-key.md deleted file mode 100644 index 6d3dc198da..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-key.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite projects updateKey \ - --projectId <PROJECT_ID> \ - --keyId <KEY_ID> \ - --name <NAME> \ - --scopes one two three \ - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-mock-numbers.md b/docs/examples/1.6.x/console-cli/examples/projects/update-mock-numbers.md deleted file mode 100644 index 733cc16887..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-mock-numbers.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updateMockNumbers \ - --projectId <PROJECT_ID> \ - --numbers one two three diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-o-auth2.md b/docs/examples/1.6.x/console-cli/examples/projects/update-o-auth2.md deleted file mode 100644 index 92f6718962..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-o-auth2.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite projects updateOAuth2 \ - --projectId <PROJECT_ID> \ - --provider amazon \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-personal-data-check.md b/docs/examples/1.6.x/console-cli/examples/projects/update-personal-data-check.md deleted file mode 100644 index 21dca78369..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-personal-data-check.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updatePersonalDataCheck \ - --projectId <PROJECT_ID> \ - --enabled false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-platform.md b/docs/examples/1.6.x/console-cli/examples/projects/update-platform.md deleted file mode 100644 index 05b1602ae9..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-platform.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite projects updatePlatform \ - --projectId <PROJECT_ID> \ - --platformId <PLATFORM_ID> \ - --name <NAME> \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-service-status-all.md b/docs/examples/1.6.x/console-cli/examples/projects/update-service-status-all.md deleted file mode 100644 index 1ffb77e085..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-service-status-all.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updateServiceStatusAll \ - --projectId <PROJECT_ID> \ - --status false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-service-status.md b/docs/examples/1.6.x/console-cli/examples/projects/update-service-status.md deleted file mode 100644 index 03963a1214..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-service-status.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite projects updateServiceStatus \ - --projectId <PROJECT_ID> \ - --service account \ - --status false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-session-alerts.md b/docs/examples/1.6.x/console-cli/examples/projects/update-session-alerts.md deleted file mode 100644 index bd23b7417a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-session-alerts.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updateSessionAlerts \ - --projectId <PROJECT_ID> \ - --alerts false diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-sms-template.md b/docs/examples/1.6.x/console-cli/examples/projects/update-sms-template.md deleted file mode 100644 index fc8310eb25..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-sms-template.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite projects updateSmsTemplate \ - --projectId <PROJECT_ID> \ - --type verification \ - --locale af \ - --message <MESSAGE> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-smtp.md b/docs/examples/1.6.x/console-cli/examples/projects/update-smtp.md deleted file mode 100644 index 0afbe9cec9..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-smtp.md +++ /dev/null @@ -1,11 +0,0 @@ -appwrite projects updateSmtp \ - --projectId <PROJECT_ID> \ - --enabled false \ - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-team.md b/docs/examples/1.6.x/console-cli/examples/projects/update-team.md deleted file mode 100644 index 49214ad9f3..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-team.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updateTeam \ - --projectId <PROJECT_ID> \ - --teamId <TEAM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-webhook-signature.md b/docs/examples/1.6.x/console-cli/examples/projects/update-webhook-signature.md deleted file mode 100644 index 6034ef01f6..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-webhook-signature.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite projects updateWebhookSignature \ - --projectId <PROJECT_ID> \ - --webhookId <WEBHOOK_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update-webhook.md b/docs/examples/1.6.x/console-cli/examples/projects/update-webhook.md deleted file mode 100644 index 51c536d74c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update-webhook.md +++ /dev/null @@ -1,10 +0,0 @@ -appwrite projects updateWebhook \ - --projectId <PROJECT_ID> \ - --webhookId <WEBHOOK_ID> \ - --name <NAME> \ - --events one two three \ - --url '' \ - --security false \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/projects/update.md b/docs/examples/1.6.x/console-cli/examples/projects/update.md deleted file mode 100644 index d4df289636..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/projects/update.md +++ /dev/null @@ -1,12 +0,0 @@ -appwrite projects update \ - --projectId <PROJECT_ID> \ - --name <NAME> \ - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/proxy/create-rule.md b/docs/examples/1.6.x/console-cli/examples/proxy/create-rule.md deleted file mode 100644 index 3d821040a7..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/proxy/create-rule.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite proxy createRule \ - --domain '' \ - --resourceType api \ - diff --git a/docs/examples/1.6.x/console-cli/examples/proxy/delete-rule.md b/docs/examples/1.6.x/console-cli/examples/proxy/delete-rule.md deleted file mode 100644 index b11b6ca23e..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/proxy/delete-rule.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite proxy deleteRule \ - --ruleId <RULE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/proxy/get-rule.md b/docs/examples/1.6.x/console-cli/examples/proxy/get-rule.md deleted file mode 100644 index 85d11a50b1..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/proxy/get-rule.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite proxy getRule \ - --ruleId <RULE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/proxy/list-rules.md b/docs/examples/1.6.x/console-cli/examples/proxy/list-rules.md deleted file mode 100644 index bc654bac5c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/proxy/list-rules.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite proxy listRules \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/proxy/update-rule-verification.md b/docs/examples/1.6.x/console-cli/examples/proxy/update-rule-verification.md deleted file mode 100644 index 8200d15702..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/proxy/update-rule-verification.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite proxy updateRuleVerification \ - --ruleId <RULE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/create-bucket.md b/docs/examples/1.6.x/console-cli/examples/storage/create-bucket.md deleted file mode 100644 index 878c10d253..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/create-bucket.md +++ /dev/null @@ -1,11 +0,0 @@ -appwrite storage createBucket \ - --bucketId <BUCKET_ID> \ - --name <NAME> \ - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/storage/create-file.md b/docs/examples/1.6.x/console-cli/examples/storage/create-file.md deleted file mode 100644 index 67bd4da2c0..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/create-file.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite storage createFile \ - --bucketId <BUCKET_ID> \ - --fileId <FILE_ID> \ - --file 'path/to/file.png' \ - diff --git a/docs/examples/1.6.x/console-cli/examples/storage/delete-bucket.md b/docs/examples/1.6.x/console-cli/examples/storage/delete-bucket.md deleted file mode 100644 index e51797e12c..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/delete-bucket.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite storage deleteBucket \ - --bucketId <BUCKET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/delete-file.md b/docs/examples/1.6.x/console-cli/examples/storage/delete-file.md deleted file mode 100644 index 79c03e8288..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/delete-file.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite storage deleteFile \ - --bucketId <BUCKET_ID> \ - --fileId <FILE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-bucket-usage.md b/docs/examples/1.6.x/console-cli/examples/storage/get-bucket-usage.md deleted file mode 100644 index df3659c60a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/get-bucket-usage.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite storage getBucketUsage \ - --bucketId <BUCKET_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-bucket.md b/docs/examples/1.6.x/console-cli/examples/storage/get-bucket.md deleted file mode 100644 index cf8725b35d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/get-bucket.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite storage getBucket \ - --bucketId <BUCKET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-file-download.md b/docs/examples/1.6.x/console-cli/examples/storage/get-file-download.md deleted file mode 100644 index c97c074b35..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/get-file-download.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite storage getFileDownload \ - --bucketId <BUCKET_ID> \ - --fileId <FILE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-file-preview.md b/docs/examples/1.6.x/console-cli/examples/storage/get-file-preview.md deleted file mode 100644 index 82565fb5e7..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/get-file-preview.md +++ /dev/null @@ -1,14 +0,0 @@ -appwrite storage getFilePreview \ - --bucketId <BUCKET_ID> \ - --fileId <FILE_ID> \ - - - - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-file-view.md b/docs/examples/1.6.x/console-cli/examples/storage/get-file-view.md deleted file mode 100644 index ac3bb9d742..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/get-file-view.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite storage getFileView \ - --bucketId <BUCKET_ID> \ - --fileId <FILE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-file.md b/docs/examples/1.6.x/console-cli/examples/storage/get-file.md deleted file mode 100644 index 641c20d2b0..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/get-file.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite storage getFile \ - --bucketId <BUCKET_ID> \ - --fileId <FILE_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/storage/get-usage.md b/docs/examples/1.6.x/console-cli/examples/storage/get-usage.md deleted file mode 100644 index 29466e02f0..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/get-usage.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite storage getUsage \ - diff --git a/docs/examples/1.6.x/console-cli/examples/storage/list-buckets.md b/docs/examples/1.6.x/console-cli/examples/storage/list-buckets.md deleted file mode 100644 index a5cad1988f..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/list-buckets.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite storage listBuckets \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/storage/list-files.md b/docs/examples/1.6.x/console-cli/examples/storage/list-files.md deleted file mode 100644 index 0e1c2f09c0..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/list-files.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite storage listFiles \ - --bucketId <BUCKET_ID> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/storage/update-bucket.md b/docs/examples/1.6.x/console-cli/examples/storage/update-bucket.md deleted file mode 100644 index b006a7bf74..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/update-bucket.md +++ /dev/null @@ -1,11 +0,0 @@ -appwrite storage updateBucket \ - --bucketId <BUCKET_ID> \ - --name <NAME> \ - - - - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/storage/update-file.md b/docs/examples/1.6.x/console-cli/examples/storage/update-file.md deleted file mode 100644 index 593ea658a0..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/storage/update-file.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite storage updateFile \ - --bucketId <BUCKET_ID> \ - --fileId <FILE_ID> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/teams/create-membership.md b/docs/examples/1.6.x/console-cli/examples/teams/create-membership.md deleted file mode 100644 index 0d0fc8df09..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/create-membership.md +++ /dev/null @@ -1,8 +0,0 @@ -appwrite teams createMembership \ - --teamId <TEAM_ID> \ - --roles one two three \ - - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/teams/create.md b/docs/examples/1.6.x/console-cli/examples/teams/create.md deleted file mode 100644 index e0f9a126f2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/create.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite teams create \ - --teamId <TEAM_ID> \ - --name <NAME> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/teams/delete-membership.md b/docs/examples/1.6.x/console-cli/examples/teams/delete-membership.md deleted file mode 100644 index 58d0adbac7..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/delete-membership.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite teams deleteMembership \ - --teamId <TEAM_ID> \ - --membershipId <MEMBERSHIP_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/delete.md b/docs/examples/1.6.x/console-cli/examples/teams/delete.md deleted file mode 100644 index 5b018158cd..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/delete.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite teams delete \ - --teamId <TEAM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/get-membership.md b/docs/examples/1.6.x/console-cli/examples/teams/get-membership.md deleted file mode 100644 index 5e6af4c1a1..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/get-membership.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite teams getMembership \ - --teamId <TEAM_ID> \ - --membershipId <MEMBERSHIP_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/get-prefs.md b/docs/examples/1.6.x/console-cli/examples/teams/get-prefs.md deleted file mode 100644 index 2ab1f1dc01..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/get-prefs.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite teams getPrefs \ - --teamId <TEAM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/get.md b/docs/examples/1.6.x/console-cli/examples/teams/get.md deleted file mode 100644 index c8e75b7543..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/get.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite teams get \ - --teamId <TEAM_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/list-logs.md b/docs/examples/1.6.x/console-cli/examples/teams/list-logs.md deleted file mode 100644 index 66149350d8..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/list-logs.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite teams listLogs \ - --teamId <TEAM_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/teams/list-memberships.md b/docs/examples/1.6.x/console-cli/examples/teams/list-memberships.md deleted file mode 100644 index 050ea961d2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/list-memberships.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite teams listMemberships \ - --teamId <TEAM_ID> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/teams/list.md b/docs/examples/1.6.x/console-cli/examples/teams/list.md deleted file mode 100644 index dfffc4d4dd..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/list.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite teams list \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/teams/update-membership-status.md b/docs/examples/1.6.x/console-cli/examples/teams/update-membership-status.md deleted file mode 100644 index aa4acf9457..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/update-membership-status.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite teams updateMembershipStatus \ - --teamId <TEAM_ID> \ - --membershipId <MEMBERSHIP_ID> \ - --userId <USER_ID> \ - --secret <SECRET> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/update-membership.md b/docs/examples/1.6.x/console-cli/examples/teams/update-membership.md deleted file mode 100644 index 6cfda92920..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/update-membership.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite teams updateMembership \ - --teamId <TEAM_ID> \ - --membershipId <MEMBERSHIP_ID> \ - --roles one two three diff --git a/docs/examples/1.6.x/console-cli/examples/teams/update-name.md b/docs/examples/1.6.x/console-cli/examples/teams/update-name.md deleted file mode 100644 index 8c73e00d7b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/update-name.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite teams updateName \ - --teamId <TEAM_ID> \ - --name <NAME> diff --git a/docs/examples/1.6.x/console-cli/examples/teams/update-prefs.md b/docs/examples/1.6.x/console-cli/examples/teams/update-prefs.md deleted file mode 100644 index b6fc5a8f6e..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/teams/update-prefs.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite teams updatePrefs \ - --teamId <TEAM_ID> \ - --prefs '{ "key": "value" }' diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-argon2user.md b/docs/examples/1.6.x/console-cli/examples/users/create-argon2user.md deleted file mode 100644 index b0c7494e20..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-argon2user.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite users createArgon2User \ - --userId <USER_ID> \ - --email email@example.com \ - --password password \ - diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/console-cli/examples/users/create-bcrypt-user.md deleted file mode 100644 index b5686721b5..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite users createBcryptUser \ - --userId <USER_ID> \ - --email email@example.com \ - --password password \ - diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-j-w-t.md b/docs/examples/1.6.x/console-cli/examples/users/create-j-w-t.md deleted file mode 100644 index 220086bb1a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-j-w-t.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite users createJWT \ - --userId <USER_ID> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-m-d5user.md b/docs/examples/1.6.x/console-cli/examples/users/create-m-d5user.md deleted file mode 100644 index ba37a78be2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-m-d5user.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite users createMD5User \ - --userId <USER_ID> \ - --email email@example.com \ - --password password \ - diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index 4dbd98ff8a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users createMfaRecoveryCodes \ - --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/console-cli/examples/users/create-p-h-pass-user.md deleted file mode 100644 index 9dc378dc99..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,5 +0,0 @@ -appwrite users createPHPassUser \ - --userId <USER_ID> \ - --email email@example.com \ - --password password \ - diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/console-cli/examples/users/create-s-h-a-user.md deleted file mode 100644 index 57483625e9..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite users createSHAUser \ - --userId <USER_ID> \ - --email email@example.com \ - --password password \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index 25fc60b6e1..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,8 +0,0 @@ -appwrite users createScryptModifiedUser \ - --userId <USER_ID> \ - --email email@example.com \ - --password password \ - --passwordSalt <PASSWORD_SALT> \ - --passwordSaltSeparator <PASSWORD_SALT_SEPARATOR> \ - --passwordSignerKey <PASSWORD_SIGNER_KEY> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-user.md deleted file mode 100644 index 3fc56b1ee3..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,10 +0,0 @@ -appwrite users createScryptUser \ - --userId <USER_ID> \ - --email email@example.com \ - --password password \ - --passwordSalt <PASSWORD_SALT> \ - --passwordCpu null \ - --passwordMemory null \ - --passwordParallel null \ - --passwordLength null \ - diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-session.md b/docs/examples/1.6.x/console-cli/examples/users/create-session.md deleted file mode 100644 index c8938fa706..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-session.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users createSession \ - --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-target.md b/docs/examples/1.6.x/console-cli/examples/users/create-target.md deleted file mode 100644 index 8d9306b00e..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-target.md +++ /dev/null @@ -1,7 +0,0 @@ -appwrite users createTarget \ - --userId <USER_ID> \ - --targetId <TARGET_ID> \ - --providerType email \ - --identifier <IDENTIFIER> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/users/create-token.md b/docs/examples/1.6.x/console-cli/examples/users/create-token.md deleted file mode 100644 index 9962e72c73..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create-token.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite users createToken \ - --userId <USER_ID> \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/users/create.md b/docs/examples/1.6.x/console-cli/examples/users/create.md deleted file mode 100644 index e828f56ecb..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/create.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite users create \ - --userId <USER_ID> \ - - - - diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete-identity.md b/docs/examples/1.6.x/console-cli/examples/users/delete-identity.md deleted file mode 100644 index f3d2d6d980..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/delete-identity.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users deleteIdentity \ - --identityId <IDENTITY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/console-cli/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index edc67d0b9a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users deleteMfaAuthenticator \ - --userId <USER_ID> \ - --type totp diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete-session.md b/docs/examples/1.6.x/console-cli/examples/users/delete-session.md deleted file mode 100644 index 9f1fbdbfb3..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/delete-session.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users deleteSession \ - --userId <USER_ID> \ - --sessionId <SESSION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete-sessions.md b/docs/examples/1.6.x/console-cli/examples/users/delete-sessions.md deleted file mode 100644 index 4c683d270a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/delete-sessions.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users deleteSessions \ - --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete-target.md b/docs/examples/1.6.x/console-cli/examples/users/delete-target.md deleted file mode 100644 index e9780911fd..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/delete-target.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users deleteTarget \ - --userId <USER_ID> \ - --targetId <TARGET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/delete.md b/docs/examples/1.6.x/console-cli/examples/users/delete.md deleted file mode 100644 index 293a5b040d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/delete.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users delete \ - --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index cefcce607a..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users getMfaRecoveryCodes \ - --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/get-prefs.md b/docs/examples/1.6.x/console-cli/examples/users/get-prefs.md deleted file mode 100644 index 324aa4f508..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/get-prefs.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users getPrefs \ - --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/get-target.md b/docs/examples/1.6.x/console-cli/examples/users/get-target.md deleted file mode 100644 index b80dbd9728..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/get-target.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users getTarget \ - --userId <USER_ID> \ - --targetId <TARGET_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/get-usage.md b/docs/examples/1.6.x/console-cli/examples/users/get-usage.md deleted file mode 100644 index ad7895d3aa..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/get-usage.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users getUsage \ - diff --git a/docs/examples/1.6.x/console-cli/examples/users/get.md b/docs/examples/1.6.x/console-cli/examples/users/get.md deleted file mode 100644 index 47002c5063..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/get.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users get \ - --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-identities.md b/docs/examples/1.6.x/console-cli/examples/users/list-identities.md deleted file mode 100644 index c6cd6d5e28..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/list-identities.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users listIdentities \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-logs.md b/docs/examples/1.6.x/console-cli/examples/users/list-logs.md deleted file mode 100644 index 0b0bc1f50f..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/list-logs.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users listLogs \ - --userId <USER_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-memberships.md b/docs/examples/1.6.x/console-cli/examples/users/list-memberships.md deleted file mode 100644 index 7a9d10ee78..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/list-memberships.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users listMemberships \ - --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/console-cli/examples/users/list-mfa-factors.md deleted file mode 100644 index e5d111b8ee..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users listMfaFactors \ - --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-sessions.md b/docs/examples/1.6.x/console-cli/examples/users/list-sessions.md deleted file mode 100644 index cb85d15ff6..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/list-sessions.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users listSessions \ - --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/list-targets.md b/docs/examples/1.6.x/console-cli/examples/users/list-targets.md deleted file mode 100644 index 9b5614bd32..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/list-targets.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users listTargets \ - --userId <USER_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/users/list.md b/docs/examples/1.6.x/console-cli/examples/users/list.md deleted file mode 100644 index e5fdb9e5c5..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/list.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users list \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-email-verification.md b/docs/examples/1.6.x/console-cli/examples/users/update-email-verification.md deleted file mode 100644 index 990436f38b..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-email-verification.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users updateEmailVerification \ - --userId <USER_ID> \ - --emailVerification false diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-email.md b/docs/examples/1.6.x/console-cli/examples/users/update-email.md deleted file mode 100644 index cce20e9ebf..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-email.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users updateEmail \ - --userId <USER_ID> \ - --email email@example.com diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-labels.md b/docs/examples/1.6.x/console-cli/examples/users/update-labels.md deleted file mode 100644 index ca60c59683..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-labels.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users updateLabels \ - --userId <USER_ID> \ - --labels one two three diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/console-cli/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index 63fb7f25eb..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite users updateMfaRecoveryCodes \ - --userId <USER_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-mfa.md b/docs/examples/1.6.x/console-cli/examples/users/update-mfa.md deleted file mode 100644 index 3ccdbd8fdf..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-mfa.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users updateMfa \ - --userId <USER_ID> \ - --mfa false diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-name.md b/docs/examples/1.6.x/console-cli/examples/users/update-name.md deleted file mode 100644 index 9bf20eb117..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-name.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users updateName \ - --userId <USER_ID> \ - --name <NAME> diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-password.md b/docs/examples/1.6.x/console-cli/examples/users/update-password.md deleted file mode 100644 index c05197b3c2..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-password.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users updatePassword \ - --userId <USER_ID> \ - --password '' diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-phone-verification.md b/docs/examples/1.6.x/console-cli/examples/users/update-phone-verification.md deleted file mode 100644 index b88a282d48..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-phone-verification.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users updatePhoneVerification \ - --userId <USER_ID> \ - --phoneVerification false diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-phone.md b/docs/examples/1.6.x/console-cli/examples/users/update-phone.md deleted file mode 100644 index 118c8e3557..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-phone.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users updatePhone \ - --userId <USER_ID> \ - --number +12065550100 diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-prefs.md b/docs/examples/1.6.x/console-cli/examples/users/update-prefs.md deleted file mode 100644 index f3fa995e4d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-prefs.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users updatePrefs \ - --userId <USER_ID> \ - --prefs '{ "key": "value" }' diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-status.md b/docs/examples/1.6.x/console-cli/examples/users/update-status.md deleted file mode 100644 index b587b70e9e..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-status.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite users updateStatus \ - --userId <USER_ID> \ - --status false diff --git a/docs/examples/1.6.x/console-cli/examples/users/update-target.md b/docs/examples/1.6.x/console-cli/examples/users/update-target.md deleted file mode 100644 index d6541a0600..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/users/update-target.md +++ /dev/null @@ -1,6 +0,0 @@ -appwrite users updateTarget \ - --userId <USER_ID> \ - --targetId <TARGET_ID> \ - - - diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/create-repository-detection.md b/docs/examples/1.6.x/console-cli/examples/vcs/create-repository-detection.md deleted file mode 100644 index ffceaade73..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/vcs/create-repository-detection.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite vcs createRepositoryDetection \ - --installationId <INSTALLATION_ID> \ - --providerRepositoryId <PROVIDER_REPOSITORY_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/create-repository.md b/docs/examples/1.6.x/console-cli/examples/vcs/create-repository.md deleted file mode 100644 index a4934d5ef5..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/vcs/create-repository.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite vcs createRepository \ - --installationId <INSTALLATION_ID> \ - --name <NAME> \ - --private false diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/delete-installation.md b/docs/examples/1.6.x/console-cli/examples/vcs/delete-installation.md deleted file mode 100644 index f7d3a92001..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/vcs/delete-installation.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite vcs deleteInstallation \ - --installationId <INSTALLATION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/get-installation.md b/docs/examples/1.6.x/console-cli/examples/vcs/get-installation.md deleted file mode 100644 index df51853ea4..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/vcs/get-installation.md +++ /dev/null @@ -1,2 +0,0 @@ -appwrite vcs getInstallation \ - --installationId <INSTALLATION_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/get-repository-contents.md b/docs/examples/1.6.x/console-cli/examples/vcs/get-repository-contents.md deleted file mode 100644 index 7d378d7efa..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/vcs/get-repository-contents.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite vcs getRepositoryContents \ - --installationId <INSTALLATION_ID> \ - --providerRepositoryId <PROVIDER_REPOSITORY_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/get-repository.md b/docs/examples/1.6.x/console-cli/examples/vcs/get-repository.md deleted file mode 100644 index 9f88e18eef..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/vcs/get-repository.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite vcs getRepository \ - --installationId <INSTALLATION_ID> \ - --providerRepositoryId <PROVIDER_REPOSITORY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/list-installations.md b/docs/examples/1.6.x/console-cli/examples/vcs/list-installations.md deleted file mode 100644 index a0af28dfbb..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/vcs/list-installations.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite vcs listInstallations \ - - diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/list-repositories.md b/docs/examples/1.6.x/console-cli/examples/vcs/list-repositories.md deleted file mode 100644 index 389db553a3..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/vcs/list-repositories.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite vcs listRepositories \ - --installationId <INSTALLATION_ID> \ - diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/list-repository-branches.md b/docs/examples/1.6.x/console-cli/examples/vcs/list-repository-branches.md deleted file mode 100644 index ea2fbd29fb..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/vcs/list-repository-branches.md +++ /dev/null @@ -1,3 +0,0 @@ -appwrite vcs listRepositoryBranches \ - --installationId <INSTALLATION_ID> \ - --providerRepositoryId <PROVIDER_REPOSITORY_ID> diff --git a/docs/examples/1.6.x/console-cli/examples/vcs/update-external-deployments.md b/docs/examples/1.6.x/console-cli/examples/vcs/update-external-deployments.md deleted file mode 100644 index 417b59431d..0000000000 --- a/docs/examples/1.6.x/console-cli/examples/vcs/update-external-deployments.md +++ /dev/null @@ -1,4 +0,0 @@ -appwrite vcs updateExternalDeployments \ - --installationId <INSTALLATION_ID> \ - --repositoryId <REPOSITORY_ID> \ - --providerPullRequestId <PROVIDER_PULL_REQUEST_ID> diff --git a/docs/examples/1.6.x/console-web/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/console-web/examples/account/create-anonymous-session.md deleted file mode 100644 index ec4fe102a8..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createAnonymousSession(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-email-password-session.md b/docs/examples/1.6.x/console-web/examples/account/create-email-password-session.md deleted file mode 100644 index a3643840da..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-email-password-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createEmailPasswordSession( - 'email@example.com', // email - 'password' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-email-token.md b/docs/examples/1.6.x/console-web/examples/account/create-email-token.md deleted file mode 100644 index 4dc8080001..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-email-token.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createEmailToken( - '<USER_ID>', // userId - 'email@example.com', // email - false // phrase (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-j-w-t.md b/docs/examples/1.6.x/console-web/examples/account/create-j-w-t.md deleted file mode 100644 index 2e1751b34a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-j-w-t.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createJWT(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/console-web/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index e40acd1803..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMagicURLToken( - '<USER_ID>', // userId - 'email@example.com', // email - 'https://example.com', // url (optional) - false // phrase (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/console-web/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 02f9c6be11..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account, AuthenticatorType } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMfaAuthenticator( - AuthenticatorType.Totp // type -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/console-web/examples/account/create-mfa-challenge.md deleted file mode 100644 index b97c6493c9..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account, AuthenticationFactor } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMfaChallenge( - AuthenticationFactor.Email // factor -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index e220852350..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createMfaRecoveryCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-o-auth2session.md b/docs/examples/1.6.x/console-web/examples/account/create-o-auth2session.md deleted file mode 100644 index 593bb5c798..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-o-auth2session.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account, OAuthProvider } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -account.createOAuth2Session( - OAuthProvider.Amazon, // provider - 'https://example.com', // success (optional) - 'https://example.com', // failure (optional) - [] // scopes (optional) -); - diff --git a/docs/examples/1.6.x/console-web/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/console-web/examples/account/create-o-auth2token.md deleted file mode 100644 index 033c53eb4d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account, OAuthProvider } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -account.createOAuth2Token( - OAuthProvider.Amazon, // provider - 'https://example.com', // success (optional) - 'https://example.com', // failure (optional) - [] // scopes (optional) -); - diff --git a/docs/examples/1.6.x/console-web/examples/account/create-phone-token.md b/docs/examples/1.6.x/console-web/examples/account/create-phone-token.md deleted file mode 100644 index 2c28644b94..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-phone-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createPhoneToken( - '<USER_ID>', // userId - '+12065550100' // phone -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-phone-verification.md b/docs/examples/1.6.x/console-web/examples/account/create-phone-verification.md deleted file mode 100644 index d76b2b787a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-phone-verification.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createPhoneVerification(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-push-target.md b/docs/examples/1.6.x/console-web/examples/account/create-push-target.md deleted file mode 100644 index 0cae64799f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-push-target.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createPushTarget( - '<TARGET_ID>', // targetId - '<IDENTIFIER>', // identifier - '<PROVIDER_ID>' // providerId (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-recovery.md b/docs/examples/1.6.x/console-web/examples/account/create-recovery.md deleted file mode 100644 index c411e8039f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createRecovery( - 'email@example.com', // email - 'https://example.com' // url -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-session.md b/docs/examples/1.6.x/console-web/examples/account/create-session.md deleted file mode 100644 index 29b1e19935..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create-verification.md b/docs/examples/1.6.x/console-web/examples/account/create-verification.md deleted file mode 100644 index 3071bd1474..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.createVerification( - 'https://example.com' // url -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/create.md b/docs/examples/1.6.x/console-web/examples/account/create.md deleted file mode 100644 index f359211fc7..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/create.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.create( - '<USER_ID>', // userId - 'email@example.com', // email - '', // password - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete-identity.md b/docs/examples/1.6.x/console-web/examples/account/delete-identity.md deleted file mode 100644 index 223144cbbf..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/delete-identity.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteIdentity( - '<IDENTITY_ID>' // identityId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/console-web/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 48949664fc..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account, AuthenticatorType } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteMfaAuthenticator( - AuthenticatorType.Totp // type -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete-push-target.md b/docs/examples/1.6.x/console-web/examples/account/delete-push-target.md deleted file mode 100644 index aa44cafb77..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/delete-push-target.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deletePushTarget( - '<TARGET_ID>' // targetId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete-session.md b/docs/examples/1.6.x/console-web/examples/account/delete-session.md deleted file mode 100644 index 16cd2e7bf0..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/delete-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteSession( - '<SESSION_ID>' // sessionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete-sessions.md b/docs/examples/1.6.x/console-web/examples/account/delete-sessions.md deleted file mode 100644 index 9f64d87de9..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/delete-sessions.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.deleteSessions(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/delete.md b/docs/examples/1.6.x/console-web/examples/account/delete.md deleted file mode 100644 index f76e8e514e..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/delete.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.delete(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index 455aaf4739..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.getMfaRecoveryCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/get-prefs.md b/docs/examples/1.6.x/console-web/examples/account/get-prefs.md deleted file mode 100644 index 54f3d3b3ad..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/get-prefs.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.getPrefs(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/get-session.md b/docs/examples/1.6.x/console-web/examples/account/get-session.md deleted file mode 100644 index 661b798da7..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/get-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.getSession( - '<SESSION_ID>' // sessionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/get.md b/docs/examples/1.6.x/console-web/examples/account/get.md deleted file mode 100644 index c5d69c2f0c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.get(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/list-identities.md b/docs/examples/1.6.x/console-web/examples/account/list-identities.md deleted file mode 100644 index c94685e0a2..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/list-identities.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listIdentities( - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/list-logs.md b/docs/examples/1.6.x/console-web/examples/account/list-logs.md deleted file mode 100644 index 1a4bfe7d53..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/list-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listLogs( - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/console-web/examples/account/list-mfa-factors.md deleted file mode 100644 index 871d2ab4a3..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listMfaFactors(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/list-sessions.md b/docs/examples/1.6.x/console-web/examples/account/list-sessions.md deleted file mode 100644 index 7ec5539bc1..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/list-sessions.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.listSessions(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-email.md b/docs/examples/1.6.x/console-web/examples/account/update-email.md deleted file mode 100644 index c47022cb9a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-email.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateEmail( - 'email@example.com', // email - 'password' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-m-f-a.md b/docs/examples/1.6.x/console-web/examples/account/update-m-f-a.md deleted file mode 100644 index 001e6f7da9..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-m-f-a.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMFA( - false // mfa -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/console-web/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 7f4b824aaf..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMagicURLSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/console-web/examples/account/update-mfa-authenticator.md deleted file mode 100644 index 4b584fa0e5..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account, AuthenticatorType } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMfaAuthenticator( - AuthenticatorType.Totp, // type - '<OTP>' // otp -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/console-web/examples/account/update-mfa-challenge.md deleted file mode 100644 index 217f167590..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMfaChallenge( - '<CHALLENGE_ID>', // challengeId - '<OTP>' // otp -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index 597ddc35dd..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateMfaRecoveryCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-name.md b/docs/examples/1.6.x/console-web/examples/account/update-name.md deleted file mode 100644 index 59917e64db..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateName( - '<NAME>' // name -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-password.md b/docs/examples/1.6.x/console-web/examples/account/update-password.md deleted file mode 100644 index a2332e734b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-password.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePassword( - '', // password - 'password' // oldPassword (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-phone-session.md b/docs/examples/1.6.x/console-web/examples/account/update-phone-session.md deleted file mode 100644 index 85bf50e664..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-phone-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePhoneSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-phone-verification.md b/docs/examples/1.6.x/console-web/examples/account/update-phone-verification.md deleted file mode 100644 index b72260fb6d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-phone-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePhoneVerification( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-phone.md b/docs/examples/1.6.x/console-web/examples/account/update-phone.md deleted file mode 100644 index 3e2421b651..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-phone.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePhone( - '+12065550100', // phone - 'password' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-prefs.md b/docs/examples/1.6.x/console-web/examples/account/update-prefs.md deleted file mode 100644 index 054aa7e526..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePrefs( - {} // prefs -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-push-target.md b/docs/examples/1.6.x/console-web/examples/account/update-push-target.md deleted file mode 100644 index 5178052504..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-push-target.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updatePushTarget( - '<TARGET_ID>', // targetId - '<IDENTIFIER>' // identifier -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-recovery.md b/docs/examples/1.6.x/console-web/examples/account/update-recovery.md deleted file mode 100644 index d2ed14ef0e..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-recovery.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateRecovery( - '<USER_ID>', // userId - '<SECRET>', // secret - '' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-session.md b/docs/examples/1.6.x/console-web/examples/account/update-session.md deleted file mode 100644 index 20ceeb7c6f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateSession( - '<SESSION_ID>' // sessionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-status.md b/docs/examples/1.6.x/console-web/examples/account/update-status.md deleted file mode 100644 index 3e1a532917..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-status.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateStatus(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/account/update-verification.md b/docs/examples/1.6.x/console-web/examples/account/update-verification.md deleted file mode 100644 index d3b0426ab1..0000000000 --- a/docs/examples/1.6.x/console-web/examples/account/update-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const result = await account.updateVerification( - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/assistant/chat.md b/docs/examples/1.6.x/console-web/examples/assistant/chat.md deleted file mode 100644 index 8c47108f84..0000000000 --- a/docs/examples/1.6.x/console-web/examples/assistant/chat.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Assistant } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const assistant = new Assistant(client); - -const result = await assistant.chat( - '<PROMPT>' // prompt -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-browser.md b/docs/examples/1.6.x/console-web/examples/avatars/get-browser.md deleted file mode 100644 index 89bc3ae788..0000000000 --- a/docs/examples/1.6.x/console-web/examples/avatars/get-browser.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars, Browser } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getBrowser( - Browser.AvantBrowser, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/console-web/examples/avatars/get-credit-card.md deleted file mode 100644 index 874bac827f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars, CreditCard } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getCreditCard( - CreditCard.AmericanExpress, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-favicon.md b/docs/examples/1.6.x/console-web/examples/avatars/get-favicon.md deleted file mode 100644 index 0cb328d7a7..0000000000 --- a/docs/examples/1.6.x/console-web/examples/avatars/get-favicon.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Avatars } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getFavicon( - 'https://example.com' // url -); - -console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-flag.md b/docs/examples/1.6.x/console-web/examples/avatars/get-flag.md deleted file mode 100644 index e17885ea92..0000000000 --- a/docs/examples/1.6.x/console-web/examples/avatars/get-flag.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars, Flag } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getFlag( - Flag.Afghanistan, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-image.md b/docs/examples/1.6.x/console-web/examples/avatars/get-image.md deleted file mode 100644 index d61b93ee09..0000000000 --- a/docs/examples/1.6.x/console-web/examples/avatars/get-image.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Avatars } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getImage( - 'https://example.com', // url - 0, // width (optional) - 0 // height (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-initials.md b/docs/examples/1.6.x/console-web/examples/avatars/get-initials.md deleted file mode 100644 index eda96c4d66..0000000000 --- a/docs/examples/1.6.x/console-web/examples/avatars/get-initials.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getInitials( - '<NAME>', // name (optional) - 0, // width (optional) - 0, // height (optional) - '' // background (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/avatars/get-q-r.md b/docs/examples/1.6.x/console-web/examples/avatars/get-q-r.md deleted file mode 100644 index 200d85210a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/avatars/get-q-r.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Avatars } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const avatars = new Avatars(client); - -const result = avatars.getQR( - '<TEXT>', // text - 1, // size (optional) - 0, // margin (optional) - false // download (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/console/variables.md b/docs/examples/1.6.x/console-web/examples/console/variables.md deleted file mode 100644 index 8d4e298084..0000000000 --- a/docs/examples/1.6.x/console-web/examples/console/variables.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Console } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const console = new Console(client); - -const result = await console.variables(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-boolean-attribute.md deleted file mode 100644 index b070039fac..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createBooleanAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - false, // default (optional) - false // array (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-collection.md b/docs/examples/1.6.x/console-web/examples/databases/create-collection.md deleted file mode 100644 index 8f5ab24d4d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-collection.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // documentSecurity (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-datetime-attribute.md deleted file mode 100644 index 9dc4d41276..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createDatetimeAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '', // default (optional) - false // array (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-document.md b/docs/examples/1.6.x/console-web/examples/databases/create-document.md deleted file mode 100644 index 11f3bfd58b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-document.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - {}, // data - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-email-attribute.md deleted file mode 100644 index bd93e73269..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createEmailAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'email@example.com', // default (optional) - false // array (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-enum-attribute.md deleted file mode 100644 index 82aeb68b0b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createEnumAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - [], // elements - false, // required - '<DEFAULT>', // default (optional) - false // array (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-float-attribute.md deleted file mode 100644 index 575583778d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createFloatAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min (optional) - null, // max (optional) - null, // default (optional) - false // array (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-index.md b/docs/examples/1.6.x/console-web/examples/databases/create-index.md deleted file mode 100644 index f5c94d538f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-index.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases, IndexType } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createIndex( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - IndexType.Key, // type - [], // attributes - [] // orders (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-integer-attribute.md deleted file mode 100644 index 637e194b3b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createIntegerAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min (optional) - null, // max (optional) - null, // default (optional) - false // array (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-ip-attribute.md deleted file mode 100644 index 1617d8eb12..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createIpAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '', // default (optional) - false // array (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-relationship-attribute.md deleted file mode 100644 index 925fb65db7..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Databases, RelationshipType, RelationMutate } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createRelationshipAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<RELATED_COLLECTION_ID>', // relatedCollectionId - RelationshipType.OneToOne, // type - false, // twoWay (optional) - '', // key (optional) - '', // twoWayKey (optional) - RelationMutate.Cascade // onDelete (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-string-attribute.md deleted file mode 100644 index 614ac8f865..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createStringAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - 1, // size - false, // required - '<DEFAULT>', // default (optional) - false, // array (optional) - false // encrypt (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/create-url-attribute.md deleted file mode 100644 index db36663b70..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createUrlAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'https://example.com', // default (optional) - false // array (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/create.md b/docs/examples/1.6.x/console-web/examples/databases/create.md deleted file mode 100644 index 08734185eb..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/create.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.create( - '<DATABASE_ID>', // databaseId - '<NAME>', // name - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/delete-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/delete-attribute.md deleted file mode 100644 index 76b157e1fb..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/delete-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.deleteAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/delete-collection.md b/docs/examples/1.6.x/console-web/examples/databases/delete-collection.md deleted file mode 100644 index b92d6a1a96..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/delete-collection.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.deleteCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>' // collectionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/delete-document.md b/docs/examples/1.6.x/console-web/examples/databases/delete-document.md deleted file mode 100644 index 7a7789cfb4..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/delete-document.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.deleteDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>' // documentId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/delete-index.md b/docs/examples/1.6.x/console-web/examples/databases/delete-index.md deleted file mode 100644 index de9d1b38ca..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/delete-index.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.deleteIndex( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/delete.md b/docs/examples/1.6.x/console-web/examples/databases/delete.md deleted file mode 100644 index 237cbd9a0e..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.delete( - '<DATABASE_ID>' // databaseId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/get-attribute.md deleted file mode 100644 index 73c91d680a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/get-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.getAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-collection-usage.md b/docs/examples/1.6.x/console-web/examples/databases/get-collection-usage.md deleted file mode 100644 index ce409da890..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/get-collection-usage.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases, DatabaseUsageRange } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.getCollectionUsage( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - DatabaseUsageRange.TwentyFourHours // range (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-collection.md b/docs/examples/1.6.x/console-web/examples/databases/get-collection.md deleted file mode 100644 index e89863b6af..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/get-collection.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.getCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>' // collectionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-database-usage.md b/docs/examples/1.6.x/console-web/examples/databases/get-database-usage.md deleted file mode 100644 index 14a4bd4af2..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/get-database-usage.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases, DatabaseUsageRange } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.getDatabaseUsage( - '<DATABASE_ID>', // databaseId - DatabaseUsageRange.TwentyFourHours // range (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-document.md b/docs/examples/1.6.x/console-web/examples/databases/get-document.md deleted file mode 100644 index 83f832ad58..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/get-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.getDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-index.md b/docs/examples/1.6.x/console-web/examples/databases/get-index.md deleted file mode 100644 index 5fe73a5d88..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/get-index.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.getIndex( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get-usage.md b/docs/examples/1.6.x/console-web/examples/databases/get-usage.md deleted file mode 100644 index 40382b3c66..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/get-usage.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Databases, DatabaseUsageRange } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.getUsage( - DatabaseUsageRange.TwentyFourHours // range (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/get.md b/docs/examples/1.6.x/console-web/examples/databases/get.md deleted file mode 100644 index cd04ed9afb..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.get( - '<DATABASE_ID>' // databaseId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-attributes.md b/docs/examples/1.6.x/console-web/examples/databases/list-attributes.md deleted file mode 100644 index eecb6a2268..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/list-attributes.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.listAttributes( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-collection-logs.md b/docs/examples/1.6.x/console-web/examples/databases/list-collection-logs.md deleted file mode 100644 index 850c4437b6..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/list-collection-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.listCollectionLogs( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-collections.md b/docs/examples/1.6.x/console-web/examples/databases/list-collections.md deleted file mode 100644 index 891c7c76c7..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/list-collections.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.listCollections( - '<DATABASE_ID>', // databaseId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-document-logs.md b/docs/examples/1.6.x/console-web/examples/databases/list-document-logs.md deleted file mode 100644 index 0fa86b4305..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/list-document-logs.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.listDocumentLogs( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-documents.md b/docs/examples/1.6.x/console-web/examples/databases/list-documents.md deleted file mode 100644 index 1918bad395..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/list-documents.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.listDocuments( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-indexes.md b/docs/examples/1.6.x/console-web/examples/databases/list-indexes.md deleted file mode 100644 index 6e308a8ae5..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/list-indexes.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.listIndexes( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list-logs.md b/docs/examples/1.6.x/console-web/examples/databases/list-logs.md deleted file mode 100644 index a28ba46955..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/list-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.listLogs( - '<DATABASE_ID>', // databaseId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/list.md b/docs/examples/1.6.x/console-web/examples/databases/list.md deleted file mode 100644 index 75a5c467c7..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-boolean-attribute.md deleted file mode 100644 index 2abf121732..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateBooleanAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - false // default -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-collection.md b/docs/examples/1.6.x/console-web/examples/databases/update-collection.md deleted file mode 100644 index 3bce3a5720..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-collection.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // documentSecurity (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-datetime-attribute.md deleted file mode 100644 index 3152f6b39b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateDatetimeAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '' // default -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-document.md b/docs/examples/1.6.x/console-web/examples/databases/update-document.md deleted file mode 100644 index bfc7df6c69..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-document.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - {}, // data (optional) - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-email-attribute.md deleted file mode 100644 index eaa6338860..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateEmailAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'email@example.com' // default -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-enum-attribute.md deleted file mode 100644 index b579869058..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateEnumAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - [], // elements - false, // required - '<DEFAULT>' // default -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-float-attribute.md deleted file mode 100644 index 16cca26fbb..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateFloatAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min - null, // max - null // default -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-integer-attribute.md deleted file mode 100644 index 97bf6a9eba..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateIntegerAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min - null, // max - null // default -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-ip-attribute.md deleted file mode 100644 index 0f3c5111bb..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateIpAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '' // default -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-relationship-attribute.md deleted file mode 100644 index 205aeba36c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases, RelationMutate } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateRelationshipAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - RelationMutate.Cascade // onDelete (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-string-attribute.md deleted file mode 100644 index 763b6d5e3b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateStringAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '<DEFAULT>' // default -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/console-web/examples/databases/update-url-attribute.md deleted file mode 100644 index ca89f962e8..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateUrlAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'https://example.com' // default -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/databases/update.md b/docs/examples/1.6.x/console-web/examples/databases/update.md deleted file mode 100644 index fa87d14542..0000000000 --- a/docs/examples/1.6.x/console-web/examples/databases/update.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const databases = new Databases(client); - -const result = await databases.update( - '<DATABASE_ID>', // databaseId - '<NAME>', // name - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/create-build.md b/docs/examples/1.6.x/console-web/examples/functions/create-build.md deleted file mode 100644 index ab0c455a3f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/create-build.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.createBuild( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>', // deploymentId - '<BUILD_ID>' // buildId (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/create-deployment.md b/docs/examples/1.6.x/console-web/examples/functions/create-deployment.md deleted file mode 100644 index 2617615827..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/create-deployment.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.createDeployment( - '<FUNCTION_ID>', // functionId - document.getElementById('uploader').files[0], // code - false, // activate - '<ENTRYPOINT>', // entrypoint (optional) - '<COMMANDS>' // commands (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/create-execution.md b/docs/examples/1.6.x/console-web/examples/functions/create-execution.md deleted file mode 100644 index 8d62c5083e..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/create-execution.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Functions, ExecutionMethod } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.createExecution( - '<FUNCTION_ID>', // functionId - '<BODY>', // body (optional) - false, // async (optional) - '<PATH>', // path (optional) - ExecutionMethod.GET, // method (optional) - {}, // headers (optional) - '' // scheduledAt (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/create-variable.md b/docs/examples/1.6.x/console-web/examples/functions/create-variable.md deleted file mode 100644 index 16a047462c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/create-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.createVariable( - '<FUNCTION_ID>', // functionId - '<KEY>', // key - '<VALUE>' // value -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/create.md b/docs/examples/1.6.x/console-web/examples/functions/create.md deleted file mode 100644 index 36815d5646..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/create.md +++ /dev/null @@ -1,33 +0,0 @@ -import { Client, Functions, } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.create( - '<FUNCTION_ID>', // functionId - '<NAME>', // name - .Node145, // runtime - ["any"], // execute (optional) - [], // events (optional) - '', // schedule (optional) - 1, // timeout (optional) - false, // enabled (optional) - false, // logging (optional) - '<ENTRYPOINT>', // entrypoint (optional) - '<COMMANDS>', // commands (optional) - [], // scopes (optional) - '<INSTALLATION_ID>', // installationId (optional) - '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) - '<PROVIDER_BRANCH>', // providerBranch (optional) - false, // providerSilentMode (optional) - '<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional) - '<TEMPLATE_REPOSITORY>', // templateRepository (optional) - '<TEMPLATE_OWNER>', // templateOwner (optional) - '<TEMPLATE_ROOT_DIRECTORY>', // templateRootDirectory (optional) - '<TEMPLATE_BRANCH>' // templateBranch (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/delete-deployment.md b/docs/examples/1.6.x/console-web/examples/functions/delete-deployment.md deleted file mode 100644 index 8dd7a186e2..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/delete-deployment.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.deleteDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/delete-execution.md b/docs/examples/1.6.x/console-web/examples/functions/delete-execution.md deleted file mode 100644 index 6ffd50ce0c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/delete-execution.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.deleteExecution( - '<FUNCTION_ID>', // functionId - '<EXECUTION_ID>' // executionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/delete-variable.md b/docs/examples/1.6.x/console-web/examples/functions/delete-variable.md deleted file mode 100644 index 71f1d322ab..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/delete-variable.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.deleteVariable( - '<FUNCTION_ID>', // functionId - '<VARIABLE_ID>' // variableId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/delete.md b/docs/examples/1.6.x/console-web/examples/functions/delete.md deleted file mode 100644 index 9a27e2df98..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.delete( - '<FUNCTION_ID>' // functionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/download-deployment.md b/docs/examples/1.6.x/console-web/examples/functions/download-deployment.md deleted file mode 100644 index cfcd00bade..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/download-deployment.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = functions.downloadDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); - -console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get-deployment.md b/docs/examples/1.6.x/console-web/examples/functions/get-deployment.md deleted file mode 100644 index 468eb70304..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/get-deployment.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.getDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get-execution.md b/docs/examples/1.6.x/console-web/examples/functions/get-execution.md deleted file mode 100644 index a476780a55..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/get-execution.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.getExecution( - '<FUNCTION_ID>', // functionId - '<EXECUTION_ID>' // executionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get-function-usage.md b/docs/examples/1.6.x/console-web/examples/functions/get-function-usage.md deleted file mode 100644 index 4a151c15b7..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/get-function-usage.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions, FunctionUsageRange } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.getFunctionUsage( - '<FUNCTION_ID>', // functionId - FunctionUsageRange.TwentyFourHours // range (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get-usage.md b/docs/examples/1.6.x/console-web/examples/functions/get-usage.md deleted file mode 100644 index a98d074256..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/get-usage.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions, FunctionUsageRange } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.getUsage( - FunctionUsageRange.TwentyFourHours // range (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get-variable.md b/docs/examples/1.6.x/console-web/examples/functions/get-variable.md deleted file mode 100644 index e6a5a88a59..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/get-variable.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.getVariable( - '<FUNCTION_ID>', // functionId - '<VARIABLE_ID>' // variableId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/get.md b/docs/examples/1.6.x/console-web/examples/functions/get.md deleted file mode 100644 index 12cd21f41b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.get( - '<FUNCTION_ID>' // functionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/list-deployments.md b/docs/examples/1.6.x/console-web/examples/functions/list-deployments.md deleted file mode 100644 index 6fb7d98ff1..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/list-deployments.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.listDeployments( - '<FUNCTION_ID>', // functionId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/list-executions.md b/docs/examples/1.6.x/console-web/examples/functions/list-executions.md deleted file mode 100644 index e2858fdd47..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/list-executions.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.listExecutions( - '<FUNCTION_ID>', // functionId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/list-runtimes.md b/docs/examples/1.6.x/console-web/examples/functions/list-runtimes.md deleted file mode 100644 index 7fa0e83b6a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/list-runtimes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.listRuntimes(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/list-variables.md b/docs/examples/1.6.x/console-web/examples/functions/list-variables.md deleted file mode 100644 index 7163e26841..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/list-variables.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.listVariables( - '<FUNCTION_ID>' // functionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/list.md b/docs/examples/1.6.x/console-web/examples/functions/list.md deleted file mode 100644 index aeeb7c6dc5..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/console-web/examples/functions/update-deployment-build.md deleted file mode 100644 index e69a9e7f59..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.updateDeploymentBuild( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/update-deployment.md b/docs/examples/1.6.x/console-web/examples/functions/update-deployment.md deleted file mode 100644 index c17f7a7067..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/update-deployment.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.updateDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/update-variable.md b/docs/examples/1.6.x/console-web/examples/functions/update-variable.md deleted file mode 100644 index cc5943237b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/update-variable.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Functions } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.updateVariable( - '<FUNCTION_ID>', // functionId - '<VARIABLE_ID>', // variableId - '<KEY>', // key - '<VALUE>' // value (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/functions/update.md b/docs/examples/1.6.x/console-web/examples/functions/update.md deleted file mode 100644 index 39f37d03b8..0000000000 --- a/docs/examples/1.6.x/console-web/examples/functions/update.md +++ /dev/null @@ -1,29 +0,0 @@ -import { Client, Functions, } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const functions = new Functions(client); - -const result = await functions.update( - '<FUNCTION_ID>', // functionId - '<NAME>', // name - .Node145, // runtime (optional) - ["any"], // execute (optional) - [], // events (optional) - '', // schedule (optional) - 1, // timeout (optional) - false, // enabled (optional) - false, // logging (optional) - '<ENTRYPOINT>', // entrypoint (optional) - '<COMMANDS>', // commands (optional) - [], // scopes (optional) - '<INSTALLATION_ID>', // installationId (optional) - '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) - '<PROVIDER_BRANCH>', // providerBranch (optional) - false, // providerSilentMode (optional) - '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/graphql/mutation.md b/docs/examples/1.6.x/console-web/examples/graphql/mutation.md deleted file mode 100644 index 5a6cb2ced4..0000000000 --- a/docs/examples/1.6.x/console-web/examples/graphql/mutation.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Graphql } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const graphql = new Graphql(client); - -const result = await graphql.mutation( - {} // query -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/graphql/query.md b/docs/examples/1.6.x/console-web/examples/graphql/query.md deleted file mode 100644 index c92c636395..0000000000 --- a/docs/examples/1.6.x/console-web/examples/graphql/query.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Graphql } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const graphql = new Graphql(client); - -const result = await graphql.query( - {} // query -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-antivirus.md b/docs/examples/1.6.x/console-web/examples/health/get-antivirus.md deleted file mode 100644 index 6daffff793..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-antivirus.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getAntivirus(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-cache.md b/docs/examples/1.6.x/console-web/examples/health/get-cache.md deleted file mode 100644 index acbf728519..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-cache.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getCache(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-certificate.md b/docs/examples/1.6.x/console-web/examples/health/get-certificate.md deleted file mode 100644 index 264e18ed66..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-certificate.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getCertificate( - '' // domain (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-d-b.md b/docs/examples/1.6.x/console-web/examples/health/get-d-b.md deleted file mode 100644 index 12d22d0dfb..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-d-b.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getDB(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/console-web/examples/health/get-failed-jobs.md deleted file mode 100644 index 4dac04a856..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Health, } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getFailedJobs( - .V1Database, // name - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-pub-sub.md b/docs/examples/1.6.x/console-web/examples/health/get-pub-sub.md deleted file mode 100644 index b2e654d927..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-pub-sub.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getPubSub(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-builds.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-builds.md deleted file mode 100644 index 5c41eb7a90..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-builds.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueBuilds( - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-certificates.md deleted file mode 100644 index 744d0c7140..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueCertificates( - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-databases.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-databases.md deleted file mode 100644 index d7d5457d56..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-databases.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueDatabases( - '<NAME>', // name (optional) - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-deletes.md deleted file mode 100644 index bcb1c95a53..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueDeletes( - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-functions.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-functions.md deleted file mode 100644 index 92ca143588..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-functions.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueFunctions( - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-logs.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-logs.md deleted file mode 100644 index e2bfb3663d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueLogs( - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-mails.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-mails.md deleted file mode 100644 index 78be0c7cd2..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-mails.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueMails( - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-messaging.md deleted file mode 100644 index 6a5de6a0dc..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueMessaging( - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-migrations.md deleted file mode 100644 index dc18fdfa89..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueMigrations( - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-usage-dump.md deleted file mode 100644 index 10eed8e263..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueUsageDump( - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-usage.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-usage.md deleted file mode 100644 index 155a1b2336..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-usage.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueUsage( - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/console-web/examples/health/get-queue-webhooks.md deleted file mode 100644 index b238febe45..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueueWebhooks( - null // threshold (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-queue.md b/docs/examples/1.6.x/console-web/examples/health/get-queue.md deleted file mode 100644 index f035b83551..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-queue.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getQueue(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-storage-local.md b/docs/examples/1.6.x/console-web/examples/health/get-storage-local.md deleted file mode 100644 index b61b9fb9cf..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-storage-local.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getStorageLocal(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-storage.md b/docs/examples/1.6.x/console-web/examples/health/get-storage.md deleted file mode 100644 index 354cb4b505..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-storage.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getStorage(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get-time.md b/docs/examples/1.6.x/console-web/examples/health/get-time.md deleted file mode 100644 index f4438e8c81..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get-time.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.getTime(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/health/get.md b/docs/examples/1.6.x/console-web/examples/health/get.md deleted file mode 100644 index 5ff80769a6..0000000000 --- a/docs/examples/1.6.x/console-web/examples/health/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Health } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const health = new Health(client); - -const result = await health.get(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/get.md b/docs/examples/1.6.x/console-web/examples/locale/get.md deleted file mode 100644 index a93eecec94..0000000000 --- a/docs/examples/1.6.x/console-web/examples/locale/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.get(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-codes.md b/docs/examples/1.6.x/console-web/examples/locale/list-codes.md deleted file mode 100644 index d2639f6cfb..0000000000 --- a/docs/examples/1.6.x/console-web/examples/locale/list-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCodes(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-continents.md b/docs/examples/1.6.x/console-web/examples/locale/list-continents.md deleted file mode 100644 index ec9327f2f6..0000000000 --- a/docs/examples/1.6.x/console-web/examples/locale/list-continents.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listContinents(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/console-web/examples/locale/list-countries-e-u.md deleted file mode 100644 index 52e14d37af..0000000000 --- a/docs/examples/1.6.x/console-web/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCountriesEU(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/console-web/examples/locale/list-countries-phones.md deleted file mode 100644 index 7cd739d4a6..0000000000 --- a/docs/examples/1.6.x/console-web/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCountriesPhones(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-countries.md b/docs/examples/1.6.x/console-web/examples/locale/list-countries.md deleted file mode 100644 index 73e609391b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/locale/list-countries.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCountries(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-currencies.md b/docs/examples/1.6.x/console-web/examples/locale/list-currencies.md deleted file mode 100644 index 554513ce46..0000000000 --- a/docs/examples/1.6.x/console-web/examples/locale/list-currencies.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listCurrencies(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/locale/list-languages.md b/docs/examples/1.6.x/console-web/examples/locale/list-languages.md deleted file mode 100644 index f3f03cf14c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/locale/list-languages.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Locale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const locale = new Locale(client); - -const result = await locale.listLanguages(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-apns-provider.md deleted file mode 100644 index 60691b2075..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createApnsProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<AUTH_KEY>', // authKey (optional) - '<AUTH_KEY_ID>', // authKeyId (optional) - '<TEAM_ID>', // teamId (optional) - '<BUNDLE_ID>', // bundleId (optional) - false, // sandbox (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-email.md b/docs/examples/1.6.x/console-web/examples/messaging/create-email.md deleted file mode 100644 index 057339b57b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-email.md +++ /dev/null @@ -1,24 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createEmail( - '<MESSAGE_ID>', // messageId - '<SUBJECT>', // subject - '<CONTENT>', // content - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - [], // cc (optional) - [], // bcc (optional) - [], // attachments (optional) - false, // draft (optional) - false, // html (optional) - '' // scheduledAt (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-fcm-provider.md deleted file mode 100644 index 967e99c3dd..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createFcmProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - {}, // serviceAccountJSON (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index f1cf6e28ab..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createMailgunProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<API_KEY>', // apiKey (optional) - '<DOMAIN>', // domain (optional) - false, // isEuRegion (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - 'email@example.com', // replyToEmail (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-msg91provider.md deleted file mode 100644 index 2b9b4b43f4..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createMsg91Provider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<TEMPLATE_ID>', // templateId (optional) - '<SENDER_ID>', // senderId (optional) - '<AUTH_KEY>', // authKey (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-push.md b/docs/examples/1.6.x/console-web/examples/messaging/create-push.md deleted file mode 100644 index aa4a83cda5..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-push.md +++ /dev/null @@ -1,28 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createPush( - '<MESSAGE_ID>', // messageId - '<TITLE>', // title - '<BODY>', // body - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - {}, // data (optional) - '<ACTION>', // action (optional) - '[ID1:ID2]', // image (optional) - '<ICON>', // icon (optional) - '<SOUND>', // sound (optional) - '<COLOR>', // color (optional) - '<TAG>', // tag (optional) - '<BADGE>', // badge (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index 465ff14ec6..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createSendgridProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<API_KEY>', // apiKey (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - 'email@example.com', // replyToEmail (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-sms.md b/docs/examples/1.6.x/console-web/examples/messaging/create-sms.md deleted file mode 100644 index fe474c87b8..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-sms.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createSms( - '<MESSAGE_ID>', // messageId - '<CONTENT>', // content - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-smtp-provider.md deleted file mode 100644 index 0c3c74a168..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,26 +0,0 @@ -import { Client, Messaging, SmtpEncryption } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createSmtpProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<HOST>', // host - 1, // port (optional) - '<USERNAME>', // username (optional) - '<PASSWORD>', // password (optional) - SmtpEncryption.None, // encryption (optional) - false, // autoTLS (optional) - '<MAILER>', // mailer (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - 'email@example.com', // replyToEmail (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/console-web/examples/messaging/create-subscriber.md deleted file mode 100644 index 9d14c970f2..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>', // subscriberId - '<TARGET_ID>' // targetId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-telesign-provider.md deleted file mode 100644 index b48b846b7c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createTelesignProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<CUSTOMER_ID>', // customerId (optional) - '<API_KEY>', // apiKey (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index 53b458dc23..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createTextmagicProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<USERNAME>', // username (optional) - '<API_KEY>', // apiKey (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-topic.md b/docs/examples/1.6.x/console-web/examples/messaging/create-topic.md deleted file mode 100644 index c103e0d72a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-topic.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createTopic( - '<TOPIC_ID>', // topicId - '<NAME>', // name - ["any"] // subscribe (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-twilio-provider.md deleted file mode 100644 index 73f2b69f93..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createTwilioProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<ACCOUNT_SID>', // accountSid (optional) - '<AUTH_TOKEN>', // authToken (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/create-vonage-provider.md deleted file mode 100644 index 166a5a9b97..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.createVonageProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<API_KEY>', // apiKey (optional) - '<API_SECRET>', // apiSecret (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/delete-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/delete-provider.md deleted file mode 100644 index aff19d2ae8..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/delete-provider.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.deleteProvider( - '<PROVIDER_ID>' // providerId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/console-web/examples/messaging/delete-subscriber.md deleted file mode 100644 index be167bbebf..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.deleteSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>' // subscriberId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/delete-topic.md b/docs/examples/1.6.x/console-web/examples/messaging/delete-topic.md deleted file mode 100644 index 6d55cbf797..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/delete-topic.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.deleteTopic( - '<TOPIC_ID>' // topicId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/delete.md b/docs/examples/1.6.x/console-web/examples/messaging/delete.md deleted file mode 100644 index cae970109d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.delete( - '<MESSAGE_ID>' // messageId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/get-message.md b/docs/examples/1.6.x/console-web/examples/messaging/get-message.md deleted file mode 100644 index 4857198434..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/get-message.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.getMessage( - '<MESSAGE_ID>' // messageId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/get-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/get-provider.md deleted file mode 100644 index 0526d2bc84..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/get-provider.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.getProvider( - '<PROVIDER_ID>' // providerId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/console-web/examples/messaging/get-subscriber.md deleted file mode 100644 index e43eba9754..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.getSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>' // subscriberId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/get-topic.md b/docs/examples/1.6.x/console-web/examples/messaging/get-topic.md deleted file mode 100644 index f8afb4ced5..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/get-topic.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.getTopic( - '<TOPIC_ID>' // topicId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/console-web/examples/messaging/list-message-logs.md deleted file mode 100644 index b8e5c506cd..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.listMessageLogs( - '<MESSAGE_ID>', // messageId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-messages.md b/docs/examples/1.6.x/console-web/examples/messaging/list-messages.md deleted file mode 100644 index 6311c77419..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/list-messages.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.listMessages( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/console-web/examples/messaging/list-provider-logs.md deleted file mode 100644 index 91458fa27a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.listProviderLogs( - '<PROVIDER_ID>', // providerId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-providers.md b/docs/examples/1.6.x/console-web/examples/messaging/list-providers.md deleted file mode 100644 index 026218d27a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/list-providers.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.listProviders( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/console-web/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index f22a2d7d92..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.listSubscriberLogs( - '<SUBSCRIBER_ID>', // subscriberId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/console-web/examples/messaging/list-subscribers.md deleted file mode 100644 index 1ca77b3ead..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.listSubscribers( - '<TOPIC_ID>', // topicId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-targets.md b/docs/examples/1.6.x/console-web/examples/messaging/list-targets.md deleted file mode 100644 index a213207d24..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/list-targets.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.listTargets( - '<MESSAGE_ID>', // messageId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/console-web/examples/messaging/list-topic-logs.md deleted file mode 100644 index 44f8922e21..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.listTopicLogs( - '<TOPIC_ID>', // topicId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/list-topics.md b/docs/examples/1.6.x/console-web/examples/messaging/list-topics.md deleted file mode 100644 index d2941d6072..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/list-topics.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.listTopics( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-apns-provider.md deleted file mode 100644 index 837b51f1f6..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateApnsProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<AUTH_KEY>', // authKey (optional) - '<AUTH_KEY_ID>', // authKeyId (optional) - '<TEAM_ID>', // teamId (optional) - '<BUNDLE_ID>', // bundleId (optional) - false // sandbox (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-email.md b/docs/examples/1.6.x/console-web/examples/messaging/update-email.md deleted file mode 100644 index 2c2dec4777..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-email.md +++ /dev/null @@ -1,24 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateEmail( - '<MESSAGE_ID>', // messageId - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - '<SUBJECT>', // subject (optional) - '<CONTENT>', // content (optional) - false, // draft (optional) - false, // html (optional) - [], // cc (optional) - [], // bcc (optional) - '', // scheduledAt (optional) - [] // attachments (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-fcm-provider.md deleted file mode 100644 index 6b56f5964d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateFcmProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - {} // serviceAccountJSON (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index 2bf2ca60e4..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateMailgunProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - '<API_KEY>', // apiKey (optional) - '<DOMAIN>', // domain (optional) - false, // isEuRegion (optional) - false, // enabled (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - '<REPLY_TO_EMAIL>' // replyToEmail (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-msg91provider.md deleted file mode 100644 index f5ded13d4d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateMsg91Provider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<TEMPLATE_ID>', // templateId (optional) - '<SENDER_ID>', // senderId (optional) - '<AUTH_KEY>' // authKey (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-push.md b/docs/examples/1.6.x/console-web/examples/messaging/update-push.md deleted file mode 100644 index ac26d8b411..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-push.md +++ /dev/null @@ -1,28 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updatePush( - '<MESSAGE_ID>', // messageId - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - '<TITLE>', // title (optional) - '<BODY>', // body (optional) - {}, // data (optional) - '<ACTION>', // action (optional) - '[ID1:ID2]', // image (optional) - '<ICON>', // icon (optional) - '<SOUND>', // sound (optional) - '<COLOR>', // color (optional) - '<TAG>', // tag (optional) - null, // badge (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index 3d3897196b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateSendgridProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<API_KEY>', // apiKey (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - '<REPLY_TO_EMAIL>' // replyToEmail (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-sms.md b/docs/examples/1.6.x/console-web/examples/messaging/update-sms.md deleted file mode 100644 index b14182c735..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-sms.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateSms( - '<MESSAGE_ID>', // messageId - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - '<CONTENT>', // content (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-smtp-provider.md deleted file mode 100644 index e848e8d15d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,26 +0,0 @@ -import { Client, Messaging, SmtpEncryption } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateSmtpProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - '<HOST>', // host (optional) - 1, // port (optional) - '<USERNAME>', // username (optional) - '<PASSWORD>', // password (optional) - SmtpEncryption.None, // encryption (optional) - false, // autoTLS (optional) - '<MAILER>', // mailer (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - '<REPLY_TO_EMAIL>', // replyToEmail (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-telesign-provider.md deleted file mode 100644 index e4e63ccdb7..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateTelesignProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<CUSTOMER_ID>', // customerId (optional) - '<API_KEY>', // apiKey (optional) - '<FROM>' // from (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index b15bc192ee..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateTextmagicProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<USERNAME>', // username (optional) - '<API_KEY>', // apiKey (optional) - '<FROM>' // from (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-topic.md b/docs/examples/1.6.x/console-web/examples/messaging/update-topic.md deleted file mode 100644 index 646484e967..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-topic.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateTopic( - '<TOPIC_ID>', // topicId - '<NAME>', // name (optional) - ["any"] // subscribe (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-twilio-provider.md deleted file mode 100644 index 9cf45ea371..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateTwilioProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<ACCOUNT_SID>', // accountSid (optional) - '<AUTH_TOKEN>', // authToken (optional) - '<FROM>' // from (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/console-web/examples/messaging/update-vonage-provider.md deleted file mode 100644 index d56549536a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateVonageProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<API_KEY>', // apiKey (optional) - '<API_SECRET>', // apiSecret (optional) - '<FROM>' // from (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/create-appwrite-migration.md b/docs/examples/1.6.x/console-web/examples/migrations/create-appwrite-migration.md deleted file mode 100644 index f35317ccb2..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/create-appwrite-migration.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.createAppwriteMigration( - [], // resources - 'https://example.com', // endpoint - '<PROJECT_ID>', // projectId - '<API_KEY>' // apiKey -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-migration.md b/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-migration.md deleted file mode 100644 index af85183a17..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-migration.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.createFirebaseMigration( - [], // resources - '<SERVICE_ACCOUNT>' // serviceAccount -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-o-auth-migration.md b/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-o-auth-migration.md deleted file mode 100644 index 46f66df70a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/create-firebase-o-auth-migration.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.createFirebaseOAuthMigration( - [], // resources - '<PROJECT_ID>' // projectId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/create-n-host-migration.md b/docs/examples/1.6.x/console-web/examples/migrations/create-n-host-migration.md deleted file mode 100644 index 23dd906460..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/create-n-host-migration.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.createNHostMigration( - [], // resources - '<SUBDOMAIN>', // subdomain - '<REGION>', // region - '<ADMIN_SECRET>', // adminSecret - '<DATABASE>', // database - '<USERNAME>', // username - '<PASSWORD>', // password - null // port (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/create-supabase-migration.md b/docs/examples/1.6.x/console-web/examples/migrations/create-supabase-migration.md deleted file mode 100644 index 180a88488d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/create-supabase-migration.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.createSupabaseMigration( - [], // resources - 'https://example.com', // endpoint - '<API_KEY>', // apiKey - '<DATABASE_HOST>', // databaseHost - '<USERNAME>', // username - '<PASSWORD>', // password - null // port (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/delete-firebase-auth.md b/docs/examples/1.6.x/console-web/examples/migrations/delete-firebase-auth.md deleted file mode 100644 index a3766f1c4c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/delete-firebase-auth.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.deleteFirebaseAuth(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/delete.md b/docs/examples/1.6.x/console-web/examples/migrations/delete.md deleted file mode 100644 index 1ba4d383c0..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.delete( - '<MIGRATION_ID>' // migrationId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get-appwrite-report.md b/docs/examples/1.6.x/console-web/examples/migrations/get-appwrite-report.md deleted file mode 100644 index 4e3a0bb2af..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/get-appwrite-report.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.getAppwriteReport( - [], // resources - 'https://example.com', // endpoint - '<PROJECT_ID>', // projectID - '<KEY>' // key -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report-o-auth.md b/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report-o-auth.md deleted file mode 100644 index 302f5bf039..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report-o-auth.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.getFirebaseReportOAuth( - [], // resources - '<PROJECT_ID>' // projectId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report.md b/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report.md deleted file mode 100644 index 3f19494d96..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/get-firebase-report.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.getFirebaseReport( - [], // resources - '<SERVICE_ACCOUNT>' // serviceAccount -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get-n-host-report.md b/docs/examples/1.6.x/console-web/examples/migrations/get-n-host-report.md deleted file mode 100644 index 73e312a986..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/get-n-host-report.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.getNHostReport( - [], // resources - '<SUBDOMAIN>', // subdomain - '<REGION>', // region - '<ADMIN_SECRET>', // adminSecret - '<DATABASE>', // database - '<USERNAME>', // username - '<PASSWORD>', // password - null // port (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get-supabase-report.md b/docs/examples/1.6.x/console-web/examples/migrations/get-supabase-report.md deleted file mode 100644 index 1538bdb9d4..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/get-supabase-report.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.getSupabaseReport( - [], // resources - 'https://example.com', // endpoint - '<API_KEY>', // apiKey - '<DATABASE_HOST>', // databaseHost - '<USERNAME>', // username - '<PASSWORD>', // password - null // port (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/get.md b/docs/examples/1.6.x/console-web/examples/migrations/get.md deleted file mode 100644 index ececfcb7d2..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.get( - '<MIGRATION_ID>' // migrationId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/list-firebase-projects.md b/docs/examples/1.6.x/console-web/examples/migrations/list-firebase-projects.md deleted file mode 100644 index ec15bebd43..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/list-firebase-projects.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.listFirebaseProjects(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/list.md b/docs/examples/1.6.x/console-web/examples/migrations/list.md deleted file mode 100644 index e3f0fd6a93..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/migrations/retry.md b/docs/examples/1.6.x/console-web/examples/migrations/retry.md deleted file mode 100644 index ebd161b448..0000000000 --- a/docs/examples/1.6.x/console-web/examples/migrations/retry.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Migrations } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const migrations = new Migrations(client); - -const result = await migrations.retry( - '<MIGRATION_ID>' // migrationId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/create-variable.md b/docs/examples/1.6.x/console-web/examples/project/create-variable.md deleted file mode 100644 index 053a102794..0000000000 --- a/docs/examples/1.6.x/console-web/examples/project/create-variable.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Project } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const project = new Project(client); - -const result = await project.createVariable( - '<KEY>', // key - '<VALUE>' // value -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/delete-variable.md b/docs/examples/1.6.x/console-web/examples/project/delete-variable.md deleted file mode 100644 index e4806e6396..0000000000 --- a/docs/examples/1.6.x/console-web/examples/project/delete-variable.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Project } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const project = new Project(client); - -const result = await project.deleteVariable( - '<VARIABLE_ID>' // variableId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/get-usage.md b/docs/examples/1.6.x/console-web/examples/project/get-usage.md deleted file mode 100644 index 5200210abf..0000000000 --- a/docs/examples/1.6.x/console-web/examples/project/get-usage.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Project, ProjectUsageRange } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const project = new Project(client); - -const result = await project.getUsage( - '', // startDate - '', // endDate - ProjectUsageRange.OneHour // period (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/get-variable.md b/docs/examples/1.6.x/console-web/examples/project/get-variable.md deleted file mode 100644 index 4f561c877f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/project/get-variable.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Project } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const project = new Project(client); - -const result = await project.getVariable( - '<VARIABLE_ID>' // variableId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/list-variables.md b/docs/examples/1.6.x/console-web/examples/project/list-variables.md deleted file mode 100644 index 0915dc2102..0000000000 --- a/docs/examples/1.6.x/console-web/examples/project/list-variables.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Project } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const project = new Project(client); - -const result = await project.listVariables(); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/project/update-variable.md b/docs/examples/1.6.x/console-web/examples/project/update-variable.md deleted file mode 100644 index 7e9b5bad61..0000000000 --- a/docs/examples/1.6.x/console-web/examples/project/update-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Project } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const project = new Project(client); - -const result = await project.updateVariable( - '<VARIABLE_ID>', // variableId - '<KEY>', // key - '<VALUE>' // value (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create-j-w-t.md b/docs/examples/1.6.x/console-web/examples/projects/create-j-w-t.md deleted file mode 100644 index a1c7612173..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/create-j-w-t.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.createJWT( - '<PROJECT_ID>', // projectId - [], // scopes - 0 // duration (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create-key.md b/docs/examples/1.6.x/console-web/examples/projects/create-key.md deleted file mode 100644 index d2b2ad4b2e..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/create-key.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.createKey( - '<PROJECT_ID>', // projectId - '<NAME>', // name - [], // scopes - '' // expire (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create-platform.md b/docs/examples/1.6.x/console-web/examples/projects/create-platform.md deleted file mode 100644 index 6e7633a710..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/create-platform.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Projects, PlatformType } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.createPlatform( - '<PROJECT_ID>', // projectId - PlatformType.Web, // type - '<NAME>', // name - '<KEY>', // key (optional) - '<STORE>', // store (optional) - '' // hostname (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create-smtp-test.md b/docs/examples/1.6.x/console-web/examples/projects/create-smtp-test.md deleted file mode 100644 index e3ff0e3aed..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/create-smtp-test.md +++ /dev/null @@ -1,22 +0,0 @@ -import { Client, Projects, SMTPSecure } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.createSmtpTest( - '<PROJECT_ID>', // projectId - [], // emails - '<SENDER_NAME>', // senderName - 'email@example.com', // senderEmail - '', // host - 'email@example.com', // replyTo (optional) - null, // port (optional) - '<USERNAME>', // username (optional) - '<PASSWORD>', // password (optional) - SMTPSecure.Tls // secure (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create-webhook.md b/docs/examples/1.6.x/console-web/examples/projects/create-webhook.md deleted file mode 100644 index 505c7e0ebd..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/create-webhook.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.createWebhook( - '<PROJECT_ID>', // projectId - '<NAME>', // name - [], // events - '', // url - false, // security - false, // enabled (optional) - '<HTTP_USER>', // httpUser (optional) - '<HTTP_PASS>' // httpPass (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/create.md b/docs/examples/1.6.x/console-web/examples/projects/create.md deleted file mode 100644 index c6444b516c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/create.md +++ /dev/null @@ -1,25 +0,0 @@ -import { Client, Projects, } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.create( - '', // projectId - '<NAME>', // name - '<TEAM_ID>', // teamId - .Default, // region (optional) - '<DESCRIPTION>', // description (optional) - '<LOGO>', // logo (optional) - 'https://example.com', // url (optional) - '<LEGAL_NAME>', // legalName (optional) - '<LEGAL_COUNTRY>', // legalCountry (optional) - '<LEGAL_STATE>', // legalState (optional) - '<LEGAL_CITY>', // legalCity (optional) - '<LEGAL_ADDRESS>', // legalAddress (optional) - '<LEGAL_TAX_ID>' // legalTaxId (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete-email-template.md b/docs/examples/1.6.x/console-web/examples/projects/delete-email-template.md deleted file mode 100644 index b973a0f274..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/delete-email-template.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Projects, EmailTemplateType, EmailTemplateLocale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.deleteEmailTemplate( - '<PROJECT_ID>', // projectId - EmailTemplateType.Verification, // type - EmailTemplateLocale.Af // locale -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete-key.md b/docs/examples/1.6.x/console-web/examples/projects/delete-key.md deleted file mode 100644 index 53696cceb2..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/delete-key.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.deleteKey( - '<PROJECT_ID>', // projectId - '<KEY_ID>' // keyId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete-platform.md b/docs/examples/1.6.x/console-web/examples/projects/delete-platform.md deleted file mode 100644 index 0cd3d08a63..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/delete-platform.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.deletePlatform( - '<PROJECT_ID>', // projectId - '<PLATFORM_ID>' // platformId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete-sms-template.md b/docs/examples/1.6.x/console-web/examples/projects/delete-sms-template.md deleted file mode 100644 index 875d9c7caa..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/delete-sms-template.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Projects, SmsTemplateType, SmsTemplateLocale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.deleteSmsTemplate( - '<PROJECT_ID>', // projectId - SmsTemplateType.Verification, // type - SmsTemplateLocale.Af // locale -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete-webhook.md b/docs/examples/1.6.x/console-web/examples/projects/delete-webhook.md deleted file mode 100644 index 94f5a9ad6f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/delete-webhook.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.deleteWebhook( - '<PROJECT_ID>', // projectId - '<WEBHOOK_ID>' // webhookId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/delete.md b/docs/examples/1.6.x/console-web/examples/projects/delete.md deleted file mode 100644 index 79a7df00f2..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.delete( - '<PROJECT_ID>' // projectId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get-email-template.md b/docs/examples/1.6.x/console-web/examples/projects/get-email-template.md deleted file mode 100644 index 1982c29559..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/get-email-template.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Projects, EmailTemplateType, EmailTemplateLocale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.getEmailTemplate( - '<PROJECT_ID>', // projectId - EmailTemplateType.Verification, // type - EmailTemplateLocale.Af // locale -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get-key.md b/docs/examples/1.6.x/console-web/examples/projects/get-key.md deleted file mode 100644 index c4ce139901..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/get-key.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.getKey( - '<PROJECT_ID>', // projectId - '<KEY_ID>' // keyId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get-platform.md b/docs/examples/1.6.x/console-web/examples/projects/get-platform.md deleted file mode 100644 index 3afe06d817..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/get-platform.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.getPlatform( - '<PROJECT_ID>', // projectId - '<PLATFORM_ID>' // platformId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get-sms-template.md b/docs/examples/1.6.x/console-web/examples/projects/get-sms-template.md deleted file mode 100644 index 2588ab0d77..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/get-sms-template.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Projects, SmsTemplateType, SmsTemplateLocale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.getSmsTemplate( - '<PROJECT_ID>', // projectId - SmsTemplateType.Verification, // type - SmsTemplateLocale.Af // locale -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get-webhook.md b/docs/examples/1.6.x/console-web/examples/projects/get-webhook.md deleted file mode 100644 index 9b6637d08f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/get-webhook.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.getWebhook( - '<PROJECT_ID>', // projectId - '<WEBHOOK_ID>' // webhookId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/get.md b/docs/examples/1.6.x/console-web/examples/projects/get.md deleted file mode 100644 index fa2d94b22b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.get( - '<PROJECT_ID>' // projectId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/list-keys.md b/docs/examples/1.6.x/console-web/examples/projects/list-keys.md deleted file mode 100644 index 679914462a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/list-keys.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.listKeys( - '<PROJECT_ID>' // projectId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/list-platforms.md b/docs/examples/1.6.x/console-web/examples/projects/list-platforms.md deleted file mode 100644 index b0f4904626..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/list-platforms.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.listPlatforms( - '<PROJECT_ID>' // projectId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/list-webhooks.md b/docs/examples/1.6.x/console-web/examples/projects/list-webhooks.md deleted file mode 100644 index e567fc695c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/list-webhooks.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.listWebhooks( - '<PROJECT_ID>' // projectId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/list.md b/docs/examples/1.6.x/console-web/examples/projects/list.md deleted file mode 100644 index f81ae481a1..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-api-status-all.md b/docs/examples/1.6.x/console-web/examples/projects/update-api-status-all.md deleted file mode 100644 index e28544d354..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-api-status-all.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateApiStatusAll( - '<PROJECT_ID>', // projectId - false // status -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-api-status.md b/docs/examples/1.6.x/console-web/examples/projects/update-api-status.md deleted file mode 100644 index c5b7e27ba4..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-api-status.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Projects, } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateApiStatus( - '<PROJECT_ID>', // projectId - .Rest, // api - false // status -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-duration.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-duration.md deleted file mode 100644 index 6c000c11d8..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-auth-duration.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateAuthDuration( - '<PROJECT_ID>', // projectId - 0 // duration -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-limit.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-limit.md deleted file mode 100644 index 1a68366ed0..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-auth-limit.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateAuthLimit( - '<PROJECT_ID>', // projectId - 0 // limit -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-dictionary.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-dictionary.md deleted file mode 100644 index 8d9d961c1e..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-dictionary.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateAuthPasswordDictionary( - '<PROJECT_ID>', // projectId - false // enabled -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-history.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-history.md deleted file mode 100644 index 9f7f295af9..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-auth-password-history.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateAuthPasswordHistory( - '<PROJECT_ID>', // projectId - 0 // limit -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-sessions-limit.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-sessions-limit.md deleted file mode 100644 index a20d375051..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-auth-sessions-limit.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateAuthSessionsLimit( - '<PROJECT_ID>', // projectId - 1 // limit -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-auth-status.md b/docs/examples/1.6.x/console-web/examples/projects/update-auth-status.md deleted file mode 100644 index 4eb886dac9..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-auth-status.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Projects, AuthMethod } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateAuthStatus( - '<PROJECT_ID>', // projectId - AuthMethod.EmailPassword, // method - false // status -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-email-template.md b/docs/examples/1.6.x/console-web/examples/projects/update-email-template.md deleted file mode 100644 index 965111ad0e..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-email-template.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Projects, EmailTemplateType, EmailTemplateLocale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateEmailTemplate( - '<PROJECT_ID>', // projectId - EmailTemplateType.Verification, // type - EmailTemplateLocale.Af, // locale - '<SUBJECT>', // subject - '<MESSAGE>', // message - '<SENDER_NAME>', // senderName (optional) - 'email@example.com', // senderEmail (optional) - 'email@example.com' // replyTo (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-key.md b/docs/examples/1.6.x/console-web/examples/projects/update-key.md deleted file mode 100644 index 97c4138bf7..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-key.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateKey( - '<PROJECT_ID>', // projectId - '<KEY_ID>', // keyId - '<NAME>', // name - [], // scopes - '' // expire (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-mock-numbers.md b/docs/examples/1.6.x/console-web/examples/projects/update-mock-numbers.md deleted file mode 100644 index da698a4eb6..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-mock-numbers.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateMockNumbers( - '<PROJECT_ID>', // projectId - [] // numbers -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-o-auth2.md b/docs/examples/1.6.x/console-web/examples/projects/update-o-auth2.md deleted file mode 100644 index 0870f1e81c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-o-auth2.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Projects, OAuthProvider } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateOAuth2( - '<PROJECT_ID>', // projectId - OAuthProvider.Amazon, // provider - '<APP_ID>', // appId (optional) - '<SECRET>', // secret (optional) - false // enabled (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-personal-data-check.md b/docs/examples/1.6.x/console-web/examples/projects/update-personal-data-check.md deleted file mode 100644 index b2cefc1e7f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-personal-data-check.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updatePersonalDataCheck( - '<PROJECT_ID>', // projectId - false // enabled -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-platform.md b/docs/examples/1.6.x/console-web/examples/projects/update-platform.md deleted file mode 100644 index fc62f57360..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-platform.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updatePlatform( - '<PROJECT_ID>', // projectId - '<PLATFORM_ID>', // platformId - '<NAME>', // name - '<KEY>', // key (optional) - '<STORE>', // store (optional) - '' // hostname (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-service-status-all.md b/docs/examples/1.6.x/console-web/examples/projects/update-service-status-all.md deleted file mode 100644 index 9f09337ea5..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-service-status-all.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateServiceStatusAll( - '<PROJECT_ID>', // projectId - false // status -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-service-status.md b/docs/examples/1.6.x/console-web/examples/projects/update-service-status.md deleted file mode 100644 index bf9d69c63f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-service-status.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Projects, ApiService } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateServiceStatus( - '<PROJECT_ID>', // projectId - ApiService.Account, // service - false // status -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-session-alerts.md b/docs/examples/1.6.x/console-web/examples/projects/update-session-alerts.md deleted file mode 100644 index bae22464ec..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-session-alerts.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateSessionAlerts( - '<PROJECT_ID>', // projectId - false // alerts -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-sms-template.md b/docs/examples/1.6.x/console-web/examples/projects/update-sms-template.md deleted file mode 100644 index 3d73d450d8..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-sms-template.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Projects, SmsTemplateType, SmsTemplateLocale } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateSmsTemplate( - '<PROJECT_ID>', // projectId - SmsTemplateType.Verification, // type - SmsTemplateLocale.Af, // locale - '<MESSAGE>' // message -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-smtp.md b/docs/examples/1.6.x/console-web/examples/projects/update-smtp.md deleted file mode 100644 index b24d6b5349..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-smtp.md +++ /dev/null @@ -1,22 +0,0 @@ -import { Client, Projects, SMTPSecure } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateSmtp( - '<PROJECT_ID>', // projectId - false, // enabled - '<SENDER_NAME>', // senderName (optional) - 'email@example.com', // senderEmail (optional) - 'email@example.com', // replyTo (optional) - '', // host (optional) - null, // port (optional) - '<USERNAME>', // username (optional) - '<PASSWORD>', // password (optional) - SMTPSecure.Tls // secure (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-team.md b/docs/examples/1.6.x/console-web/examples/projects/update-team.md deleted file mode 100644 index 98ef985779..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-team.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateTeam( - '<PROJECT_ID>', // projectId - '<TEAM_ID>' // teamId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-webhook-signature.md b/docs/examples/1.6.x/console-web/examples/projects/update-webhook-signature.md deleted file mode 100644 index ff2c0a6e7e..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-webhook-signature.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateWebhookSignature( - '<PROJECT_ID>', // projectId - '<WEBHOOK_ID>' // webhookId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update-webhook.md b/docs/examples/1.6.x/console-web/examples/projects/update-webhook.md deleted file mode 100644 index 69fd250da9..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update-webhook.md +++ /dev/null @@ -1,21 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.updateWebhook( - '<PROJECT_ID>', // projectId - '<WEBHOOK_ID>', // webhookId - '<NAME>', // name - [], // events - '', // url - false, // security - false, // enabled (optional) - '<HTTP_USER>', // httpUser (optional) - '<HTTP_PASS>' // httpPass (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/projects/update.md b/docs/examples/1.6.x/console-web/examples/projects/update.md deleted file mode 100644 index 49d8bf9e23..0000000000 --- a/docs/examples/1.6.x/console-web/examples/projects/update.md +++ /dev/null @@ -1,23 +0,0 @@ -import { Client, Projects } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const projects = new Projects(client); - -const result = await projects.update( - '<PROJECT_ID>', // projectId - '<NAME>', // name - '<DESCRIPTION>', // description (optional) - '<LOGO>', // logo (optional) - 'https://example.com', // url (optional) - '<LEGAL_NAME>', // legalName (optional) - '<LEGAL_COUNTRY>', // legalCountry (optional) - '<LEGAL_STATE>', // legalState (optional) - '<LEGAL_CITY>', // legalCity (optional) - '<LEGAL_ADDRESS>', // legalAddress (optional) - '<LEGAL_TAX_ID>' // legalTaxId (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/proxy/create-rule.md b/docs/examples/1.6.x/console-web/examples/proxy/create-rule.md deleted file mode 100644 index 2bf7a8d446..0000000000 --- a/docs/examples/1.6.x/console-web/examples/proxy/create-rule.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Proxy, } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const proxy = new Proxy(client); - -const result = await proxy.createRule( - '', // domain - .Api, // resourceType - '<RESOURCE_ID>' // resourceId (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/proxy/delete-rule.md b/docs/examples/1.6.x/console-web/examples/proxy/delete-rule.md deleted file mode 100644 index a9ffeef834..0000000000 --- a/docs/examples/1.6.x/console-web/examples/proxy/delete-rule.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Proxy } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const proxy = new Proxy(client); - -const result = await proxy.deleteRule( - '<RULE_ID>' // ruleId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/proxy/get-rule.md b/docs/examples/1.6.x/console-web/examples/proxy/get-rule.md deleted file mode 100644 index 95ff2124ac..0000000000 --- a/docs/examples/1.6.x/console-web/examples/proxy/get-rule.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Proxy } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const proxy = new Proxy(client); - -const result = await proxy.getRule( - '<RULE_ID>' // ruleId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/proxy/list-rules.md b/docs/examples/1.6.x/console-web/examples/proxy/list-rules.md deleted file mode 100644 index f9b7f35376..0000000000 --- a/docs/examples/1.6.x/console-web/examples/proxy/list-rules.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Proxy } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const proxy = new Proxy(client); - -const result = await proxy.listRules( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/proxy/update-rule-verification.md b/docs/examples/1.6.x/console-web/examples/proxy/update-rule-verification.md deleted file mode 100644 index 1696c32b34..0000000000 --- a/docs/examples/1.6.x/console-web/examples/proxy/update-rule-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Proxy } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const proxy = new Proxy(client); - -const result = await proxy.updateRuleVerification( - '<RULE_ID>' // ruleId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/create-bucket.md b/docs/examples/1.6.x/console-web/examples/storage/create-bucket.md deleted file mode 100644 index 4481ada4aa..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/create-bucket.md +++ /dev/null @@ -1,22 +0,0 @@ -import { Client, Storage, } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.createBucket( - '<BUCKET_ID>', // bucketId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // fileSecurity (optional) - false, // enabled (optional) - 1, // maximumFileSize (optional) - [], // allowedFileExtensions (optional) - .None, // compression (optional) - false, // encryption (optional) - false // antivirus (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/create-file.md b/docs/examples/1.6.x/console-web/examples/storage/create-file.md deleted file mode 100644 index ec326fa71e..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/create-file.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Storage } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.createFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - document.getElementById('uploader').files[0], // file - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/delete-bucket.md b/docs/examples/1.6.x/console-web/examples/storage/delete-bucket.md deleted file mode 100644 index 819def336e..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/delete-bucket.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Storage } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.deleteBucket( - '<BUCKET_ID>' // bucketId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/delete-file.md b/docs/examples/1.6.x/console-web/examples/storage/delete-file.md deleted file mode 100644 index 670770706f..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/delete-file.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.deleteFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-bucket-usage.md b/docs/examples/1.6.x/console-web/examples/storage/get-bucket-usage.md deleted file mode 100644 index 98d4a621ec..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/get-bucket-usage.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage, StorageUsageRange } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.getBucketUsage( - '<BUCKET_ID>', // bucketId - StorageUsageRange.TwentyFourHours // range (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-bucket.md b/docs/examples/1.6.x/console-web/examples/storage/get-bucket.md deleted file mode 100644 index 52b7082baf..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/get-bucket.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Storage } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.getBucket( - '<BUCKET_ID>' // bucketId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-file-download.md b/docs/examples/1.6.x/console-web/examples/storage/get-file-download.md deleted file mode 100644 index 53e6a846e8..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/get-file-download.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = storage.getFileDownload( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-file-preview.md b/docs/examples/1.6.x/console-web/examples/storage/get-file-preview.md deleted file mode 100644 index 43c3582dcb..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/get-file-preview.md +++ /dev/null @@ -1,25 +0,0 @@ -import { Client, Storage, ImageGravity, ImageFormat } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = storage.getFilePreview( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - 0, // width (optional) - 0, // height (optional) - ImageGravity.Center, // gravity (optional) - 0, // quality (optional) - 0, // borderWidth (optional) - '', // borderColor (optional) - 0, // borderRadius (optional) - 0, // opacity (optional) - -360, // rotation (optional) - '', // background (optional) - ImageFormat.Jpg // output (optional) -); - -console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-file-view.md b/docs/examples/1.6.x/console-web/examples/storage/get-file-view.md deleted file mode 100644 index 787bd67d16..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/get-file-view.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = storage.getFileView( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(result); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-file.md b/docs/examples/1.6.x/console-web/examples/storage/get-file.md deleted file mode 100644 index e1118c0f26..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/get-file.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.getFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/get-usage.md b/docs/examples/1.6.x/console-web/examples/storage/get-usage.md deleted file mode 100644 index a67dbf1af8..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/get-usage.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Storage, StorageUsageRange } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.getUsage( - StorageUsageRange.TwentyFourHours // range (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/list-buckets.md b/docs/examples/1.6.x/console-web/examples/storage/list-buckets.md deleted file mode 100644 index 5caf111b64..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/list-buckets.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.listBuckets( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/list-files.md b/docs/examples/1.6.x/console-web/examples/storage/list-files.md deleted file mode 100644 index c139e8ba14..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/list-files.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Storage } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.listFiles( - '<BUCKET_ID>', // bucketId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/update-bucket.md b/docs/examples/1.6.x/console-web/examples/storage/update-bucket.md deleted file mode 100644 index bd7d923358..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/update-bucket.md +++ /dev/null @@ -1,22 +0,0 @@ -import { Client, Storage, } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.updateBucket( - '<BUCKET_ID>', // bucketId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // fileSecurity (optional) - false, // enabled (optional) - 1, // maximumFileSize (optional) - [], // allowedFileExtensions (optional) - .None, // compression (optional) - false, // encryption (optional) - false // antivirus (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/storage/update-file.md b/docs/examples/1.6.x/console-web/examples/storage/update-file.md deleted file mode 100644 index c597905956..0000000000 --- a/docs/examples/1.6.x/console-web/examples/storage/update-file.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Storage } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const storage = new Storage(client); - -const result = await storage.updateFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - '<NAME>', // name (optional) - ["read("any")"] // permissions (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/create-membership.md b/docs/examples/1.6.x/console-web/examples/teams/create-membership.md deleted file mode 100644 index 6eb57f4404..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/create-membership.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.createMembership( - '<TEAM_ID>', // teamId - [], // roles - 'email@example.com', // email (optional) - '<USER_ID>', // userId (optional) - '+12065550100', // phone (optional) - 'https://example.com', // url (optional) - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/create.md b/docs/examples/1.6.x/console-web/examples/teams/create.md deleted file mode 100644 index 47aad4c384..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/create.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.create( - '<TEAM_ID>', // teamId - '<NAME>', // name - [] // roles (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/delete-membership.md b/docs/examples/1.6.x/console-web/examples/teams/delete-membership.md deleted file mode 100644 index ba07bb2ccb..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/delete-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.deleteMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>' // membershipId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/delete.md b/docs/examples/1.6.x/console-web/examples/teams/delete.md deleted file mode 100644 index 71a4721359..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.delete( - '<TEAM_ID>' // teamId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/get-membership.md b/docs/examples/1.6.x/console-web/examples/teams/get-membership.md deleted file mode 100644 index 1b97621834..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/get-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.getMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>' // membershipId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/get-prefs.md b/docs/examples/1.6.x/console-web/examples/teams/get-prefs.md deleted file mode 100644 index fc21ec0e13..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/get-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.getPrefs( - '<TEAM_ID>' // teamId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/get.md b/docs/examples/1.6.x/console-web/examples/teams/get.md deleted file mode 100644 index 5de7eba9bf..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.get( - '<TEAM_ID>' // teamId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/list-logs.md b/docs/examples/1.6.x/console-web/examples/teams/list-logs.md deleted file mode 100644 index 5d18db7f90..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/list-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.listLogs( - '<TEAM_ID>', // teamId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/list-memberships.md b/docs/examples/1.6.x/console-web/examples/teams/list-memberships.md deleted file mode 100644 index c1fcaa0833..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/list-memberships.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.listMemberships( - '<TEAM_ID>', // teamId - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/list.md b/docs/examples/1.6.x/console-web/examples/teams/list.md deleted file mode 100644 index fbd10f5071..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/update-membership-status.md b/docs/examples/1.6.x/console-web/examples/teams/update-membership-status.md deleted file mode 100644 index 14d386c664..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/update-membership-status.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updateMembershipStatus( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>', // membershipId - '<USER_ID>', // userId - '<SECRET>' // secret -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/update-membership.md b/docs/examples/1.6.x/console-web/examples/teams/update-membership.md deleted file mode 100644 index c83344fc0e..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/update-membership.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updateMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>', // membershipId - [] // roles -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/update-name.md b/docs/examples/1.6.x/console-web/examples/teams/update-name.md deleted file mode 100644 index b64c0d790d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/update-name.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updateName( - '<TEAM_ID>', // teamId - '<NAME>' // name -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/teams/update-prefs.md b/docs/examples/1.6.x/console-web/examples/teams/update-prefs.md deleted file mode 100644 index d55b2aacff..0000000000 --- a/docs/examples/1.6.x/console-web/examples/teams/update-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const teams = new Teams(client); - -const result = await teams.updatePrefs( - '<TEAM_ID>', // teamId - {} // prefs -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-argon2user.md b/docs/examples/1.6.x/console-web/examples/users/create-argon2user.md deleted file mode 100644 index 02c6c1e193..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-argon2user.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createArgon2User( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/console-web/examples/users/create-bcrypt-user.md deleted file mode 100644 index ec9e978085..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createBcryptUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-j-w-t.md b/docs/examples/1.6.x/console-web/examples/users/create-j-w-t.md deleted file mode 100644 index effe86748c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-j-w-t.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createJWT( - '<USER_ID>', // userId - '<SESSION_ID>', // sessionId (optional) - 0 // duration (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-m-d5user.md b/docs/examples/1.6.x/console-web/examples/users/create-m-d5user.md deleted file mode 100644 index 4b7ced5793..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-m-d5user.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createMD5User( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index 7297fac96a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createMfaRecoveryCodes( - '<USER_ID>' // userId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/console-web/examples/users/create-p-h-pass-user.md deleted file mode 100644 index 52cdec1414..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createPHPassUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/console-web/examples/users/create-s-h-a-user.md deleted file mode 100644 index 029a524bc9..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Users, PasswordHash } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createSHAUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - PasswordHash.Sha1, // passwordVersion (optional) - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/console-web/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index 0a94516199..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createScryptModifiedUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<PASSWORD_SALT>', // passwordSalt - '<PASSWORD_SALT_SEPARATOR>', // passwordSaltSeparator - '<PASSWORD_SIGNER_KEY>', // passwordSignerKey - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/console-web/examples/users/create-scrypt-user.md deleted file mode 100644 index eb9cc238c6..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,21 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createScryptUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<PASSWORD_SALT>', // passwordSalt - null, // passwordCpu - null, // passwordMemory - null, // passwordParallel - null, // passwordLength - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-session.md b/docs/examples/1.6.x/console-web/examples/users/create-session.md deleted file mode 100644 index 83c3540508..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createSession( - '<USER_ID>' // userId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-target.md b/docs/examples/1.6.x/console-web/examples/users/create-target.md deleted file mode 100644 index b44a7bceed..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-target.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Users, MessagingProviderType } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createTarget( - '<USER_ID>', // userId - '<TARGET_ID>', // targetId - MessagingProviderType.Email, // providerType - '<IDENTIFIER>', // identifier - '<PROVIDER_ID>', // providerId (optional) - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create-token.md b/docs/examples/1.6.x/console-web/examples/users/create-token.md deleted file mode 100644 index 54611cb8dc..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create-token.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.createToken( - '<USER_ID>', // userId - 4, // length (optional) - 60 // expire (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/create.md b/docs/examples/1.6.x/console-web/examples/users/create.md deleted file mode 100644 index 488bea064a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/create.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.create( - '<USER_ID>', // userId - 'email@example.com', // email (optional) - '+12065550100', // phone (optional) - '', // password (optional) - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete-identity.md b/docs/examples/1.6.x/console-web/examples/users/delete-identity.md deleted file mode 100644 index bd44e19df6..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/delete-identity.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.deleteIdentity( - '<IDENTITY_ID>' // identityId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/console-web/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index 6264163605..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users, AuthenticatorType } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.deleteMfaAuthenticator( - '<USER_ID>', // userId - AuthenticatorType.Totp // type -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete-session.md b/docs/examples/1.6.x/console-web/examples/users/delete-session.md deleted file mode 100644 index 95832cddc7..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/delete-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.deleteSession( - '<USER_ID>', // userId - '<SESSION_ID>' // sessionId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete-sessions.md b/docs/examples/1.6.x/console-web/examples/users/delete-sessions.md deleted file mode 100644 index 6e272418f0..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/delete-sessions.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.deleteSessions( - '<USER_ID>' // userId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete-target.md b/docs/examples/1.6.x/console-web/examples/users/delete-target.md deleted file mode 100644 index 62ea4fff20..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/delete-target.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.deleteTarget( - '<USER_ID>', // userId - '<TARGET_ID>' // targetId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/delete.md b/docs/examples/1.6.x/console-web/examples/users/delete.md deleted file mode 100644 index 6304bf4dbe..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.delete( - '<USER_ID>' // userId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index 96b1e53793..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.getMfaRecoveryCodes( - '<USER_ID>' // userId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/get-prefs.md b/docs/examples/1.6.x/console-web/examples/users/get-prefs.md deleted file mode 100644 index 30f0e87967..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/get-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.getPrefs( - '<USER_ID>' // userId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/get-target.md b/docs/examples/1.6.x/console-web/examples/users/get-target.md deleted file mode 100644 index e568bec924..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/get-target.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.getTarget( - '<USER_ID>', // userId - '<TARGET_ID>' // targetId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/get-usage.md b/docs/examples/1.6.x/console-web/examples/users/get-usage.md deleted file mode 100644 index 7690def7d9..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/get-usage.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users, UserUsageRange } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.getUsage( - UserUsageRange.TwentyFourHours // range (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/get.md b/docs/examples/1.6.x/console-web/examples/users/get.md deleted file mode 100644 index 3fe5d22dd5..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.get( - '<USER_ID>' // userId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-identities.md b/docs/examples/1.6.x/console-web/examples/users/list-identities.md deleted file mode 100644 index a56388cf54..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/list-identities.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.listIdentities( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-logs.md b/docs/examples/1.6.x/console-web/examples/users/list-logs.md deleted file mode 100644 index 4ec5e667d7..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/list-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.listLogs( - '<USER_ID>', // userId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-memberships.md b/docs/examples/1.6.x/console-web/examples/users/list-memberships.md deleted file mode 100644 index 389a2cd136..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/list-memberships.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.listMemberships( - '<USER_ID>' // userId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/console-web/examples/users/list-mfa-factors.md deleted file mode 100644 index 5a34a5d38c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.listMfaFactors( - '<USER_ID>' // userId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-sessions.md b/docs/examples/1.6.x/console-web/examples/users/list-sessions.md deleted file mode 100644 index 3aaa019413..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/list-sessions.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.listSessions( - '<USER_ID>' // userId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list-targets.md b/docs/examples/1.6.x/console-web/examples/users/list-targets.md deleted file mode 100644 index 950fa08ed3..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/list-targets.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.listTargets( - '<USER_ID>', // userId - [] // queries (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/list.md b/docs/examples/1.6.x/console-web/examples/users/list.md deleted file mode 100644 index f3421fdca3..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-email-verification.md b/docs/examples/1.6.x/console-web/examples/users/update-email-verification.md deleted file mode 100644 index 991af51cc8..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-email-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updateEmailVerification( - '<USER_ID>', // userId - false // emailVerification -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-email.md b/docs/examples/1.6.x/console-web/examples/users/update-email.md deleted file mode 100644 index 28c892aef6..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-email.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updateEmail( - '<USER_ID>', // userId - 'email@example.com' // email -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-labels.md b/docs/examples/1.6.x/console-web/examples/users/update-labels.md deleted file mode 100644 index b5031d7583..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-labels.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updateLabels( - '<USER_ID>', // userId - [] // labels -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/console-web/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index 0b7586da0d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updateMfaRecoveryCodes( - '<USER_ID>' // userId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-mfa.md b/docs/examples/1.6.x/console-web/examples/users/update-mfa.md deleted file mode 100644 index 16bc49c5c3..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-mfa.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updateMfa( - '<USER_ID>', // userId - false // mfa -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-name.md b/docs/examples/1.6.x/console-web/examples/users/update-name.md deleted file mode 100644 index 59aca8c013..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-name.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updateName( - '<USER_ID>', // userId - '<NAME>' // name -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-password.md b/docs/examples/1.6.x/console-web/examples/users/update-password.md deleted file mode 100644 index f6e7c4c369..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-password.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updatePassword( - '<USER_ID>', // userId - '' // password -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-phone-verification.md b/docs/examples/1.6.x/console-web/examples/users/update-phone-verification.md deleted file mode 100644 index f477ec2419..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-phone-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updatePhoneVerification( - '<USER_ID>', // userId - false // phoneVerification -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-phone.md b/docs/examples/1.6.x/console-web/examples/users/update-phone.md deleted file mode 100644 index 1d942f384a..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-phone.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updatePhone( - '<USER_ID>', // userId - '+12065550100' // number -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-prefs.md b/docs/examples/1.6.x/console-web/examples/users/update-prefs.md deleted file mode 100644 index 853631e0cb..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updatePrefs( - '<USER_ID>', // userId - {} // prefs -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-status.md b/docs/examples/1.6.x/console-web/examples/users/update-status.md deleted file mode 100644 index 6b28c5d744..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-status.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updateStatus( - '<USER_ID>', // userId - false // status -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/users/update-target.md b/docs/examples/1.6.x/console-web/examples/users/update-target.md deleted file mode 100644 index 86fc1c3154..0000000000 --- a/docs/examples/1.6.x/console-web/examples/users/update-target.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Users } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const users = new Users(client); - -const result = await users.updateTarget( - '<USER_ID>', // userId - '<TARGET_ID>', // targetId - '<IDENTIFIER>', // identifier (optional) - '<PROVIDER_ID>', // providerId (optional) - '<NAME>' // name (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/create-repository-detection.md b/docs/examples/1.6.x/console-web/examples/vcs/create-repository-detection.md deleted file mode 100644 index dd71b6757d..0000000000 --- a/docs/examples/1.6.x/console-web/examples/vcs/create-repository-detection.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Vcs } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const vcs = new Vcs(client); - -const result = await vcs.createRepositoryDetection( - '<INSTALLATION_ID>', // installationId - '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId - '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/create-repository.md b/docs/examples/1.6.x/console-web/examples/vcs/create-repository.md deleted file mode 100644 index 7d73b2ab83..0000000000 --- a/docs/examples/1.6.x/console-web/examples/vcs/create-repository.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Vcs } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const vcs = new Vcs(client); - -const result = await vcs.createRepository( - '<INSTALLATION_ID>', // installationId - '<NAME>', // name - false // private -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/delete-installation.md b/docs/examples/1.6.x/console-web/examples/vcs/delete-installation.md deleted file mode 100644 index a770bb66eb..0000000000 --- a/docs/examples/1.6.x/console-web/examples/vcs/delete-installation.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Vcs } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const vcs = new Vcs(client); - -const result = await vcs.deleteInstallation( - '<INSTALLATION_ID>' // installationId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/get-installation.md b/docs/examples/1.6.x/console-web/examples/vcs/get-installation.md deleted file mode 100644 index 961a6c4d70..0000000000 --- a/docs/examples/1.6.x/console-web/examples/vcs/get-installation.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Vcs } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const vcs = new Vcs(client); - -const result = await vcs.getInstallation( - '<INSTALLATION_ID>' // installationId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/get-repository-contents.md b/docs/examples/1.6.x/console-web/examples/vcs/get-repository-contents.md deleted file mode 100644 index e9c57376e6..0000000000 --- a/docs/examples/1.6.x/console-web/examples/vcs/get-repository-contents.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Vcs } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const vcs = new Vcs(client); - -const result = await vcs.getRepositoryContents( - '<INSTALLATION_ID>', // installationId - '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId - '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/get-repository.md b/docs/examples/1.6.x/console-web/examples/vcs/get-repository.md deleted file mode 100644 index 05d8b6c453..0000000000 --- a/docs/examples/1.6.x/console-web/examples/vcs/get-repository.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Vcs } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const vcs = new Vcs(client); - -const result = await vcs.getRepository( - '<INSTALLATION_ID>', // installationId - '<PROVIDER_REPOSITORY_ID>' // providerRepositoryId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/list-installations.md b/docs/examples/1.6.x/console-web/examples/vcs/list-installations.md deleted file mode 100644 index 64ff523c0c..0000000000 --- a/docs/examples/1.6.x/console-web/examples/vcs/list-installations.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Vcs } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const vcs = new Vcs(client); - -const result = await vcs.listInstallations( - [], // queries (optional) - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/list-repositories.md b/docs/examples/1.6.x/console-web/examples/vcs/list-repositories.md deleted file mode 100644 index 80115d6c24..0000000000 --- a/docs/examples/1.6.x/console-web/examples/vcs/list-repositories.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Vcs } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const vcs = new Vcs(client); - -const result = await vcs.listRepositories( - '<INSTALLATION_ID>', // installationId - '<SEARCH>' // search (optional) -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/list-repository-branches.md b/docs/examples/1.6.x/console-web/examples/vcs/list-repository-branches.md deleted file mode 100644 index d236f8b598..0000000000 --- a/docs/examples/1.6.x/console-web/examples/vcs/list-repository-branches.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Vcs } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const vcs = new Vcs(client); - -const result = await vcs.listRepositoryBranches( - '<INSTALLATION_ID>', // installationId - '<PROVIDER_REPOSITORY_ID>' // providerRepositoryId -); - -console.log(response); diff --git a/docs/examples/1.6.x/console-web/examples/vcs/update-external-deployments.md b/docs/examples/1.6.x/console-web/examples/vcs/update-external-deployments.md deleted file mode 100644 index 577e0ac59b..0000000000 --- a/docs/examples/1.6.x/console-web/examples/vcs/update-external-deployments.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Vcs } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const vcs = new Vcs(client); - -const result = await vcs.updateExternalDeployments( - '<INSTALLATION_ID>', // installationId - '<REPOSITORY_ID>', // repositoryId - '<PROVIDER_PULL_REQUEST_ID>' // providerPullRequestId -); - -console.log(response); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-dart/examples/account/create-anonymous-session.md deleted file mode 100644 index 63e0e12f4a..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.createAnonymousSession(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-dart/examples/account/create-email-password-session.md deleted file mode 100644 index bf2fa29a24..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-email-password-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.createEmailPasswordSession( - email: 'email@example.com', - password: 'password', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-email-token.md b/docs/examples/1.6.x/server-dart/examples/account/create-email-token.md deleted file mode 100644 index 9c85d1b974..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-email-token.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.createEmailToken( - userId: '<USER_ID>', - email: 'email@example.com', - phrase: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-dart/examples/account/create-j-w-t.md deleted file mode 100644 index eba3e5e638..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-j-w-t.md +++ /dev/null @@ -1,9 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Jwt result = await account.createJWT(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-dart/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 8518b35c63..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.createMagicURLToken( - userId: '<USER_ID>', - email: 'email@example.com', - url: 'https://example.com', // (optional) - phrase: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-dart/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 27ba997aab..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -MfaType result = await account.createMfaAuthenticator( - type: AuthenticatorType.totp, -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-dart/examples/account/create-mfa-challenge.md deleted file mode 100644 index 7837505840..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,11 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -MfaChallenge result = await account.createMfaChallenge( - factor: AuthenticationFactor.email, -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index aae8a6ac60..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -MfaRecoveryCodes result = await account.createMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-dart/examples/account/create-o-auth2token.md deleted file mode 100644 index fc2d19abd0..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -await account.createOAuth2Token( - provider: OAuthProvider.amazon, - success: 'https://example.com', // (optional) - failure: 'https://example.com', // (optional) - scopes: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-dart/examples/account/create-phone-token.md deleted file mode 100644 index 08d177d777..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-phone-token.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Token result = await account.createPhoneToken( - userId: '<USER_ID>', - phone: '+12065550100', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-dart/examples/account/create-phone-verification.md deleted file mode 100644 index be0a51448f..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-phone-verification.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -Token result = await account.createPhoneVerification(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-recovery.md b/docs/examples/1.6.x/server-dart/examples/account/create-recovery.md deleted file mode 100644 index 51fa49ef29..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-recovery.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -Token result = await account.createRecovery( - email: 'email@example.com', - url: 'https://example.com', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-session.md b/docs/examples/1.6.x/server-dart/examples/account/create-session.md deleted file mode 100644 index 654e6aaa1b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.createSession( - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create-verification.md b/docs/examples/1.6.x/server-dart/examples/account/create-verification.md deleted file mode 100644 index c4fc88e9bf..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -Token result = await account.createVerification( - url: 'https://example.com', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/create.md b/docs/examples/1.6.x/server-dart/examples/account/create.md deleted file mode 100644 index 6f5e57fb03..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/create.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -User result = await account.create( - userId: '<USER_ID>', - email: 'email@example.com', - password: '', - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/delete-identity.md b/docs/examples/1.6.x/server-dart/examples/account/delete-identity.md deleted file mode 100644 index d42ac24541..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/delete-identity.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -await account.deleteIdentity( - identityId: '<IDENTITY_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-dart/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 1a5903f145..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -await account.deleteMfaAuthenticator( - type: AuthenticatorType.totp, -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/delete-session.md b/docs/examples/1.6.x/server-dart/examples/account/delete-session.md deleted file mode 100644 index 5f5141af62..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/delete-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -await account.deleteSession( - sessionId: '<SESSION_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-dart/examples/account/delete-sessions.md deleted file mode 100644 index a545b5416c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/delete-sessions.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -await account.deleteSessions(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index 0f174f8513..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -MfaRecoveryCodes result = await account.getMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/get-prefs.md b/docs/examples/1.6.x/server-dart/examples/account/get-prefs.md deleted file mode 100644 index 5a65d67e67..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/get-prefs.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -Preferences result = await account.getPrefs(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/get-session.md b/docs/examples/1.6.x/server-dart/examples/account/get-session.md deleted file mode 100644 index 848aecf23c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/get-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -Session result = await account.getSession( - sessionId: '<SESSION_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/get.md b/docs/examples/1.6.x/server-dart/examples/account/get.md deleted file mode 100644 index 635203634a..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/get.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -User result = await account.get(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/list-identities.md b/docs/examples/1.6.x/server-dart/examples/account/list-identities.md deleted file mode 100644 index 21bd264bd9..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/list-identities.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -IdentityList result = await account.listIdentities( - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/list-logs.md b/docs/examples/1.6.x/server-dart/examples/account/list-logs.md deleted file mode 100644 index 754e89fce1..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/list-logs.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -LogList result = await account.listLogs( - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-dart/examples/account/list-mfa-factors.md deleted file mode 100644 index 3da79444f7..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -MfaFactors result = await account.listMfaFactors(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/list-sessions.md b/docs/examples/1.6.x/server-dart/examples/account/list-sessions.md deleted file mode 100644 index f444d7d2d0..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/list-sessions.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -SessionList result = await account.listSessions(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-email.md b/docs/examples/1.6.x/server-dart/examples/account/update-email.md deleted file mode 100644 index 7defb487b3..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-email.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -User result = await account.updateEmail( - email: 'email@example.com', - password: 'password', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-dart/examples/account/update-m-f-a.md deleted file mode 100644 index b7f4f491ba..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-m-f-a.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -User result = await account.updateMFA( - mfa: false, -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-dart/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index fe47afdb51..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.updateMagicURLSession( - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-dart/examples/account/update-mfa-authenticator.md deleted file mode 100644 index cf6beb4346..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -User result = await account.updateMfaAuthenticator( - type: AuthenticatorType.totp, - otp: '<OTP>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-dart/examples/account/update-mfa-challenge.md deleted file mode 100644 index c84520a744..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - - result = await account.updateMfaChallenge( - challengeId: '<CHALLENGE_ID>', - otp: '<OTP>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index 1fe007c4ee..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -MfaRecoveryCodes result = await account.updateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-name.md b/docs/examples/1.6.x/server-dart/examples/account/update-name.md deleted file mode 100644 index 742fb7a4d8..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-name.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -User result = await account.updateName( - name: '<NAME>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-password.md b/docs/examples/1.6.x/server-dart/examples/account/update-password.md deleted file mode 100644 index 086dbb7185..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-password.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -User result = await account.updatePassword( - password: '', - oldPassword: 'password', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-dart/examples/account/update-phone-session.md deleted file mode 100644 index 5ecc6e2a32..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-phone-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -Account account = Account(client); - -Session result = await account.updatePhoneSession( - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-dart/examples/account/update-phone-verification.md deleted file mode 100644 index d729bf0c2f..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -Token result = await account.updatePhoneVerification( - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-phone.md b/docs/examples/1.6.x/server-dart/examples/account/update-phone.md deleted file mode 100644 index 8dc0ef08a8..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-phone.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -User result = await account.updatePhone( - phone: '+12065550100', - password: 'password', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-prefs.md b/docs/examples/1.6.x/server-dart/examples/account/update-prefs.md deleted file mode 100644 index b53439fe9d..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -User result = await account.updatePrefs( - prefs: {}, -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-recovery.md b/docs/examples/1.6.x/server-dart/examples/account/update-recovery.md deleted file mode 100644 index 5613e85c5c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -Token result = await account.updateRecovery( - userId: '<USER_ID>', - secret: '<SECRET>', - password: '', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-session.md b/docs/examples/1.6.x/server-dart/examples/account/update-session.md deleted file mode 100644 index c0a8bed918..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -Session result = await account.updateSession( - sessionId: '<SESSION_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-status.md b/docs/examples/1.6.x/server-dart/examples/account/update-status.md deleted file mode 100644 index 3a19c84d9e..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-status.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -User result = await account.updateStatus(); diff --git a/docs/examples/1.6.x/server-dart/examples/account/update-verification.md b/docs/examples/1.6.x/server-dart/examples/account/update-verification.md deleted file mode 100644 index 95b5b3bfad..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/account/update-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Account account = Account(client); - -Token result = await account.updateVerification( - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-browser.md deleted file mode 100644 index b145341d4a..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/avatars/get-browser.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Avatars avatars = Avatars(client); - -UInt8List result = await avatars.getBrowser( - code: Browser.avantBrowser, - width: 0, // (optional) - height: 0, // (optional) - quality: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-credit-card.md deleted file mode 100644 index f2cec4f9af..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Avatars avatars = Avatars(client); - -UInt8List result = await avatars.getCreditCard( - code: CreditCard.americanExpress, - width: 0, // (optional) - height: 0, // (optional) - quality: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-favicon.md deleted file mode 100644 index 07f510d9d3..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/avatars/get-favicon.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Avatars avatars = Avatars(client); - -UInt8List result = await avatars.getFavicon( - url: 'https://example.com', -); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-flag.md deleted file mode 100644 index d4c170c121..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/avatars/get-flag.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Avatars avatars = Avatars(client); - -UInt8List result = await avatars.getFlag( - code: Flag.afghanistan, - width: 0, // (optional) - height: 0, // (optional) - quality: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-image.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-image.md deleted file mode 100644 index cdbe4770b0..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/avatars/get-image.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Avatars avatars = Avatars(client); - -UInt8List result = await avatars.getImage( - url: 'https://example.com', - width: 0, // (optional) - height: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-initials.md deleted file mode 100644 index dbe79cc4cb..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/avatars/get-initials.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Avatars avatars = Avatars(client); - -UInt8List result = await avatars.getInitials( - name: '<NAME>', // (optional) - width: 0, // (optional) - height: 0, // (optional) - background: '', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-dart/examples/avatars/get-q-r.md deleted file mode 100644 index 693ad55dcc..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/avatars/get-q-r.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Avatars avatars = Avatars(client); - -UInt8List result = await avatars.getQR( - text: '<TEXT>', - size: 1, // (optional) - margin: 0, // (optional) - download: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-boolean-attribute.md deleted file mode 100644 index 75e3a2c74c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeBoolean result = await databases.createBooleanAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - xdefault: false, // (optional) - array: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-collection.md b/docs/examples/1.6.x/server-dart/examples/databases/create-collection.md deleted file mode 100644 index 860d6e4db3..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-collection.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -Collection result = await databases.createCollection( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - name: '<NAME>', - permissions: ["read("any")"], // (optional) - documentSecurity: false, // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-datetime-attribute.md deleted file mode 100644 index 38fb373dd4..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeDatetime result = await databases.createDatetimeAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - xdefault: '', // (optional) - array: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-document.md b/docs/examples/1.6.x/server-dart/examples/databases/create-document.md deleted file mode 100644 index 4867432c5b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Databases databases = Databases(client); - -Document result = await databases.createDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>', - data: {}, - permissions: ["read("any")"], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-email-attribute.md deleted file mode 100644 index caf11c20c2..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeEmail result = await databases.createEmailAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - xdefault: 'email@example.com', // (optional) - array: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-enum-attribute.md deleted file mode 100644 index eeb050570c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeEnum result = await databases.createEnumAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - elements: [], - xrequired: false, - xdefault: '<DEFAULT>', // (optional) - array: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-float-attribute.md deleted file mode 100644 index b735c49656..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeFloat result = await databases.createFloatAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - min: 0, // (optional) - max: 0, // (optional) - xdefault: 0, // (optional) - array: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-index.md b/docs/examples/1.6.x/server-dart/examples/databases/create-index.md deleted file mode 100644 index 5350d0df23..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-index.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -Index result = await databases.createIndex( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - type: IndexType.key, - attributes: [], - orders: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-integer-attribute.md deleted file mode 100644 index c0528bca98..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeInteger result = await databases.createIntegerAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - min: 0, // (optional) - max: 0, // (optional) - xdefault: 0, // (optional) - array: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-ip-attribute.md deleted file mode 100644 index ebe5361113..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeIp result = await databases.createIpAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - xdefault: '', // (optional) - array: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-relationship-attribute.md deleted file mode 100644 index 24f9681fc5..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeRelationship result = await databases.createRelationshipAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - relatedCollectionId: '<RELATED_COLLECTION_ID>', - type: RelationshipType.oneToOne, - twoWay: false, // (optional) - key: '', // (optional) - twoWayKey: '', // (optional) - onDelete: RelationMutate.cascade, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-string-attribute.md deleted file mode 100644 index 30ecaa0ef5..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeString result = await databases.createStringAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - size: 1, - xrequired: false, - xdefault: '<DEFAULT>', // (optional) - array: false, // (optional) - encrypt: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/create-url-attribute.md deleted file mode 100644 index 530ff80f03..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeUrl result = await databases.createUrlAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - xdefault: 'https://example.com', // (optional) - array: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/create.md b/docs/examples/1.6.x/server-dart/examples/databases/create.md deleted file mode 100644 index e59c6c8a98..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/create.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -Database result = await databases.create( - databaseId: '<DATABASE_ID>', - name: '<NAME>', - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/delete-attribute.md deleted file mode 100644 index 264dac1c2b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/delete-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -await databases.deleteAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-dart/examples/databases/delete-collection.md deleted file mode 100644 index c4532a4705..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/delete-collection.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -await databases.deleteCollection( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/delete-document.md b/docs/examples/1.6.x/server-dart/examples/databases/delete-document.md deleted file mode 100644 index b9745650d2..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/delete-document.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Databases databases = Databases(client); - -await databases.deleteDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/delete-index.md b/docs/examples/1.6.x/server-dart/examples/databases/delete-index.md deleted file mode 100644 index 5c1e6196f0..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/delete-index.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -await databases.deleteIndex( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/delete.md b/docs/examples/1.6.x/server-dart/examples/databases/delete.md deleted file mode 100644 index 9cf51c982f..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -await databases.delete( - databaseId: '<DATABASE_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/get-attribute.md deleted file mode 100644 index fdfd2d0379..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/get-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - - result = await databases.getAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/get-collection.md b/docs/examples/1.6.x/server-dart/examples/databases/get-collection.md deleted file mode 100644 index 36c10dfdda..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/get-collection.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -Collection result = await databases.getCollection( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/get-document.md b/docs/examples/1.6.x/server-dart/examples/databases/get-document.md deleted file mode 100644 index 1af05af08f..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/get-document.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Databases databases = Databases(client); - -Document result = await databases.getDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>', - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/get-index.md b/docs/examples/1.6.x/server-dart/examples/databases/get-index.md deleted file mode 100644 index 634d5e1407..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/get-index.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -Index result = await databases.getIndex( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/get.md b/docs/examples/1.6.x/server-dart/examples/databases/get.md deleted file mode 100644 index e2bd07899e..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -Database result = await databases.get( - databaseId: '<DATABASE_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-dart/examples/databases/list-attributes.md deleted file mode 100644 index a36d4a3912..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/list-attributes.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeList result = await databases.listAttributes( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/list-collections.md b/docs/examples/1.6.x/server-dart/examples/databases/list-collections.md deleted file mode 100644 index 5d34294848..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/list-collections.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -CollectionList result = await databases.listCollections( - databaseId: '<DATABASE_ID>', - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/list-documents.md b/docs/examples/1.6.x/server-dart/examples/databases/list-documents.md deleted file mode 100644 index 91df920f54..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/list-documents.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Databases databases = Databases(client); - -DocumentList result = await databases.listDocuments( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-dart/examples/databases/list-indexes.md deleted file mode 100644 index c45e542c12..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/list-indexes.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -IndexList result = await databases.listIndexes( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/list.md b/docs/examples/1.6.x/server-dart/examples/databases/list.md deleted file mode 100644 index 674994c669..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/list.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -DatabaseList result = await databases.list( - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-boolean-attribute.md deleted file mode 100644 index 8654edd0dd..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeBoolean result = await databases.updateBooleanAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - xdefault: false, -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-collection.md b/docs/examples/1.6.x/server-dart/examples/databases/update-collection.md deleted file mode 100644 index 8af12c2e09..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-collection.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -Collection result = await databases.updateCollection( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - name: '<NAME>', - permissions: ["read("any")"], // (optional) - documentSecurity: false, // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-datetime-attribute.md deleted file mode 100644 index 6a91f4d624..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeDatetime result = await databases.updateDatetimeAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - xdefault: '', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-document.md b/docs/examples/1.6.x/server-dart/examples/databases/update-document.md deleted file mode 100644 index d4c442bd5e..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Databases databases = Databases(client); - -Document result = await databases.updateDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>', - data: {}, // (optional) - permissions: ["read("any")"], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-email-attribute.md deleted file mode 100644 index 1d2b0f8302..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeEmail result = await databases.updateEmailAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - xdefault: 'email@example.com', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-enum-attribute.md deleted file mode 100644 index e37cd64b2d..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeEnum result = await databases.updateEnumAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - elements: [], - xrequired: false, - xdefault: '<DEFAULT>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-float-attribute.md deleted file mode 100644 index fd4f56b0b5..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeFloat result = await databases.updateFloatAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - min: 0, - max: 0, - xdefault: 0, -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-integer-attribute.md deleted file mode 100644 index 5fa3a7c974..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeInteger result = await databases.updateIntegerAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - min: 0, - max: 0, - xdefault: 0, -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-ip-attribute.md deleted file mode 100644 index 31a3045159..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeIp result = await databases.updateIpAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - xdefault: '', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-relationship-attribute.md deleted file mode 100644 index 7bb811720f..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeRelationship result = await databases.updateRelationshipAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - onDelete: RelationMutate.cascade, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-string-attribute.md deleted file mode 100644 index 72519d8ad0..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeString result = await databases.updateStringAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - xdefault: '<DEFAULT>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-dart/examples/databases/update-url-attribute.md deleted file mode 100644 index cb9959dc1b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -AttributeUrl result = await databases.updateUrlAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - xrequired: false, - xdefault: 'https://example.com', -); diff --git a/docs/examples/1.6.x/server-dart/examples/databases/update.md b/docs/examples/1.6.x/server-dart/examples/databases/update.md deleted file mode 100644 index 403c21dfb4..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/databases/update.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Databases databases = Databases(client); - -Database result = await databases.update( - databaseId: '<DATABASE_ID>', - name: '<NAME>', - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/create-build.md b/docs/examples/1.6.x/server-dart/examples/functions/create-build.md deleted file mode 100644 index 11f927d04e..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/create-build.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - - result = await functions.createBuild( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>', - buildId: '<BUILD_ID>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-dart/examples/functions/create-deployment.md deleted file mode 100644 index 2900c45901..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/create-deployment.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -Deployment result = await functions.createDeployment( - functionId: '<FUNCTION_ID>', - code: InputFile(path: './path-to-files/image.jpg', filename: 'image.jpg'), - activate: false, - entrypoint: '<ENTRYPOINT>', // (optional) - commands: '<COMMANDS>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/create-execution.md b/docs/examples/1.6.x/server-dart/examples/functions/create-execution.md deleted file mode 100644 index 4ff0835b3b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/create-execution.md +++ /dev/null @@ -1,18 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Functions functions = Functions(client); - -Execution result = await functions.createExecution( - functionId: '<FUNCTION_ID>', - body: '<BODY>', // (optional) - xasync: false, // (optional) - path: '<PATH>', // (optional) - method: ExecutionMethod.gET, // (optional) - headers: {}, // (optional) - scheduledAt: '', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/create-variable.md b/docs/examples/1.6.x/server-dart/examples/functions/create-variable.md deleted file mode 100644 index 51250999e8..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/create-variable.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -Variable result = await functions.createVariable( - functionId: '<FUNCTION_ID>', - key: '<KEY>', - value: '<VALUE>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/create.md b/docs/examples/1.6.x/server-dart/examples/functions/create.md deleted file mode 100644 index 8991cbca5c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/create.md +++ /dev/null @@ -1,32 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -Func result = await functions.create( - functionId: '<FUNCTION_ID>', - name: '<NAME>', - runtime: .node145, - execute: ["any"], // (optional) - events: [], // (optional) - schedule: '', // (optional) - timeout: 1, // (optional) - enabled: false, // (optional) - logging: false, // (optional) - entrypoint: '<ENTRYPOINT>', // (optional) - commands: '<COMMANDS>', // (optional) - scopes: [], // (optional) - installationId: '<INSTALLATION_ID>', // (optional) - providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // (optional) - providerBranch: '<PROVIDER_BRANCH>', // (optional) - providerSilentMode: false, // (optional) - providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // (optional) - templateRepository: '<TEMPLATE_REPOSITORY>', // (optional) - templateOwner: '<TEMPLATE_OWNER>', // (optional) - templateRootDirectory: '<TEMPLATE_ROOT_DIRECTORY>', // (optional) - templateBranch: '<TEMPLATE_BRANCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-dart/examples/functions/delete-deployment.md deleted file mode 100644 index b67a598806..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/delete-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -await functions.deleteDeployment( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-dart/examples/functions/delete-execution.md deleted file mode 100644 index a976cc6dec..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/delete-execution.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -await functions.deleteExecution( - functionId: '<FUNCTION_ID>', - executionId: '<EXECUTION_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-dart/examples/functions/delete-variable.md deleted file mode 100644 index 38779c6609..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/delete-variable.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -await functions.deleteVariable( - functionId: '<FUNCTION_ID>', - variableId: '<VARIABLE_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/delete.md b/docs/examples/1.6.x/server-dart/examples/functions/delete.md deleted file mode 100644 index 2f73b8196b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -await functions.delete( - functionId: '<FUNCTION_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-dart/examples/functions/download-deployment.md deleted file mode 100644 index e5d5de36a8..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/download-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -UInt8List result = await functions.downloadDeployment( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-dart/examples/functions/get-deployment.md deleted file mode 100644 index 69f9bb0422..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/get-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -Deployment result = await functions.getDeployment( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/get-execution.md b/docs/examples/1.6.x/server-dart/examples/functions/get-execution.md deleted file mode 100644 index 3348df992f..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/get-execution.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Functions functions = Functions(client); - -Execution result = await functions.getExecution( - functionId: '<FUNCTION_ID>', - executionId: '<EXECUTION_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/get-variable.md b/docs/examples/1.6.x/server-dart/examples/functions/get-variable.md deleted file mode 100644 index 98c28c331d..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/get-variable.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -Variable result = await functions.getVariable( - functionId: '<FUNCTION_ID>', - variableId: '<VARIABLE_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/get.md b/docs/examples/1.6.x/server-dart/examples/functions/get.md deleted file mode 100644 index 9072f1f641..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -Func result = await functions.get( - functionId: '<FUNCTION_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-dart/examples/functions/list-deployments.md deleted file mode 100644 index 613c55db2e..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/list-deployments.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -DeploymentList result = await functions.listDeployments( - functionId: '<FUNCTION_ID>', - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/list-executions.md b/docs/examples/1.6.x/server-dart/examples/functions/list-executions.md deleted file mode 100644 index 13a3a46333..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/list-executions.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Functions functions = Functions(client); - -ExecutionList result = await functions.listExecutions( - functionId: '<FUNCTION_ID>', - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-dart/examples/functions/list-runtimes.md deleted file mode 100644 index e5dbabc896..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/list-runtimes.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -RuntimeList result = await functions.listRuntimes(); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/list-variables.md b/docs/examples/1.6.x/server-dart/examples/functions/list-variables.md deleted file mode 100644 index bb3f780b28..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/list-variables.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -VariableList result = await functions.listVariables( - functionId: '<FUNCTION_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/list.md b/docs/examples/1.6.x/server-dart/examples/functions/list.md deleted file mode 100644 index e4cf5ad78c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/list.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -FunctionList result = await functions.list( - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-dart/examples/functions/update-deployment-build.md deleted file mode 100644 index 955fcf857c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -Build result = await functions.updateDeploymentBuild( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-dart/examples/functions/update-deployment.md deleted file mode 100644 index 5ae6dd955b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/update-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -Func result = await functions.updateDeployment( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/update-variable.md b/docs/examples/1.6.x/server-dart/examples/functions/update-variable.md deleted file mode 100644 index eafc5528b8..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/update-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -Variable result = await functions.updateVariable( - functionId: '<FUNCTION_ID>', - variableId: '<VARIABLE_ID>', - key: '<KEY>', - value: '<VALUE>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/functions/update.md b/docs/examples/1.6.x/server-dart/examples/functions/update.md deleted file mode 100644 index 075763333b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/functions/update.md +++ /dev/null @@ -1,28 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Functions functions = Functions(client); - -Func result = await functions.update( - functionId: '<FUNCTION_ID>', - name: '<NAME>', - runtime: .node145, // (optional) - execute: ["any"], // (optional) - events: [], // (optional) - schedule: '', // (optional) - timeout: 1, // (optional) - enabled: false, // (optional) - logging: false, // (optional) - entrypoint: '<ENTRYPOINT>', // (optional) - commands: '<COMMANDS>', // (optional) - scopes: [], // (optional) - installationId: '<INSTALLATION_ID>', // (optional) - providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // (optional) - providerBranch: '<PROVIDER_BRANCH>', // (optional) - providerSilentMode: false, // (optional) - providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/graphql/mutation.md b/docs/examples/1.6.x/server-dart/examples/graphql/mutation.md deleted file mode 100644 index e29dce1af9..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/graphql/mutation.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Graphql graphql = Graphql(client); - -Any result = await graphql.mutation( - query: {}, -); diff --git a/docs/examples/1.6.x/server-dart/examples/graphql/query.md b/docs/examples/1.6.x/server-dart/examples/graphql/query.md deleted file mode 100644 index 808176e88d..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/graphql/query.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Graphql graphql = Graphql(client); - -Any result = await graphql.query( - query: {}, -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-dart/examples/health/get-antivirus.md deleted file mode 100644 index e5867032b4..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-antivirus.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthAntivirus result = await health.getAntivirus(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-cache.md b/docs/examples/1.6.x/server-dart/examples/health/get-cache.md deleted file mode 100644 index 04a316da51..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-cache.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthStatus result = await health.getCache(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-certificate.md b/docs/examples/1.6.x/server-dart/examples/health/get-certificate.md deleted file mode 100644 index 4faf20df5c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-certificate.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthCertificate result = await health.getCertificate( - domain: '', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-d-b.md b/docs/examples/1.6.x/server-dart/examples/health/get-d-b.md deleted file mode 100644 index 2750e695b3..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-d-b.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthStatus result = await health.getDB(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-dart/examples/health/get-failed-jobs.md deleted file mode 100644 index 3d4e2b7559..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getFailedJobs( - name: .v1Database, - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-dart/examples/health/get-pub-sub.md deleted file mode 100644 index eeac613b80..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-pub-sub.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthStatus result = await health.getPubSub(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-builds.md deleted file mode 100644 index e234bba6f1..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-builds.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueBuilds( - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-certificates.md deleted file mode 100644 index 1de734af76..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueCertificates( - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-databases.md deleted file mode 100644 index ba62b5ec64..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-databases.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueDatabases( - name: '<NAME>', // (optional) - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-deletes.md deleted file mode 100644 index f5dc69727c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueDeletes( - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-functions.md deleted file mode 100644 index febdbee581..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-functions.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueFunctions( - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-logs.md deleted file mode 100644 index de4e3e6ac4..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-logs.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueLogs( - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-mails.md deleted file mode 100644 index 52ed24dd7e..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-mails.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueMails( - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-messaging.md deleted file mode 100644 index 62d5aa73be..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueMessaging( - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-migrations.md deleted file mode 100644 index 97ee00ea6e..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueMigrations( - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage-dump.md deleted file mode 100644 index bd40162940..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueUsageDump( - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage.md deleted file mode 100644 index 126e16a732..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-usage.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueUsage( - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue-webhooks.md deleted file mode 100644 index cff783564b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthQueue result = await health.getQueueWebhooks( - threshold: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-queue.md b/docs/examples/1.6.x/server-dart/examples/health/get-queue.md deleted file mode 100644 index c856504af4..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-queue.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthStatus result = await health.getQueue(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-dart/examples/health/get-storage-local.md deleted file mode 100644 index 421ebe9822..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-storage-local.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthStatus result = await health.getStorageLocal(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-storage.md b/docs/examples/1.6.x/server-dart/examples/health/get-storage.md deleted file mode 100644 index bcbec9c652..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-storage.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthStatus result = await health.getStorage(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get-time.md b/docs/examples/1.6.x/server-dart/examples/health/get-time.md deleted file mode 100644 index a68ec49156..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get-time.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthTime result = await health.getTime(); diff --git a/docs/examples/1.6.x/server-dart/examples/health/get.md b/docs/examples/1.6.x/server-dart/examples/health/get.md deleted file mode 100644 index 6288d666ee..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/health/get.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Health health = Health(client); - -HealthStatus result = await health.get(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/get.md b/docs/examples/1.6.x/server-dart/examples/locale/get.md deleted file mode 100644 index acc3c4dd1c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/locale/get.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Locale locale = Locale(client); - -Locale result = await locale.get(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-codes.md b/docs/examples/1.6.x/server-dart/examples/locale/list-codes.md deleted file mode 100644 index 9e7420284c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/locale/list-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Locale locale = Locale(client); - -LocaleCodeList result = await locale.listCodes(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-continents.md b/docs/examples/1.6.x/server-dart/examples/locale/list-continents.md deleted file mode 100644 index 3320937649..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/locale/list-continents.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Locale locale = Locale(client); - -ContinentList result = await locale.listContinents(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-dart/examples/locale/list-countries-e-u.md deleted file mode 100644 index 9a66b08158..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Locale locale = Locale(client); - -CountryList result = await locale.listCountriesEU(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-dart/examples/locale/list-countries-phones.md deleted file mode 100644 index 35098e0ff3..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Locale locale = Locale(client); - -PhoneList result = await locale.listCountriesPhones(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-countries.md b/docs/examples/1.6.x/server-dart/examples/locale/list-countries.md deleted file mode 100644 index d11b4c42b5..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/locale/list-countries.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Locale locale = Locale(client); - -CountryList result = await locale.listCountries(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-dart/examples/locale/list-currencies.md deleted file mode 100644 index 4701ce9a81..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/locale/list-currencies.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Locale locale = Locale(client); - -CurrencyList result = await locale.listCurrencies(); diff --git a/docs/examples/1.6.x/server-dart/examples/locale/list-languages.md b/docs/examples/1.6.x/server-dart/examples/locale/list-languages.md deleted file mode 100644 index e5d52b3ee8..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/locale/list-languages.md +++ /dev/null @@ -1,10 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Locale locale = Locale(client); - -LanguageList result = await locale.listLanguages(); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-apns-provider.md deleted file mode 100644 index db7672ddc7..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.createApnsProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - authKey: '<AUTH_KEY>', // (optional) - authKeyId: '<AUTH_KEY_ID>', // (optional) - teamId: '<TEAM_ID>', // (optional) - bundleId: '<BUNDLE_ID>', // (optional) - sandbox: false, // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-email.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-email.md deleted file mode 100644 index 26fda3eeab..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-email.md +++ /dev/null @@ -1,23 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Message result = await messaging.createEmail( - messageId: '<MESSAGE_ID>', - subject: '<SUBJECT>', - content: '<CONTENT>', - topics: [], // (optional) - users: [], // (optional) - targets: [], // (optional) - cc: [], // (optional) - bcc: [], // (optional) - attachments: [], // (optional) - draft: false, // (optional) - html: false, // (optional) - scheduledAt: '', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-fcm-provider.md deleted file mode 100644 index f02b5b6df7..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.createFcmProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - serviceAccountJSON: {}, // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index 4161d5263c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.createMailgunProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - apiKey: '<API_KEY>', // (optional) - domain: '<DOMAIN>', // (optional) - isEuRegion: false, // (optional) - fromName: '<FROM_NAME>', // (optional) - fromEmail: 'email@example.com', // (optional) - replyToName: '<REPLY_TO_NAME>', // (optional) - replyToEmail: 'email@example.com', // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-msg91provider.md deleted file mode 100644 index ed8b24b6a5..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.createMsg91Provider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - templateId: '<TEMPLATE_ID>', // (optional) - senderId: '<SENDER_ID>', // (optional) - authKey: '<AUTH_KEY>', // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-push.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-push.md deleted file mode 100644 index 3e6f5ac4c7..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-push.md +++ /dev/null @@ -1,27 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Message result = await messaging.createPush( - messageId: '<MESSAGE_ID>', - title: '<TITLE>', - body: '<BODY>', - topics: [], // (optional) - users: [], // (optional) - targets: [], // (optional) - data: {}, // (optional) - action: '<ACTION>', // (optional) - image: '[ID1:ID2]', // (optional) - icon: '<ICON>', // (optional) - sound: '<SOUND>', // (optional) - color: '<COLOR>', // (optional) - tag: '<TAG>', // (optional) - badge: '<BADGE>', // (optional) - draft: false, // (optional) - scheduledAt: '', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index 9bf683cd9e..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.createSendgridProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - apiKey: '<API_KEY>', // (optional) - fromName: '<FROM_NAME>', // (optional) - fromEmail: 'email@example.com', // (optional) - replyToName: '<REPLY_TO_NAME>', // (optional) - replyToEmail: 'email@example.com', // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-sms.md deleted file mode 100644 index 7c4bdb84c4..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-sms.md +++ /dev/null @@ -1,18 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Message result = await messaging.createSms( - messageId: '<MESSAGE_ID>', - content: '<CONTENT>', - topics: [], // (optional) - users: [], // (optional) - targets: [], // (optional) - draft: false, // (optional) - scheduledAt: '', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-smtp-provider.md deleted file mode 100644 index 3125fbe685..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,25 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.createSmtpProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - host: '<HOST>', - port: 1, // (optional) - username: '<USERNAME>', // (optional) - password: '<PASSWORD>', // (optional) - encryption: SmtpEncryption.none, // (optional) - autoTLS: false, // (optional) - mailer: '<MAILER>', // (optional) - fromName: '<FROM_NAME>', // (optional) - fromEmail: 'email@example.com', // (optional) - replyToName: '<REPLY_TO_NAME>', // (optional) - replyToEmail: 'email@example.com', // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-subscriber.md deleted file mode 100644 index ff5291c940..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token - -Messaging messaging = Messaging(client); - -Subscriber result = await messaging.createSubscriber( - topicId: '<TOPIC_ID>', - subscriberId: '<SUBSCRIBER_ID>', - targetId: '<TARGET_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-telesign-provider.md deleted file mode 100644 index dd66f12ac3..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.createTelesignProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', // (optional) - customerId: '<CUSTOMER_ID>', // (optional) - apiKey: '<API_KEY>', // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index 0c4f9ea774..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.createTextmagicProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', // (optional) - username: '<USERNAME>', // (optional) - apiKey: '<API_KEY>', // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-topic.md deleted file mode 100644 index 8cadab11af..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Topic result = await messaging.createTopic( - topicId: '<TOPIC_ID>', - name: '<NAME>', - subscribe: ["any"], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-twilio-provider.md deleted file mode 100644 index 625cd5fcd0..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.createTwilioProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', // (optional) - accountSid: '<ACCOUNT_SID>', // (optional) - authToken: '<AUTH_TOKEN>', // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/create-vonage-provider.md deleted file mode 100644 index 5b80c50c1c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.createVonageProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', // (optional) - apiKey: '<API_KEY>', // (optional) - apiSecret: '<API_SECRET>', // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/delete-provider.md deleted file mode 100644 index 927ae2bfae..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/delete-provider.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -await messaging.deleteProvider( - providerId: '<PROVIDER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-dart/examples/messaging/delete-subscriber.md deleted file mode 100644 index 7b2b833d01..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token - -Messaging messaging = Messaging(client); - -await messaging.deleteSubscriber( - topicId: '<TOPIC_ID>', - subscriberId: '<SUBSCRIBER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-dart/examples/messaging/delete-topic.md deleted file mode 100644 index 4947637a94..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/delete-topic.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -await messaging.deleteTopic( - topicId: '<TOPIC_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/delete.md b/docs/examples/1.6.x/server-dart/examples/messaging/delete.md deleted file mode 100644 index 743a4b629f..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -await messaging.delete( - messageId: '<MESSAGE_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/get-message.md b/docs/examples/1.6.x/server-dart/examples/messaging/get-message.md deleted file mode 100644 index 987f0f7a1c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/get-message.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Message result = await messaging.getMessage( - messageId: '<MESSAGE_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/get-provider.md deleted file mode 100644 index 1154897d81..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/get-provider.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.getProvider( - providerId: '<PROVIDER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-dart/examples/messaging/get-subscriber.md deleted file mode 100644 index 358a6d0ea0..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Subscriber result = await messaging.getSubscriber( - topicId: '<TOPIC_ID>', - subscriberId: '<SUBSCRIBER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-dart/examples/messaging/get-topic.md deleted file mode 100644 index 28d79fbb99..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/get-topic.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Topic result = await messaging.getTopic( - topicId: '<TOPIC_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-message-logs.md deleted file mode 100644 index 5c9ec2ec93..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -LogList result = await messaging.listMessageLogs( - messageId: '<MESSAGE_ID>', - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-messages.md deleted file mode 100644 index d99f21ffa6..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/list-messages.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -MessageList result = await messaging.listMessages( - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-provider-logs.md deleted file mode 100644 index acabb4eb15..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -LogList result = await messaging.listProviderLogs( - providerId: '<PROVIDER_ID>', - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-providers.md deleted file mode 100644 index d8e076681d..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/list-providers.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -ProviderList result = await messaging.listProviders( - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index bf25d498fe..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -LogList result = await messaging.listSubscriberLogs( - subscriberId: '<SUBSCRIBER_ID>', - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-subscribers.md deleted file mode 100644 index ec3b078397..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -SubscriberList result = await messaging.listSubscribers( - topicId: '<TOPIC_ID>', - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-targets.md deleted file mode 100644 index 278272b45f..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/list-targets.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -TargetList result = await messaging.listTargets( - messageId: '<MESSAGE_ID>', - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-topic-logs.md deleted file mode 100644 index 85d054061d..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -LogList result = await messaging.listTopicLogs( - topicId: '<TOPIC_ID>', - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-dart/examples/messaging/list-topics.md deleted file mode 100644 index 425b2979ea..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/list-topics.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -TopicList result = await messaging.listTopics( - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-apns-provider.md deleted file mode 100644 index 0920513373..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.updateApnsProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // (optional) - enabled: false, // (optional) - authKey: '<AUTH_KEY>', // (optional) - authKeyId: '<AUTH_KEY_ID>', // (optional) - teamId: '<TEAM_ID>', // (optional) - bundleId: '<BUNDLE_ID>', // (optional) - sandbox: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-email.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-email.md deleted file mode 100644 index 3fdebac380..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-email.md +++ /dev/null @@ -1,23 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Message result = await messaging.updateEmail( - messageId: '<MESSAGE_ID>', - topics: [], // (optional) - users: [], // (optional) - targets: [], // (optional) - subject: '<SUBJECT>', // (optional) - content: '<CONTENT>', // (optional) - draft: false, // (optional) - html: false, // (optional) - cc: [], // (optional) - bcc: [], // (optional) - scheduledAt: '', // (optional) - attachments: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-fcm-provider.md deleted file mode 100644 index 9404d5951b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.updateFcmProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // (optional) - enabled: false, // (optional) - serviceAccountJSON: {}, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index be806274ea..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.updateMailgunProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // (optional) - apiKey: '<API_KEY>', // (optional) - domain: '<DOMAIN>', // (optional) - isEuRegion: false, // (optional) - enabled: false, // (optional) - fromName: '<FROM_NAME>', // (optional) - fromEmail: 'email@example.com', // (optional) - replyToName: '<REPLY_TO_NAME>', // (optional) - replyToEmail: '<REPLY_TO_EMAIL>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-msg91provider.md deleted file mode 100644 index 4c86428c43..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.updateMsg91Provider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // (optional) - enabled: false, // (optional) - templateId: '<TEMPLATE_ID>', // (optional) - senderId: '<SENDER_ID>', // (optional) - authKey: '<AUTH_KEY>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-push.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-push.md deleted file mode 100644 index fee14c76e3..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-push.md +++ /dev/null @@ -1,27 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Message result = await messaging.updatePush( - messageId: '<MESSAGE_ID>', - topics: [], // (optional) - users: [], // (optional) - targets: [], // (optional) - title: '<TITLE>', // (optional) - body: '<BODY>', // (optional) - data: {}, // (optional) - action: '<ACTION>', // (optional) - image: '[ID1:ID2]', // (optional) - icon: '<ICON>', // (optional) - sound: '<SOUND>', // (optional) - color: '<COLOR>', // (optional) - tag: '<TAG>', // (optional) - badge: 0, // (optional) - draft: false, // (optional) - scheduledAt: '', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index 7a762a66b5..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.updateSendgridProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // (optional) - enabled: false, // (optional) - apiKey: '<API_KEY>', // (optional) - fromName: '<FROM_NAME>', // (optional) - fromEmail: 'email@example.com', // (optional) - replyToName: '<REPLY_TO_NAME>', // (optional) - replyToEmail: '<REPLY_TO_EMAIL>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-sms.md deleted file mode 100644 index 4eda4c51c0..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-sms.md +++ /dev/null @@ -1,18 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Message result = await messaging.updateSms( - messageId: '<MESSAGE_ID>', - topics: [], // (optional) - users: [], // (optional) - targets: [], // (optional) - content: '<CONTENT>', // (optional) - draft: false, // (optional) - scheduledAt: '', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-smtp-provider.md deleted file mode 100644 index f0b53d23c4..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,25 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.updateSmtpProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // (optional) - host: '<HOST>', // (optional) - port: 1, // (optional) - username: '<USERNAME>', // (optional) - password: '<PASSWORD>', // (optional) - encryption: SmtpEncryption.none, // (optional) - autoTLS: false, // (optional) - mailer: '<MAILER>', // (optional) - fromName: '<FROM_NAME>', // (optional) - fromEmail: 'email@example.com', // (optional) - replyToName: '<REPLY_TO_NAME>', // (optional) - replyToEmail: '<REPLY_TO_EMAIL>', // (optional) - enabled: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-telesign-provider.md deleted file mode 100644 index 6465a68d90..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.updateTelesignProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // (optional) - enabled: false, // (optional) - customerId: '<CUSTOMER_ID>', // (optional) - apiKey: '<API_KEY>', // (optional) - from: '<FROM>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index 4f030e7087..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.updateTextmagicProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // (optional) - enabled: false, // (optional) - username: '<USERNAME>', // (optional) - apiKey: '<API_KEY>', // (optional) - from: '<FROM>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-topic.md deleted file mode 100644 index ba4289ae59..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Topic result = await messaging.updateTopic( - topicId: '<TOPIC_ID>', - name: '<NAME>', // (optional) - subscribe: ["any"], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-twilio-provider.md deleted file mode 100644 index b0c6d976ec..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.updateTwilioProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // (optional) - enabled: false, // (optional) - accountSid: '<ACCOUNT_SID>', // (optional) - authToken: '<AUTH_TOKEN>', // (optional) - from: '<FROM>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-dart/examples/messaging/update-vonage-provider.md deleted file mode 100644 index 0171ec154f..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Messaging messaging = Messaging(client); - -Provider result = await messaging.updateVonageProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // (optional) - enabled: false, // (optional) - apiKey: '<API_KEY>', // (optional) - apiSecret: '<API_SECRET>', // (optional) - from: '<FROM>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-dart/examples/storage/create-bucket.md deleted file mode 100644 index eb8abbd76c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/create-bucket.md +++ /dev/null @@ -1,21 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Storage storage = Storage(client); - -Bucket result = await storage.createBucket( - bucketId: '<BUCKET_ID>', - name: '<NAME>', - permissions: ["read("any")"], // (optional) - fileSecurity: false, // (optional) - enabled: false, // (optional) - maximumFileSize: 1, // (optional) - allowedFileExtensions: [], // (optional) - compression: .none, // (optional) - encryption: false, // (optional) - antivirus: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/create-file.md b/docs/examples/1.6.x/server-dart/examples/storage/create-file.md deleted file mode 100644 index 7f08a98417..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/create-file.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'dart:io'; -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Storage storage = Storage(client); - -File result = await storage.createFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', - file: InputFile(path: './path-to-files/image.jpg', filename: 'image.jpg'), - permissions: ["read("any")"], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-dart/examples/storage/delete-bucket.md deleted file mode 100644 index 07ec35c999..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/delete-bucket.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Storage storage = Storage(client); - -await storage.deleteBucket( - bucketId: '<BUCKET_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/delete-file.md b/docs/examples/1.6.x/server-dart/examples/storage/delete-file.md deleted file mode 100644 index fddfd66711..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/delete-file.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Storage storage = Storage(client); - -await storage.deleteFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-dart/examples/storage/get-bucket.md deleted file mode 100644 index 2b4ec732c1..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/get-bucket.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Storage storage = Storage(client); - -Bucket result = await storage.getBucket( - bucketId: '<BUCKET_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-dart/examples/storage/get-file-download.md deleted file mode 100644 index de30bf50d7..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/get-file-download.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Storage storage = Storage(client); - -UInt8List result = await storage.getFileDownload( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-dart/examples/storage/get-file-preview.md deleted file mode 100644 index f36af81b23..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/get-file-preview.md +++ /dev/null @@ -1,24 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Storage storage = Storage(client); - -UInt8List result = await storage.getFilePreview( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', - width: 0, // (optional) - height: 0, // (optional) - gravity: ImageGravity.center, // (optional) - quality: 0, // (optional) - borderWidth: 0, // (optional) - borderColor: '', // (optional) - borderRadius: 0, // (optional) - opacity: 0, // (optional) - rotation: -360, // (optional) - background: '', // (optional) - output: ImageFormat.jpg, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-dart/examples/storage/get-file-view.md deleted file mode 100644 index ad64c168a0..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/get-file-view.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Storage storage = Storage(client); - -UInt8List result = await storage.getFileView( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/get-file.md b/docs/examples/1.6.x/server-dart/examples/storage/get-file.md deleted file mode 100644 index 3255043228..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/get-file.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Storage storage = Storage(client); - -File result = await storage.getFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-dart/examples/storage/list-buckets.md deleted file mode 100644 index 1f5040a77d..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/list-buckets.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Storage storage = Storage(client); - -BucketList result = await storage.listBuckets( - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/list-files.md b/docs/examples/1.6.x/server-dart/examples/storage/list-files.md deleted file mode 100644 index b5a1261d78..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/list-files.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Storage storage = Storage(client); - -FileList result = await storage.listFiles( - bucketId: '<BUCKET_ID>', - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-dart/examples/storage/update-bucket.md deleted file mode 100644 index 04f76d041c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/update-bucket.md +++ /dev/null @@ -1,21 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Storage storage = Storage(client); - -Bucket result = await storage.updateBucket( - bucketId: '<BUCKET_ID>', - name: '<NAME>', - permissions: ["read("any")"], // (optional) - fileSecurity: false, // (optional) - enabled: false, // (optional) - maximumFileSize: 1, // (optional) - allowedFileExtensions: [], // (optional) - compression: .none, // (optional) - encryption: false, // (optional) - antivirus: false, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/storage/update-file.md b/docs/examples/1.6.x/server-dart/examples/storage/update-file.md deleted file mode 100644 index 5ddabb9857..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/storage/update-file.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Storage storage = Storage(client); - -File result = await storage.updateFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', - name: '<NAME>', // (optional) - permissions: ["read("any")"], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/create-membership.md b/docs/examples/1.6.x/server-dart/examples/teams/create-membership.md deleted file mode 100644 index 1faf629af5..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/create-membership.md +++ /dev/null @@ -1,18 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -Membership result = await teams.createMembership( - teamId: '<TEAM_ID>', - roles: [], - email: 'email@example.com', // (optional) - userId: '<USER_ID>', // (optional) - phone: '+12065550100', // (optional) - url: 'https://example.com', // (optional) - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/create.md b/docs/examples/1.6.x/server-dart/examples/teams/create.md deleted file mode 100644 index 653d800458..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/create.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -Team result = await teams.create( - teamId: '<TEAM_ID>', - name: '<NAME>', - roles: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-dart/examples/teams/delete-membership.md deleted file mode 100644 index 15752a809c..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/delete-membership.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -await teams.deleteMembership( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/delete.md b/docs/examples/1.6.x/server-dart/examples/teams/delete.md deleted file mode 100644 index 7017893ce2..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -await teams.delete( - teamId: '<TEAM_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/get-membership.md b/docs/examples/1.6.x/server-dart/examples/teams/get-membership.md deleted file mode 100644 index 06a3fc141b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/get-membership.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -Membership result = await teams.getMembership( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-dart/examples/teams/get-prefs.md deleted file mode 100644 index 2af7475606..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -Preferences result = await teams.getPrefs( - teamId: '<TEAM_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/get.md b/docs/examples/1.6.x/server-dart/examples/teams/get.md deleted file mode 100644 index b086b06851..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -Team result = await teams.get( - teamId: '<TEAM_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-dart/examples/teams/list-memberships.md deleted file mode 100644 index 4cf83235c0..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/list-memberships.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -MembershipList result = await teams.listMemberships( - teamId: '<TEAM_ID>', - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/list.md b/docs/examples/1.6.x/server-dart/examples/teams/list.md deleted file mode 100644 index 51af7d3f56..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/list.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -TeamList result = await teams.list( - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-dart/examples/teams/update-membership-status.md deleted file mode 100644 index 9571193aa7..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/update-membership-status.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -Membership result = await teams.updateMembershipStatus( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>', - userId: '<USER_ID>', - secret: '<SECRET>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/update-membership.md b/docs/examples/1.6.x/server-dart/examples/teams/update-membership.md deleted file mode 100644 index fd2f4586e9..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/update-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -Membership result = await teams.updateMembership( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>', - roles: [], -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/update-name.md b/docs/examples/1.6.x/server-dart/examples/teams/update-name.md deleted file mode 100644 index b795063073..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -Team result = await teams.updateName( - teamId: '<TEAM_ID>', - name: '<NAME>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-dart/examples/teams/update-prefs.md deleted file mode 100644 index 434ffb9679..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/teams/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -Teams teams = Teams(client); - -Preferences result = await teams.updatePrefs( - teamId: '<TEAM_ID>', - prefs: {}, -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-dart/examples/users/create-argon2user.md deleted file mode 100644 index 6a3f552df1..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-argon2user.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.createArgon2User( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-dart/examples/users/create-bcrypt-user.md deleted file mode 100644 index d49f3b8ab6..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.createBcryptUser( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-dart/examples/users/create-j-w-t.md deleted file mode 100644 index 19fcf90b32..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-j-w-t.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -Jwt result = await users.createJWT( - userId: '<USER_ID>', - sessionId: '<SESSION_ID>', // (optional) - duration: 0, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-dart/examples/users/create-m-d5user.md deleted file mode 100644 index 43eeec651b..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-m-d5user.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.createMD5User( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index 80ff25b0d5..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -MfaRecoveryCodes result = await users.createMfaRecoveryCodes( - userId: '<USER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-dart/examples/users/create-p-h-pass-user.md deleted file mode 100644 index cf1b7991c0..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,15 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.createPHPassUser( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-dart/examples/users/create-s-h-a-user.md deleted file mode 100644 index a532afe4ad..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.createSHAUser( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - passwordVersion: PasswordHash.sha1, // (optional) - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index 0e7026b74e..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,18 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.createScryptModifiedUser( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - passwordSalt: '<PASSWORD_SALT>', - passwordSaltSeparator: '<PASSWORD_SALT_SEPARATOR>', - passwordSignerKey: '<PASSWORD_SIGNER_KEY>', - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-user.md deleted file mode 100644 index c785aa5867..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,20 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.createScryptUser( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - passwordSalt: '<PASSWORD_SALT>', - passwordCpu: 0, - passwordMemory: 0, - passwordParallel: 0, - passwordLength: 0, - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-session.md b/docs/examples/1.6.x/server-dart/examples/users/create-session.md deleted file mode 100644 index 6ae18a6242..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -Session result = await users.createSession( - userId: '<USER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-target.md b/docs/examples/1.6.x/server-dart/examples/users/create-target.md deleted file mode 100644 index d8ed9192cd..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-target.md +++ /dev/null @@ -1,17 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -Target result = await users.createTarget( - userId: '<USER_ID>', - targetId: '<TARGET_ID>', - providerType: MessagingProviderType.email, - identifier: '<IDENTIFIER>', - providerId: '<PROVIDER_ID>', // (optional) - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create-token.md b/docs/examples/1.6.x/server-dart/examples/users/create-token.md deleted file mode 100644 index 5eb25ea186..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -Token result = await users.createToken( - userId: '<USER_ID>', - length: 4, // (optional) - expire: 60, // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/create.md b/docs/examples/1.6.x/server-dart/examples/users/create.md deleted file mode 100644 index 5ae3a54ac5..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/create.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.create( - userId: '<USER_ID>', - email: 'email@example.com', // (optional) - phone: '+12065550100', // (optional) - password: '', // (optional) - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete-identity.md b/docs/examples/1.6.x/server-dart/examples/users/delete-identity.md deleted file mode 100644 index 8fbbb6d8db..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/delete-identity.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -await users.deleteIdentity( - identityId: '<IDENTITY_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-dart/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index e91ac5258a..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -await users.deleteMfaAuthenticator( - userId: '<USER_ID>', - type: AuthenticatorType.totp, -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete-session.md b/docs/examples/1.6.x/server-dart/examples/users/delete-session.md deleted file mode 100644 index bc5cc6a292..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/delete-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -await users.deleteSession( - userId: '<USER_ID>', - sessionId: '<SESSION_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-dart/examples/users/delete-sessions.md deleted file mode 100644 index 7ab20ac93a..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/delete-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -await users.deleteSessions( - userId: '<USER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete-target.md b/docs/examples/1.6.x/server-dart/examples/users/delete-target.md deleted file mode 100644 index f8196a3483..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/delete-target.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -await users.deleteTarget( - userId: '<USER_ID>', - targetId: '<TARGET_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/delete.md b/docs/examples/1.6.x/server-dart/examples/users/delete.md deleted file mode 100644 index 5cbca954f5..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -await users.delete( - userId: '<USER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index cd923d64e6..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -MfaRecoveryCodes result = await users.getMfaRecoveryCodes( - userId: '<USER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/get-prefs.md b/docs/examples/1.6.x/server-dart/examples/users/get-prefs.md deleted file mode 100644 index 2cf000189e..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -Preferences result = await users.getPrefs( - userId: '<USER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/get-target.md b/docs/examples/1.6.x/server-dart/examples/users/get-target.md deleted file mode 100644 index dbffb66be9..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/get-target.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -Target result = await users.getTarget( - userId: '<USER_ID>', - targetId: '<TARGET_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/get.md b/docs/examples/1.6.x/server-dart/examples/users/get.md deleted file mode 100644 index 3170b93f01..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.get( - userId: '<USER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-identities.md b/docs/examples/1.6.x/server-dart/examples/users/list-identities.md deleted file mode 100644 index e36dfd9fdd..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/list-identities.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -IdentityList result = await users.listIdentities( - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-logs.md b/docs/examples/1.6.x/server-dart/examples/users/list-logs.md deleted file mode 100644 index 53499537ab..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/list-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -LogList result = await users.listLogs( - userId: '<USER_ID>', - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-memberships.md b/docs/examples/1.6.x/server-dart/examples/users/list-memberships.md deleted file mode 100644 index d786a71c26..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/list-memberships.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -MembershipList result = await users.listMemberships( - userId: '<USER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-dart/examples/users/list-mfa-factors.md deleted file mode 100644 index ef8ae21987..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -MfaFactors result = await users.listMfaFactors( - userId: '<USER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-sessions.md b/docs/examples/1.6.x/server-dart/examples/users/list-sessions.md deleted file mode 100644 index 745fcd1fce..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/list-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -SessionList result = await users.listSessions( - userId: '<USER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list-targets.md b/docs/examples/1.6.x/server-dart/examples/users/list-targets.md deleted file mode 100644 index 632655f29d..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/list-targets.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -TargetList result = await users.listTargets( - userId: '<USER_ID>', - queries: [], // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/list.md b/docs/examples/1.6.x/server-dart/examples/users/list.md deleted file mode 100644 index b1bb2e90a5..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/list.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -UserList result = await users.list( - queries: [], // (optional) - search: '<SEARCH>', // (optional) -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-dart/examples/users/update-email-verification.md deleted file mode 100644 index 8f64780c81..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-email-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.updateEmailVerification( - userId: '<USER_ID>', - emailVerification: false, -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-email.md b/docs/examples/1.6.x/server-dart/examples/users/update-email.md deleted file mode 100644 index 9cdf699dbd..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-email.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.updateEmail( - userId: '<USER_ID>', - email: 'email@example.com', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-labels.md b/docs/examples/1.6.x/server-dart/examples/users/update-labels.md deleted file mode 100644 index fffebdab67..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-labels.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.updateLabels( - userId: '<USER_ID>', - labels: [], -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dart/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index a3604e4be3..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -MfaRecoveryCodes result = await users.updateMfaRecoveryCodes( - userId: '<USER_ID>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-mfa.md b/docs/examples/1.6.x/server-dart/examples/users/update-mfa.md deleted file mode 100644 index 403ff69b18..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-mfa.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.updateMfa( - userId: '<USER_ID>', - mfa: false, -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-name.md b/docs/examples/1.6.x/server-dart/examples/users/update-name.md deleted file mode 100644 index 12b9da86cb..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.updateName( - userId: '<USER_ID>', - name: '<NAME>', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-password.md b/docs/examples/1.6.x/server-dart/examples/users/update-password.md deleted file mode 100644 index 072ef7007d..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-password.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.updatePassword( - userId: '<USER_ID>', - password: '', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-dart/examples/users/update-phone-verification.md deleted file mode 100644 index 8ce9243509..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.updatePhoneVerification( - userId: '<USER_ID>', - phoneVerification: false, -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-phone.md b/docs/examples/1.6.x/server-dart/examples/users/update-phone.md deleted file mode 100644 index 30d73a4e75..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-phone.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.updatePhone( - userId: '<USER_ID>', - number: '+12065550100', -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-prefs.md b/docs/examples/1.6.x/server-dart/examples/users/update-prefs.md deleted file mode 100644 index ca36f10799..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -Preferences result = await users.updatePrefs( - userId: '<USER_ID>', - prefs: {}, -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-status.md b/docs/examples/1.6.x/server-dart/examples/users/update-status.md deleted file mode 100644 index 26288975dc..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-status.md +++ /dev/null @@ -1,13 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -User result = await users.updateStatus( - userId: '<USER_ID>', - status: false, -); diff --git a/docs/examples/1.6.x/server-dart/examples/users/update-target.md b/docs/examples/1.6.x/server-dart/examples/users/update-target.md deleted file mode 100644 index ae9036e120..0000000000 --- a/docs/examples/1.6.x/server-dart/examples/users/update-target.md +++ /dev/null @@ -1,16 +0,0 @@ -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -Users users = Users(client); - -Target result = await users.updateTarget( - userId: '<USER_ID>', - targetId: '<TARGET_ID>', - identifier: '<IDENTIFIER>', // (optional) - providerId: '<PROVIDER_ID>', // (optional) - name: '<NAME>', // (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-deno/examples/account/create-anonymous-session.md deleted file mode 100644 index 978d038248..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,9 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const response = await account.createAnonymousSession(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-deno/examples/account/create-email-password-session.md deleted file mode 100644 index 45ec40ded7..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-email-password-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const response = await account.createEmailPasswordSession( - 'email@example.com', // email - 'password' // password -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-email-token.md b/docs/examples/1.6.x/server-deno/examples/account/create-email-token.md deleted file mode 100644 index 475d0d0027..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-email-token.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const response = await account.createEmailToken( - '<USER_ID>', // userId - 'email@example.com', // email - false // phrase (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-deno/examples/account/create-j-w-t.md deleted file mode 100644 index a3e82bc631..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-j-w-t.md +++ /dev/null @@ -1,9 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const response = await account.createJWT(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-deno/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index daed66564c..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const response = await account.createMagicURLToken( - '<USER_ID>', // userId - 'email@example.com', // email - 'https://example.com', // url (optional) - false // phrase (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-deno/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 80e3fd3f74..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account, AuthenticatorType } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.createMfaAuthenticator( - AuthenticatorType.Totp // type -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-deno/examples/account/create-mfa-challenge.md deleted file mode 100644 index e19d2c841b..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,11 +0,0 @@ -import { Client, Account, AuthenticationFactor } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const response = await account.createMfaChallenge( - AuthenticationFactor.Email // factor -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index aa07a1933f..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.createMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-deno/examples/account/create-o-auth2token.md deleted file mode 100644 index cebae56721..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account, OAuthProvider } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -account.createOAuth2Token( - OAuthProvider.Amazon, // provider - 'https://example.com', // success (optional) - 'https://example.com', // failure (optional) - [] // scopes (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-deno/examples/account/create-phone-token.md deleted file mode 100644 index bf4e554456..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-phone-token.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const response = await account.createPhoneToken( - '<USER_ID>', // userId - '+12065550100' // phone -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-deno/examples/account/create-phone-verification.md deleted file mode 100644 index c130372025..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-phone-verification.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.createPhoneVerification(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-recovery.md b/docs/examples/1.6.x/server-deno/examples/account/create-recovery.md deleted file mode 100644 index 91d2772f92..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-recovery.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.createRecovery( - 'email@example.com', // email - 'https://example.com' // url -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-session.md b/docs/examples/1.6.x/server-deno/examples/account/create-session.md deleted file mode 100644 index a501f219d0..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const response = await account.createSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create-verification.md b/docs/examples/1.6.x/server-deno/examples/account/create-verification.md deleted file mode 100644 index 75c3058fab..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.createVerification( - 'https://example.com' // url -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/create.md b/docs/examples/1.6.x/server-deno/examples/account/create.md deleted file mode 100644 index 8cc745505e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/create.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const response = await account.create( - '<USER_ID>', // userId - 'email@example.com', // email - '', // password - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/delete-identity.md b/docs/examples/1.6.x/server-deno/examples/account/delete-identity.md deleted file mode 100644 index 3a08ca98aa..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/delete-identity.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.deleteIdentity( - '<IDENTITY_ID>' // identityId -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-deno/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 3fafb7efad..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account, AuthenticatorType } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.deleteMfaAuthenticator( - AuthenticatorType.Totp // type -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/delete-session.md b/docs/examples/1.6.x/server-deno/examples/account/delete-session.md deleted file mode 100644 index 2adec11ce3..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/delete-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.deleteSession( - '<SESSION_ID>' // sessionId -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-deno/examples/account/delete-sessions.md deleted file mode 100644 index daa325ce5e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/delete-sessions.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.deleteSessions(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index 8531ce7e33..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.getMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/get-prefs.md b/docs/examples/1.6.x/server-deno/examples/account/get-prefs.md deleted file mode 100644 index e174d04cbe..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/get-prefs.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.getPrefs(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/get-session.md b/docs/examples/1.6.x/server-deno/examples/account/get-session.md deleted file mode 100644 index d7e23b913c..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/get-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.getSession( - '<SESSION_ID>' // sessionId -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/get.md b/docs/examples/1.6.x/server-deno/examples/account/get.md deleted file mode 100644 index 922f34fe3a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/get.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.get(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/list-identities.md b/docs/examples/1.6.x/server-deno/examples/account/list-identities.md deleted file mode 100644 index ac175985c6..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/list-identities.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.listIdentities( - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/list-logs.md b/docs/examples/1.6.x/server-deno/examples/account/list-logs.md deleted file mode 100644 index ed2fac07c6..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/list-logs.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.listLogs( - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-deno/examples/account/list-mfa-factors.md deleted file mode 100644 index 2f4a9ab193..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.listMfaFactors(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/list-sessions.md b/docs/examples/1.6.x/server-deno/examples/account/list-sessions.md deleted file mode 100644 index 9c4fc28234..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/list-sessions.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.listSessions(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-email.md b/docs/examples/1.6.x/server-deno/examples/account/update-email.md deleted file mode 100644 index 9f30e53d3e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-email.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updateEmail( - 'email@example.com', // email - 'password' // password -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-deno/examples/account/update-m-f-a.md deleted file mode 100644 index dbfbeffdca..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-m-f-a.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updateMFA( - false // mfa -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-deno/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index cfec5bffc6..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const response = await account.updateMagicURLSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-deno/examples/account/update-mfa-authenticator.md deleted file mode 100644 index 6808d0db7f..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account, AuthenticatorType } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updateMfaAuthenticator( - AuthenticatorType.Totp, // type - '<OTP>' // otp -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-deno/examples/account/update-mfa-challenge.md deleted file mode 100644 index a0eef5efe6..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updateMfaChallenge( - '<CHALLENGE_ID>', // challengeId - '<OTP>' // otp -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index 97595cee58..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-name.md b/docs/examples/1.6.x/server-deno/examples/account/update-name.md deleted file mode 100644 index 2c8f1a635c..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-name.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updateName( - '<NAME>' // name -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-password.md b/docs/examples/1.6.x/server-deno/examples/account/update-password.md deleted file mode 100644 index 10193ae284..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-password.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updatePassword( - '', // password - 'password' // oldPassword (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-deno/examples/account/update-phone-session.md deleted file mode 100644 index 6dbc3401d6..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-phone-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new Account(client); - -const response = await account.updatePhoneSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-deno/examples/account/update-phone-verification.md deleted file mode 100644 index 25609772c4..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updatePhoneVerification( - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-phone.md b/docs/examples/1.6.x/server-deno/examples/account/update-phone.md deleted file mode 100644 index af827086d0..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-phone.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updatePhone( - '+12065550100', // phone - 'password' // password -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-prefs.md b/docs/examples/1.6.x/server-deno/examples/account/update-prefs.md deleted file mode 100644 index 13a166e370..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updatePrefs( - {} // prefs -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-recovery.md b/docs/examples/1.6.x/server-deno/examples/account/update-recovery.md deleted file mode 100644 index 9a3c2569d2..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updateRecovery( - '<USER_ID>', // userId - '<SECRET>', // secret - '' // password -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-session.md b/docs/examples/1.6.x/server-deno/examples/account/update-session.md deleted file mode 100644 index 77c149088a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updateSession( - '<SESSION_ID>' // sessionId -); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-status.md b/docs/examples/1.6.x/server-deno/examples/account/update-status.md deleted file mode 100644 index 6474704c53..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-status.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updateStatus(); diff --git a/docs/examples/1.6.x/server-deno/examples/account/update-verification.md b/docs/examples/1.6.x/server-deno/examples/account/update-verification.md deleted file mode 100644 index b5e2db640f..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/account/update-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Account } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new Account(client); - -const response = await account.updateVerification( - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-browser.md deleted file mode 100644 index 3eb6239c09..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/avatars/get-browser.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Avatars, Browser } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new Avatars(client); - -const result = avatars.getBrowser( - Browser.AvantBrowser, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-credit-card.md deleted file mode 100644 index f4a2efc3ac..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Avatars, CreditCard } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new Avatars(client); - -const result = avatars.getCreditCard( - CreditCard.AmericanExpress, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-favicon.md deleted file mode 100644 index 33830503a8..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/avatars/get-favicon.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Avatars } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new Avatars(client); - -const result = avatars.getFavicon( - 'https://example.com' // url -); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-flag.md deleted file mode 100644 index 0999748876..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/avatars/get-flag.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Avatars, Flag } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new Avatars(client); - -const result = avatars.getFlag( - Flag.Afghanistan, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-image.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-image.md deleted file mode 100644 index 63ddc95cf7..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/avatars/get-image.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Avatars } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new Avatars(client); - -const result = avatars.getImage( - 'https://example.com', // url - 0, // width (optional) - 0 // height (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-initials.md deleted file mode 100644 index 285d63700d..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/avatars/get-initials.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Avatars } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new Avatars(client); - -const result = avatars.getInitials( - '<NAME>', // name (optional) - 0, // width (optional) - 0, // height (optional) - '' // background (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-deno/examples/avatars/get-q-r.md deleted file mode 100644 index ab48003577..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/avatars/get-q-r.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Avatars } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new Avatars(client); - -const result = avatars.getQR( - '<TEXT>', // text - 1, // size (optional) - 0, // margin (optional) - false // download (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-boolean-attribute.md deleted file mode 100644 index 8b360ddd56..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createBooleanAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - false, // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-collection.md b/docs/examples/1.6.x/server-deno/examples/databases/create-collection.md deleted file mode 100644 index aef84aa328..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-collection.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // documentSecurity (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-datetime-attribute.md deleted file mode 100644 index aa541663c0..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createDatetimeAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '', // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-document.md b/docs/examples/1.6.x/server-deno/examples/databases/create-document.md deleted file mode 100644 index 65729e1671..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const databases = new Databases(client); - -const response = await databases.createDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - {}, // data - ["read("any")"] // permissions (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-email-attribute.md deleted file mode 100644 index 69e2fc4b4a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createEmailAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'email@example.com', // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-enum-attribute.md deleted file mode 100644 index 21736aa7a2..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createEnumAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - [], // elements - false, // required - '<DEFAULT>', // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-float-attribute.md deleted file mode 100644 index 376a9f154d..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createFloatAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min (optional) - null, // max (optional) - null, // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-index.md b/docs/examples/1.6.x/server-deno/examples/databases/create-index.md deleted file mode 100644 index dbf8558444..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-index.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases, IndexType } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createIndex( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - IndexType.Key, // type - [], // attributes - [] // orders (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-integer-attribute.md deleted file mode 100644 index 0958832172..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createIntegerAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min (optional) - null, // max (optional) - null, // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-ip-attribute.md deleted file mode 100644 index ecc9d7230e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createIpAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '', // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-relationship-attribute.md deleted file mode 100644 index 0f558968f2..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Databases, RelationshipType, RelationMutate } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createRelationshipAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<RELATED_COLLECTION_ID>', // relatedCollectionId - RelationshipType.OneToOne, // type - false, // twoWay (optional) - '', // key (optional) - '', // twoWayKey (optional) - RelationMutate.Cascade // onDelete (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-string-attribute.md deleted file mode 100644 index 88a96c2364..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createStringAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - 1, // size - false, // required - '<DEFAULT>', // default (optional) - false, // array (optional) - false // encrypt (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/create-url-attribute.md deleted file mode 100644 index c97230f827..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.createUrlAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'https://example.com', // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/create.md b/docs/examples/1.6.x/server-deno/examples/databases/create.md deleted file mode 100644 index 06872d6498..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/create.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.create( - '<DATABASE_ID>', // databaseId - '<NAME>', // name - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/delete-attribute.md deleted file mode 100644 index 51814cc913..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/delete-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.deleteAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-deno/examples/databases/delete-collection.md deleted file mode 100644 index 69d00d365b..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/delete-collection.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.deleteCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>' // collectionId -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/delete-document.md b/docs/examples/1.6.x/server-deno/examples/databases/delete-document.md deleted file mode 100644 index 1cd8d031bc..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/delete-document.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const databases = new Databases(client); - -const response = await databases.deleteDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>' // documentId -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/delete-index.md b/docs/examples/1.6.x/server-deno/examples/databases/delete-index.md deleted file mode 100644 index 760d7d4b05..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/delete-index.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.deleteIndex( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/delete.md b/docs/examples/1.6.x/server-deno/examples/databases/delete.md deleted file mode 100644 index d376565a2c..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.delete( - '<DATABASE_ID>' // databaseId -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/get-attribute.md deleted file mode 100644 index 31157f34e8..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/get-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.getAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/get-collection.md b/docs/examples/1.6.x/server-deno/examples/databases/get-collection.md deleted file mode 100644 index c59849c180..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/get-collection.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.getCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>' // collectionId -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/get-document.md b/docs/examples/1.6.x/server-deno/examples/databases/get-document.md deleted file mode 100644 index 3f53f8f228..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/get-document.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const databases = new Databases(client); - -const response = await databases.getDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/get-index.md b/docs/examples/1.6.x/server-deno/examples/databases/get-index.md deleted file mode 100644 index c99659014c..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/get-index.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.getIndex( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/get.md b/docs/examples/1.6.x/server-deno/examples/databases/get.md deleted file mode 100644 index 448e516cb0..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.get( - '<DATABASE_ID>' // databaseId -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-deno/examples/databases/list-attributes.md deleted file mode 100644 index ea1921d394..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/list-attributes.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.listAttributes( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/list-collections.md b/docs/examples/1.6.x/server-deno/examples/databases/list-collections.md deleted file mode 100644 index 46a8351676..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/list-collections.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.listCollections( - '<DATABASE_ID>', // databaseId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/list-documents.md b/docs/examples/1.6.x/server-deno/examples/databases/list-documents.md deleted file mode 100644 index 685a7d9c6a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/list-documents.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const databases = new Databases(client); - -const response = await databases.listDocuments( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-deno/examples/databases/list-indexes.md deleted file mode 100644 index 03e1837041..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/list-indexes.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.listIndexes( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/list.md b/docs/examples/1.6.x/server-deno/examples/databases/list.md deleted file mode 100644 index b6cfc71964..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/list.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-boolean-attribute.md deleted file mode 100644 index daee99dc56..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.updateBooleanAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - false // default -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-collection.md b/docs/examples/1.6.x/server-deno/examples/databases/update-collection.md deleted file mode 100644 index 9c1ac96583..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-collection.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.updateCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // documentSecurity (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-datetime-attribute.md deleted file mode 100644 index 7b4410d953..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.updateDatetimeAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '' // default -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-document.md b/docs/examples/1.6.x/server-deno/examples/databases/update-document.md deleted file mode 100644 index 000cc00c60..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const databases = new Databases(client); - -const response = await databases.updateDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - {}, // data (optional) - ["read("any")"] // permissions (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-email-attribute.md deleted file mode 100644 index af06f493e5..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.updateEmailAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'email@example.com' // default -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-enum-attribute.md deleted file mode 100644 index d4525ce226..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.updateEnumAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - [], // elements - false, // required - '<DEFAULT>' // default -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-float-attribute.md deleted file mode 100644 index 54b75fd5f3..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.updateFloatAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min - null, // max - null // default -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-integer-attribute.md deleted file mode 100644 index 0648e28663..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.updateIntegerAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min - null, // max - null // default -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-ip-attribute.md deleted file mode 100644 index 23a8741717..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.updateIpAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '' // default -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-relationship-attribute.md deleted file mode 100644 index c091a93b6b..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Databases, RelationMutate } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.updateRelationshipAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - RelationMutate.Cascade // onDelete (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-string-attribute.md deleted file mode 100644 index b12dbc27d0..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.updateStringAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '<DEFAULT>' // default -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-deno/examples/databases/update-url-attribute.md deleted file mode 100644 index cd074c282b..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.updateUrlAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'https://example.com' // default -); diff --git a/docs/examples/1.6.x/server-deno/examples/databases/update.md b/docs/examples/1.6.x/server-deno/examples/databases/update.md deleted file mode 100644 index 9220d447b5..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/databases/update.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Databases } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new Databases(client); - -const response = await databases.update( - '<DATABASE_ID>', // databaseId - '<NAME>', // name - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/create-build.md b/docs/examples/1.6.x/server-deno/examples/functions/create-build.md deleted file mode 100644 index 99160d7f8f..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/create-build.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.createBuild( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>', // deploymentId - '<BUILD_ID>' // buildId (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-deno/examples/functions/create-deployment.md deleted file mode 100644 index fc23e26b0c..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/create-deployment.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.createDeployment( - '<FUNCTION_ID>', // functionId - InputFile.fromPath('/path/to/file.png', 'file.png'), // code - false, // activate - '<ENTRYPOINT>', // entrypoint (optional) - '<COMMANDS>' // commands (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/create-execution.md b/docs/examples/1.6.x/server-deno/examples/functions/create-execution.md deleted file mode 100644 index b44aef84f9..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/create-execution.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Functions, ExecutionMethod } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const functions = new Functions(client); - -const response = await functions.createExecution( - '<FUNCTION_ID>', // functionId - '<BODY>', // body (optional) - false, // async (optional) - '<PATH>', // path (optional) - ExecutionMethod.GET, // method (optional) - {}, // headers (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/create-variable.md b/docs/examples/1.6.x/server-deno/examples/functions/create-variable.md deleted file mode 100644 index 780d30990f..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/create-variable.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.createVariable( - '<FUNCTION_ID>', // functionId - '<KEY>', // key - '<VALUE>' // value -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/create.md b/docs/examples/1.6.x/server-deno/examples/functions/create.md deleted file mode 100644 index c31bdfe126..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/create.md +++ /dev/null @@ -1,32 +0,0 @@ -import { Client, Functions, } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.create( - '<FUNCTION_ID>', // functionId - '<NAME>', // name - .Node145, // runtime - ["any"], // execute (optional) - [], // events (optional) - '', // schedule (optional) - 1, // timeout (optional) - false, // enabled (optional) - false, // logging (optional) - '<ENTRYPOINT>', // entrypoint (optional) - '<COMMANDS>', // commands (optional) - [], // scopes (optional) - '<INSTALLATION_ID>', // installationId (optional) - '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) - '<PROVIDER_BRANCH>', // providerBranch (optional) - false, // providerSilentMode (optional) - '<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional) - '<TEMPLATE_REPOSITORY>', // templateRepository (optional) - '<TEMPLATE_OWNER>', // templateOwner (optional) - '<TEMPLATE_ROOT_DIRECTORY>', // templateRootDirectory (optional) - '<TEMPLATE_BRANCH>' // templateBranch (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-deno/examples/functions/delete-deployment.md deleted file mode 100644 index 7b72f7e639..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/delete-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.deleteDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-deno/examples/functions/delete-execution.md deleted file mode 100644 index 6959261f79..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/delete-execution.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.deleteExecution( - '<FUNCTION_ID>', // functionId - '<EXECUTION_ID>' // executionId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-deno/examples/functions/delete-variable.md deleted file mode 100644 index 910678b31a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/delete-variable.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.deleteVariable( - '<FUNCTION_ID>', // functionId - '<VARIABLE_ID>' // variableId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/delete.md b/docs/examples/1.6.x/server-deno/examples/functions/delete.md deleted file mode 100644 index fc9930e508..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.delete( - '<FUNCTION_ID>' // functionId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-deno/examples/functions/download-deployment.md deleted file mode 100644 index 2fdf148283..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/download-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const result = functions.downloadDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-deno/examples/functions/get-deployment.md deleted file mode 100644 index bc798e5e7b..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/get-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.getDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/get-execution.md b/docs/examples/1.6.x/server-deno/examples/functions/get-execution.md deleted file mode 100644 index afb6c6713a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/get-execution.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const functions = new Functions(client); - -const response = await functions.getExecution( - '<FUNCTION_ID>', // functionId - '<EXECUTION_ID>' // executionId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/get-variable.md b/docs/examples/1.6.x/server-deno/examples/functions/get-variable.md deleted file mode 100644 index 8634ed3ee5..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/get-variable.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.getVariable( - '<FUNCTION_ID>', // functionId - '<VARIABLE_ID>' // variableId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/get.md b/docs/examples/1.6.x/server-deno/examples/functions/get.md deleted file mode 100644 index 66b99d4bb1..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.get( - '<FUNCTION_ID>' // functionId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-deno/examples/functions/list-deployments.md deleted file mode 100644 index 5dc5eb5552..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/list-deployments.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.listDeployments( - '<FUNCTION_ID>', // functionId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/list-executions.md b/docs/examples/1.6.x/server-deno/examples/functions/list-executions.md deleted file mode 100644 index 34a34b4463..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/list-executions.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const functions = new Functions(client); - -const response = await functions.listExecutions( - '<FUNCTION_ID>', // functionId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-deno/examples/functions/list-runtimes.md deleted file mode 100644 index cc1ecdff6a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/list-runtimes.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.listRuntimes(); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/list-variables.md b/docs/examples/1.6.x/server-deno/examples/functions/list-variables.md deleted file mode 100644 index f4ebb811bb..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/list-variables.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.listVariables( - '<FUNCTION_ID>' // functionId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/list.md b/docs/examples/1.6.x/server-deno/examples/functions/list.md deleted file mode 100644 index 85b8caa446..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/list.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-deno/examples/functions/update-deployment-build.md deleted file mode 100644 index 9b3d5ae428..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.updateDeploymentBuild( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-deno/examples/functions/update-deployment.md deleted file mode 100644 index dd71ab8842..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/update-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.updateDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/update-variable.md b/docs/examples/1.6.x/server-deno/examples/functions/update-variable.md deleted file mode 100644 index e1d931687f..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/update-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Functions } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.updateVariable( - '<FUNCTION_ID>', // functionId - '<VARIABLE_ID>', // variableId - '<KEY>', // key - '<VALUE>' // value (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/functions/update.md b/docs/examples/1.6.x/server-deno/examples/functions/update.md deleted file mode 100644 index 5d37fb804c..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/functions/update.md +++ /dev/null @@ -1,28 +0,0 @@ -import { Client, Functions, } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new Functions(client); - -const response = await functions.update( - '<FUNCTION_ID>', // functionId - '<NAME>', // name - .Node145, // runtime (optional) - ["any"], // execute (optional) - [], // events (optional) - '', // schedule (optional) - 1, // timeout (optional) - false, // enabled (optional) - false, // logging (optional) - '<ENTRYPOINT>', // entrypoint (optional) - '<COMMANDS>', // commands (optional) - [], // scopes (optional) - '<INSTALLATION_ID>', // installationId (optional) - '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) - '<PROVIDER_BRANCH>', // providerBranch (optional) - false, // providerSilentMode (optional) - '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/graphql/mutation.md b/docs/examples/1.6.x/server-deno/examples/graphql/mutation.md deleted file mode 100644 index 29fd054642..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/graphql/mutation.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Graphql } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const graphql = new Graphql(client); - -const response = await graphql.mutation( - {} // query -); diff --git a/docs/examples/1.6.x/server-deno/examples/graphql/query.md b/docs/examples/1.6.x/server-deno/examples/graphql/query.md deleted file mode 100644 index 397973d817..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/graphql/query.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Graphql } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const graphql = new Graphql(client); - -const response = await graphql.query( - {} // query -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-deno/examples/health/get-antivirus.md deleted file mode 100644 index 9e8a30778c..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-antivirus.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getAntivirus(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-cache.md b/docs/examples/1.6.x/server-deno/examples/health/get-cache.md deleted file mode 100644 index 55b8bfb3cf..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-cache.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getCache(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-certificate.md b/docs/examples/1.6.x/server-deno/examples/health/get-certificate.md deleted file mode 100644 index 29facfc22e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-certificate.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getCertificate( - '' // domain (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-d-b.md b/docs/examples/1.6.x/server-deno/examples/health/get-d-b.md deleted file mode 100644 index 64d89c0ec2..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-d-b.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getDB(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-deno/examples/health/get-failed-jobs.md deleted file mode 100644 index 362c235fc4..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health, } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getFailedJobs( - .V1Database, // name - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-deno/examples/health/get-pub-sub.md deleted file mode 100644 index 433b50cb9a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-pub-sub.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getPubSub(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-builds.md deleted file mode 100644 index faee214414..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-builds.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueBuilds( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-certificates.md deleted file mode 100644 index 2cf716a2f6..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueCertificates( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-databases.md deleted file mode 100644 index e64798fe05..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-databases.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueDatabases( - '<NAME>', // name (optional) - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-deletes.md deleted file mode 100644 index dffd43f2a1..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueDeletes( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-functions.md deleted file mode 100644 index 9ee87d968a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-functions.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueFunctions( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-logs.md deleted file mode 100644 index aa8639d557..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-logs.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueLogs( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-mails.md deleted file mode 100644 index 555a2b8d7d..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-mails.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueMails( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-messaging.md deleted file mode 100644 index f4191575bf..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueMessaging( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-migrations.md deleted file mode 100644 index 557a3dba32..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueMigrations( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage-dump.md deleted file mode 100644 index 27770d1a1e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueUsageDump( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage.md deleted file mode 100644 index 4d74e5babf..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-usage.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueUsage( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue-webhooks.md deleted file mode 100644 index 51032e3e7e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueueWebhooks( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-queue.md b/docs/examples/1.6.x/server-deno/examples/health/get-queue.md deleted file mode 100644 index f95f709c43..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-queue.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getQueue(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-deno/examples/health/get-storage-local.md deleted file mode 100644 index c66249503e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-storage-local.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getStorageLocal(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-storage.md b/docs/examples/1.6.x/server-deno/examples/health/get-storage.md deleted file mode 100644 index 53f5dcf162..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-storage.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getStorage(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get-time.md b/docs/examples/1.6.x/server-deno/examples/health/get-time.md deleted file mode 100644 index 9c0e7a8543..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get-time.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.getTime(); diff --git a/docs/examples/1.6.x/server-deno/examples/health/get.md b/docs/examples/1.6.x/server-deno/examples/health/get.md deleted file mode 100644 index 8c259d4d08..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/health/get.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Health } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new Health(client); - -const response = await health.get(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/get.md b/docs/examples/1.6.x/server-deno/examples/locale/get.md deleted file mode 100644 index 04e45b50e9..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/locale/get.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new Locale(client); - -const response = await locale.get(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-codes.md b/docs/examples/1.6.x/server-deno/examples/locale/list-codes.md deleted file mode 100644 index 2806ea2543..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/locale/list-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new Locale(client); - -const response = await locale.listCodes(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-continents.md b/docs/examples/1.6.x/server-deno/examples/locale/list-continents.md deleted file mode 100644 index 2218f1bedb..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/locale/list-continents.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new Locale(client); - -const response = await locale.listContinents(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-deno/examples/locale/list-countries-e-u.md deleted file mode 100644 index 0dbb50aff4..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new Locale(client); - -const response = await locale.listCountriesEU(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-deno/examples/locale/list-countries-phones.md deleted file mode 100644 index 3c5ae53b41..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new Locale(client); - -const response = await locale.listCountriesPhones(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-countries.md b/docs/examples/1.6.x/server-deno/examples/locale/list-countries.md deleted file mode 100644 index 4bc430f0fc..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/locale/list-countries.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new Locale(client); - -const response = await locale.listCountries(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-deno/examples/locale/list-currencies.md deleted file mode 100644 index 44f1e606fb..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/locale/list-currencies.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new Locale(client); - -const response = await locale.listCurrencies(); diff --git a/docs/examples/1.6.x/server-deno/examples/locale/list-languages.md b/docs/examples/1.6.x/server-deno/examples/locale/list-languages.md deleted file mode 100644 index af597ccf57..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/locale/list-languages.md +++ /dev/null @@ -1,10 +0,0 @@ -import { Client, Locale } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new Locale(client); - -const response = await locale.listLanguages(); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-apns-provider.md deleted file mode 100644 index a958f8e6ec..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createApnsProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<AUTH_KEY>', // authKey (optional) - '<AUTH_KEY_ID>', // authKeyId (optional) - '<TEAM_ID>', // teamId (optional) - '<BUNDLE_ID>', // bundleId (optional) - false, // sandbox (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-email.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-email.md deleted file mode 100644 index 892fb12be0..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-email.md +++ /dev/null @@ -1,23 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createEmail( - '<MESSAGE_ID>', // messageId - '<SUBJECT>', // subject - '<CONTENT>', // content - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - [], // cc (optional) - [], // bcc (optional) - [], // attachments (optional) - false, // draft (optional) - false, // html (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-fcm-provider.md deleted file mode 100644 index 5c4dc95cd8..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createFcmProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - {}, // serviceAccountJSON (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index 24fe54d3f3..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createMailgunProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<API_KEY>', // apiKey (optional) - '<DOMAIN>', // domain (optional) - false, // isEuRegion (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - 'email@example.com', // replyToEmail (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-msg91provider.md deleted file mode 100644 index 7fb2671738..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createMsg91Provider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<TEMPLATE_ID>', // templateId (optional) - '<SENDER_ID>', // senderId (optional) - '<AUTH_KEY>', // authKey (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-push.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-push.md deleted file mode 100644 index efc73df645..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-push.md +++ /dev/null @@ -1,27 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createPush( - '<MESSAGE_ID>', // messageId - '<TITLE>', // title - '<BODY>', // body - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - {}, // data (optional) - '<ACTION>', // action (optional) - '[ID1:ID2]', // image (optional) - '<ICON>', // icon (optional) - '<SOUND>', // sound (optional) - '<COLOR>', // color (optional) - '<TAG>', // tag (optional) - '<BADGE>', // badge (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index 0b35009bae..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createSendgridProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<API_KEY>', // apiKey (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - 'email@example.com', // replyToEmail (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-sms.md deleted file mode 100644 index 2823eb14e5..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-sms.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createSms( - '<MESSAGE_ID>', // messageId - '<CONTENT>', // content - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-smtp-provider.md deleted file mode 100644 index bf7912500a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,25 +0,0 @@ -import { Client, Messaging, SmtpEncryption } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createSmtpProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<HOST>', // host - 1, // port (optional) - '<USERNAME>', // username (optional) - '<PASSWORD>', // password (optional) - SmtpEncryption.None, // encryption (optional) - false, // autoTLS (optional) - '<MAILER>', // mailer (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - 'email@example.com', // replyToEmail (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-subscriber.md deleted file mode 100644 index 1d510292b4..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token - -const messaging = new Messaging(client); - -const response = await messaging.createSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>', // subscriberId - '<TARGET_ID>' // targetId -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-telesign-provider.md deleted file mode 100644 index a5623ada10..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createTelesignProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<CUSTOMER_ID>', // customerId (optional) - '<API_KEY>', // apiKey (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index e319a64d15..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createTextmagicProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<USERNAME>', // username (optional) - '<API_KEY>', // apiKey (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-topic.md deleted file mode 100644 index 88217dd793..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createTopic( - '<TOPIC_ID>', // topicId - '<NAME>', // name - ["any"] // subscribe (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-twilio-provider.md deleted file mode 100644 index cf3ef29b2b..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createTwilioProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<ACCOUNT_SID>', // accountSid (optional) - '<AUTH_TOKEN>', // authToken (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/create-vonage-provider.md deleted file mode 100644 index 565c4029f7..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.createVonageProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<API_KEY>', // apiKey (optional) - '<API_SECRET>', // apiSecret (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/delete-provider.md deleted file mode 100644 index d3c2e5e03a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/delete-provider.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.deleteProvider( - '<PROVIDER_ID>' // providerId -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-deno/examples/messaging/delete-subscriber.md deleted file mode 100644 index 66ca92bd4b..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token - -const messaging = new Messaging(client); - -const response = await messaging.deleteSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>' // subscriberId -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-deno/examples/messaging/delete-topic.md deleted file mode 100644 index 3802874c56..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/delete-topic.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.deleteTopic( - '<TOPIC_ID>' // topicId -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/delete.md b/docs/examples/1.6.x/server-deno/examples/messaging/delete.md deleted file mode 100644 index 0bf4473ae5..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.delete( - '<MESSAGE_ID>' // messageId -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/get-message.md b/docs/examples/1.6.x/server-deno/examples/messaging/get-message.md deleted file mode 100644 index 4ad50591ac..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/get-message.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.getMessage( - '<MESSAGE_ID>' // messageId -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/get-provider.md deleted file mode 100644 index 10956547d0..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/get-provider.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.getProvider( - '<PROVIDER_ID>' // providerId -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-deno/examples/messaging/get-subscriber.md deleted file mode 100644 index c76b65a787..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.getSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>' // subscriberId -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-deno/examples/messaging/get-topic.md deleted file mode 100644 index 5202be495f..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/get-topic.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.getTopic( - '<TOPIC_ID>' // topicId -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-message-logs.md deleted file mode 100644 index 1101508823..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.listMessageLogs( - '<MESSAGE_ID>', // messageId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-messages.md deleted file mode 100644 index 9bdca84969..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/list-messages.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.listMessages( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-provider-logs.md deleted file mode 100644 index b2be21b03e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.listProviderLogs( - '<PROVIDER_ID>', // providerId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-providers.md deleted file mode 100644 index 7797454e8e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/list-providers.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.listProviders( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index 6a033f2e73..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.listSubscriberLogs( - '<SUBSCRIBER_ID>', // subscriberId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-subscribers.md deleted file mode 100644 index 71f856b7a5..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.listSubscribers( - '<TOPIC_ID>', // topicId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-targets.md deleted file mode 100644 index 0c7772cb00..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/list-targets.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.listTargets( - '<MESSAGE_ID>', // messageId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-topic-logs.md deleted file mode 100644 index ab0c021d0e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.listTopicLogs( - '<TOPIC_ID>', // topicId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-deno/examples/messaging/list-topics.md deleted file mode 100644 index b087d03a17..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/list-topics.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.listTopics( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-apns-provider.md deleted file mode 100644 index 7427c6d8bf..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateApnsProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<AUTH_KEY>', // authKey (optional) - '<AUTH_KEY_ID>', // authKeyId (optional) - '<TEAM_ID>', // teamId (optional) - '<BUNDLE_ID>', // bundleId (optional) - false // sandbox (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-email.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-email.md deleted file mode 100644 index 42a44f8f9a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-email.md +++ /dev/null @@ -1,23 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateEmail( - '<MESSAGE_ID>', // messageId - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - '<SUBJECT>', // subject (optional) - '<CONTENT>', // content (optional) - false, // draft (optional) - false, // html (optional) - [], // cc (optional) - [], // bcc (optional) - '', // scheduledAt (optional) - [] // attachments (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-fcm-provider.md deleted file mode 100644 index 7ceb75166b..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateFcmProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - {} // serviceAccountJSON (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index 6b7605dba1..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateMailgunProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - '<API_KEY>', // apiKey (optional) - '<DOMAIN>', // domain (optional) - false, // isEuRegion (optional) - false, // enabled (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - '<REPLY_TO_EMAIL>' // replyToEmail (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-msg91provider.md deleted file mode 100644 index 603303c63f..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateMsg91Provider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<TEMPLATE_ID>', // templateId (optional) - '<SENDER_ID>', // senderId (optional) - '<AUTH_KEY>' // authKey (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-push.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-push.md deleted file mode 100644 index e12890e2e9..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-push.md +++ /dev/null @@ -1,27 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updatePush( - '<MESSAGE_ID>', // messageId - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - '<TITLE>', // title (optional) - '<BODY>', // body (optional) - {}, // data (optional) - '<ACTION>', // action (optional) - '[ID1:ID2]', // image (optional) - '<ICON>', // icon (optional) - '<SOUND>', // sound (optional) - '<COLOR>', // color (optional) - '<TAG>', // tag (optional) - null, // badge (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index ce4a6c2968..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateSendgridProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<API_KEY>', // apiKey (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - '<REPLY_TO_EMAIL>' // replyToEmail (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-sms.md deleted file mode 100644 index fc0ca688d1..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-sms.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateSms( - '<MESSAGE_ID>', // messageId - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - '<CONTENT>', // content (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-smtp-provider.md deleted file mode 100644 index c227026184..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,25 +0,0 @@ -import { Client, Messaging, SmtpEncryption } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateSmtpProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - '<HOST>', // host (optional) - 1, // port (optional) - '<USERNAME>', // username (optional) - '<PASSWORD>', // password (optional) - SmtpEncryption.None, // encryption (optional) - false, // autoTLS (optional) - '<MAILER>', // mailer (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - '<REPLY_TO_EMAIL>', // replyToEmail (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-telesign-provider.md deleted file mode 100644 index 4e4d3839ac..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateTelesignProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<CUSTOMER_ID>', // customerId (optional) - '<API_KEY>', // apiKey (optional) - '<FROM>' // from (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index 13ea0433c7..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateTextmagicProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<USERNAME>', // username (optional) - '<API_KEY>', // apiKey (optional) - '<FROM>' // from (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-topic.md deleted file mode 100644 index 385df4ffd6..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateTopic( - '<TOPIC_ID>', // topicId - '<NAME>', // name (optional) - ["any"] // subscribe (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-twilio-provider.md deleted file mode 100644 index ac0c5516f6..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateTwilioProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<ACCOUNT_SID>', // accountSid (optional) - '<AUTH_TOKEN>', // authToken (optional) - '<FROM>' // from (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-deno/examples/messaging/update-vonage-provider.md deleted file mode 100644 index 9b8451dac0..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Messaging } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new Messaging(client); - -const response = await messaging.updateVonageProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<API_KEY>', // apiKey (optional) - '<API_SECRET>', // apiSecret (optional) - '<FROM>' // from (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-deno/examples/storage/create-bucket.md deleted file mode 100644 index 85a60abdbc..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/create-bucket.md +++ /dev/null @@ -1,21 +0,0 @@ -import { Client, Storage, } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const storage = new Storage(client); - -const response = await storage.createBucket( - '<BUCKET_ID>', // bucketId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // fileSecurity (optional) - false, // enabled (optional) - 1, // maximumFileSize (optional) - [], // allowedFileExtensions (optional) - .None, // compression (optional) - false, // encryption (optional) - false // antivirus (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/create-file.md b/docs/examples/1.6.x/server-deno/examples/storage/create-file.md deleted file mode 100644 index 0a18e9246a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/create-file.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new Storage(client); - -const response = await storage.createFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - InputFile.fromPath('/path/to/file.png', 'file.png'), // file - ["read("any")"] // permissions (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-deno/examples/storage/delete-bucket.md deleted file mode 100644 index 48690b08e3..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/delete-bucket.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const storage = new Storage(client); - -const response = await storage.deleteBucket( - '<BUCKET_ID>' // bucketId -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/delete-file.md b/docs/examples/1.6.x/server-deno/examples/storage/delete-file.md deleted file mode 100644 index ae67b9f1e7..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/delete-file.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new Storage(client); - -const response = await storage.deleteFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-deno/examples/storage/get-bucket.md deleted file mode 100644 index 80be0c0e37..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/get-bucket.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const storage = new Storage(client); - -const response = await storage.getBucket( - '<BUCKET_ID>' // bucketId -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-deno/examples/storage/get-file-download.md deleted file mode 100644 index eeb248daf6..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/get-file-download.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new Storage(client); - -const result = storage.getFileDownload( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-deno/examples/storage/get-file-preview.md deleted file mode 100644 index a75cd2b36f..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/get-file-preview.md +++ /dev/null @@ -1,24 +0,0 @@ -import { Client, Storage, ImageGravity, ImageFormat } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new Storage(client); - -const result = storage.getFilePreview( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - 0, // width (optional) - 0, // height (optional) - ImageGravity.Center, // gravity (optional) - 0, // quality (optional) - 0, // borderWidth (optional) - '', // borderColor (optional) - 0, // borderRadius (optional) - 0, // opacity (optional) - -360, // rotation (optional) - '', // background (optional) - ImageFormat.Jpg // output (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-deno/examples/storage/get-file-view.md deleted file mode 100644 index fd919b7627..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/get-file-view.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new Storage(client); - -const result = storage.getFileView( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/get-file.md b/docs/examples/1.6.x/server-deno/examples/storage/get-file.md deleted file mode 100644 index 84289b22de..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/get-file.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new Storage(client); - -const response = await storage.getFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-deno/examples/storage/list-buckets.md deleted file mode 100644 index 4b6a93dc36..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/list-buckets.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const storage = new Storage(client); - -const response = await storage.listBuckets( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/list-files.md b/docs/examples/1.6.x/server-deno/examples/storage/list-files.md deleted file mode 100644 index 2e9a9e0bd4..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/list-files.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new Storage(client); - -const response = await storage.listFiles( - '<BUCKET_ID>', // bucketId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-deno/examples/storage/update-bucket.md deleted file mode 100644 index 46ee2ba190..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/update-bucket.md +++ /dev/null @@ -1,21 +0,0 @@ -import { Client, Storage, } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const storage = new Storage(client); - -const response = await storage.updateBucket( - '<BUCKET_ID>', // bucketId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // fileSecurity (optional) - false, // enabled (optional) - 1, // maximumFileSize (optional) - [], // allowedFileExtensions (optional) - .None, // compression (optional) - false, // encryption (optional) - false // antivirus (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/storage/update-file.md b/docs/examples/1.6.x/server-deno/examples/storage/update-file.md deleted file mode 100644 index 249fc09b4e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/storage/update-file.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Storage } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new Storage(client); - -const response = await storage.updateFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - '<NAME>', // name (optional) - ["read("any")"] // permissions (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/create-membership.md b/docs/examples/1.6.x/server-deno/examples/teams/create-membership.md deleted file mode 100644 index 3636727f0c..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/create-membership.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.createMembership( - '<TEAM_ID>', // teamId - [], // roles - 'email@example.com', // email (optional) - '<USER_ID>', // userId (optional) - '+12065550100', // phone (optional) - 'https://example.com', // url (optional) - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/create.md b/docs/examples/1.6.x/server-deno/examples/teams/create.md deleted file mode 100644 index 330bb4385d..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/create.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.create( - '<TEAM_ID>', // teamId - '<NAME>', // name - [] // roles (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-deno/examples/teams/delete-membership.md deleted file mode 100644 index 7d2a4ed3ab..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/delete-membership.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.deleteMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>' // membershipId -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/delete.md b/docs/examples/1.6.x/server-deno/examples/teams/delete.md deleted file mode 100644 index bd140f8da6..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.delete( - '<TEAM_ID>' // teamId -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/get-membership.md b/docs/examples/1.6.x/server-deno/examples/teams/get-membership.md deleted file mode 100644 index 3b88441a6e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/get-membership.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.getMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>' // membershipId -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-deno/examples/teams/get-prefs.md deleted file mode 100644 index 4e7882ade1..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.getPrefs( - '<TEAM_ID>' // teamId -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/get.md b/docs/examples/1.6.x/server-deno/examples/teams/get.md deleted file mode 100644 index 2835d9eab1..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.get( - '<TEAM_ID>' // teamId -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-deno/examples/teams/list-memberships.md deleted file mode 100644 index 1688ad4852..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/list-memberships.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.listMemberships( - '<TEAM_ID>', // teamId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/list.md b/docs/examples/1.6.x/server-deno/examples/teams/list.md deleted file mode 100644 index 8e7dad2d65..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/list.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-deno/examples/teams/update-membership-status.md deleted file mode 100644 index f7459703d2..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/update-membership-status.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.updateMembershipStatus( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>', // membershipId - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/update-membership.md b/docs/examples/1.6.x/server-deno/examples/teams/update-membership.md deleted file mode 100644 index ee0ce5a812..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/update-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.updateMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>', // membershipId - [] // roles -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/update-name.md b/docs/examples/1.6.x/server-deno/examples/teams/update-name.md deleted file mode 100644 index f20b6ed19f..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.updateName( - '<TEAM_ID>', // teamId - '<NAME>' // name -); diff --git a/docs/examples/1.6.x/server-deno/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-deno/examples/teams/update-prefs.md deleted file mode 100644 index 35452a6b90..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/teams/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Teams } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new Teams(client); - -const response = await teams.updatePrefs( - '<TEAM_ID>', // teamId - {} // prefs -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-deno/examples/users/create-argon2user.md deleted file mode 100644 index e92126bc13..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-argon2user.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createArgon2User( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-deno/examples/users/create-bcrypt-user.md deleted file mode 100644 index f59770a304..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createBcryptUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-deno/examples/users/create-j-w-t.md deleted file mode 100644 index fbaefa9535..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-j-w-t.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createJWT( - '<USER_ID>', // userId - '<SESSION_ID>', // sessionId (optional) - 0 // duration (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-deno/examples/users/create-m-d5user.md deleted file mode 100644 index 4a60e956e4..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-m-d5user.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createMD5User( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index 5c58e5b5d4..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createMfaRecoveryCodes( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-deno/examples/users/create-p-h-pass-user.md deleted file mode 100644 index e353c4abef..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,15 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createPHPassUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-deno/examples/users/create-s-h-a-user.md deleted file mode 100644 index 16c1b0cc5d..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Users, PasswordHash } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createSHAUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - PasswordHash.Sha1, // passwordVersion (optional) - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index 0bcb2bc710..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,18 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createScryptModifiedUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<PASSWORD_SALT>', // passwordSalt - '<PASSWORD_SALT_SEPARATOR>', // passwordSaltSeparator - '<PASSWORD_SIGNER_KEY>', // passwordSignerKey - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-user.md deleted file mode 100644 index 6813a0d300..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,20 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createScryptUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<PASSWORD_SALT>', // passwordSalt - null, // passwordCpu - null, // passwordMemory - null, // passwordParallel - null, // passwordLength - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-session.md b/docs/examples/1.6.x/server-deno/examples/users/create-session.md deleted file mode 100644 index 3c3bf4e54e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-session.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createSession( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-target.md b/docs/examples/1.6.x/server-deno/examples/users/create-target.md deleted file mode 100644 index 9597b30b3a..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-target.md +++ /dev/null @@ -1,17 +0,0 @@ -import { Client, Users, MessagingProviderType } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createTarget( - '<USER_ID>', // userId - '<TARGET_ID>', // targetId - MessagingProviderType.Email, // providerType - '<IDENTIFIER>', // identifier - '<PROVIDER_ID>', // providerId (optional) - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create-token.md b/docs/examples/1.6.x/server-deno/examples/users/create-token.md deleted file mode 100644 index 26be7e629d..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.createToken( - '<USER_ID>', // userId - 4, // length (optional) - 60 // expire (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/create.md b/docs/examples/1.6.x/server-deno/examples/users/create.md deleted file mode 100644 index 832d9e0b16..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/create.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.create( - '<USER_ID>', // userId - 'email@example.com', // email (optional) - '+12065550100', // phone (optional) - '', // password (optional) - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete-identity.md b/docs/examples/1.6.x/server-deno/examples/users/delete-identity.md deleted file mode 100644 index 28e6685904..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/delete-identity.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.deleteIdentity( - '<IDENTITY_ID>' // identityId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-deno/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index 5fd7ee9f5e..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users, AuthenticatorType } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.deleteMfaAuthenticator( - '<USER_ID>', // userId - AuthenticatorType.Totp // type -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete-session.md b/docs/examples/1.6.x/server-deno/examples/users/delete-session.md deleted file mode 100644 index 61dbc25855..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/delete-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.deleteSession( - '<USER_ID>', // userId - '<SESSION_ID>' // sessionId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-deno/examples/users/delete-sessions.md deleted file mode 100644 index 2a8cae1a40..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/delete-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.deleteSessions( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete-target.md b/docs/examples/1.6.x/server-deno/examples/users/delete-target.md deleted file mode 100644 index f7b74e3afc..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/delete-target.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.deleteTarget( - '<USER_ID>', // userId - '<TARGET_ID>' // targetId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/delete.md b/docs/examples/1.6.x/server-deno/examples/users/delete.md deleted file mode 100644 index 2e102cdadd..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.delete( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index 671b7b244f..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.getMfaRecoveryCodes( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/get-prefs.md b/docs/examples/1.6.x/server-deno/examples/users/get-prefs.md deleted file mode 100644 index 5db7e51302..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.getPrefs( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/get-target.md b/docs/examples/1.6.x/server-deno/examples/users/get-target.md deleted file mode 100644 index 0ede3716be..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/get-target.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.getTarget( - '<USER_ID>', // userId - '<TARGET_ID>' // targetId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/get.md b/docs/examples/1.6.x/server-deno/examples/users/get.md deleted file mode 100644 index 54dfde6e8d..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.get( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-identities.md b/docs/examples/1.6.x/server-deno/examples/users/list-identities.md deleted file mode 100644 index 5726b980b2..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/list-identities.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.listIdentities( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-logs.md b/docs/examples/1.6.x/server-deno/examples/users/list-logs.md deleted file mode 100644 index e6b65ceabf..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/list-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.listLogs( - '<USER_ID>', // userId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-memberships.md b/docs/examples/1.6.x/server-deno/examples/users/list-memberships.md deleted file mode 100644 index 4d8f523357..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/list-memberships.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.listMemberships( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-deno/examples/users/list-mfa-factors.md deleted file mode 100644 index 5672006db2..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.listMfaFactors( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-sessions.md b/docs/examples/1.6.x/server-deno/examples/users/list-sessions.md deleted file mode 100644 index c5f88cba60..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/list-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.listSessions( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list-targets.md b/docs/examples/1.6.x/server-deno/examples/users/list-targets.md deleted file mode 100644 index 61ec71f280..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/list-targets.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.listTargets( - '<USER_ID>', // userId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/list.md b/docs/examples/1.6.x/server-deno/examples/users/list.md deleted file mode 100644 index 9415a842ff..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/list.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-deno/examples/users/update-email-verification.md deleted file mode 100644 index 0038cdfdff..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-email-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updateEmailVerification( - '<USER_ID>', // userId - false // emailVerification -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-email.md b/docs/examples/1.6.x/server-deno/examples/users/update-email.md deleted file mode 100644 index 3088e7f7dd..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-email.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updateEmail( - '<USER_ID>', // userId - 'email@example.com' // email -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-labels.md b/docs/examples/1.6.x/server-deno/examples/users/update-labels.md deleted file mode 100644 index bd4d330140..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-labels.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updateLabels( - '<USER_ID>', // userId - [] // labels -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-deno/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index b3fbbbb674..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updateMfaRecoveryCodes( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-mfa.md b/docs/examples/1.6.x/server-deno/examples/users/update-mfa.md deleted file mode 100644 index bf66612077..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-mfa.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updateMfa( - '<USER_ID>', // userId - false // mfa -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-name.md b/docs/examples/1.6.x/server-deno/examples/users/update-name.md deleted file mode 100644 index e7e59c6091..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updateName( - '<USER_ID>', // userId - '<NAME>' // name -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-password.md b/docs/examples/1.6.x/server-deno/examples/users/update-password.md deleted file mode 100644 index dc678f833c..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-password.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updatePassword( - '<USER_ID>', // userId - '' // password -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-deno/examples/users/update-phone-verification.md deleted file mode 100644 index df9acac575..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updatePhoneVerification( - '<USER_ID>', // userId - false // phoneVerification -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-phone.md b/docs/examples/1.6.x/server-deno/examples/users/update-phone.md deleted file mode 100644 index 63d7cb8030..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-phone.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updatePhone( - '<USER_ID>', // userId - '+12065550100' // number -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-prefs.md b/docs/examples/1.6.x/server-deno/examples/users/update-prefs.md deleted file mode 100644 index b5e24815d3..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updatePrefs( - '<USER_ID>', // userId - {} // prefs -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-status.md b/docs/examples/1.6.x/server-deno/examples/users/update-status.md deleted file mode 100644 index 79c846fbd6..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-status.md +++ /dev/null @@ -1,13 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updateStatus( - '<USER_ID>', // userId - false // status -); diff --git a/docs/examples/1.6.x/server-deno/examples/users/update-target.md b/docs/examples/1.6.x/server-deno/examples/users/update-target.md deleted file mode 100644 index 614e019fee..0000000000 --- a/docs/examples/1.6.x/server-deno/examples/users/update-target.md +++ /dev/null @@ -1,16 +0,0 @@ -import { Client, Users } from "https://deno.land/x/appwrite/mod.ts"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new Users(client); - -const response = await users.updateTarget( - '<USER_ID>', // userId - '<TARGET_ID>', // targetId - '<IDENTIFIER>', // identifier (optional) - '<PROVIDER_ID>', // providerId (optional) - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-anonymous-session.md deleted file mode 100644 index 840ecff650..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,11 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -Session result = await account.CreateAnonymousSession(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-email-password-session.md deleted file mode 100644 index f9b982f2d7..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-email-password-session.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -Session result = await account.CreateEmailPasswordSession( - email: "email@example.com", - password: "password" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-email-token.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-email-token.md deleted file mode 100644 index fd770b280c..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-email-token.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -Token result = await account.CreateEmailToken( - userId: "<USER_ID>", - email: "email@example.com", - phrase: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-j-w-t.md deleted file mode 100644 index b70daadc74..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-j-w-t.md +++ /dev/null @@ -1,11 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -JWT result = await account.CreateJWT(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 3ca10c0b5a..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -Token result = await account.CreateMagicURLToken( - userId: "<USER_ID>", - email: "email@example.com", - url: "https://example.com", // optional - phrase: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-authenticator.md deleted file mode 100644 index f30f8ddc83..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -MfaType result = await account.CreateMfaAuthenticator( - type: AuthenticatorType.Totp -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-challenge.md deleted file mode 100644 index b719c23b6b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -MfaChallenge result = await account.CreateMfaChallenge( - factor: AuthenticationFactor.Email -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index 4b1b97ff72..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -MfaRecoveryCodes result = await account.CreateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-o-auth2token.md deleted file mode 100644 index 6fcbd7b063..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -await account.CreateOAuth2Token( - provider: OAuthProvider.Amazon, - success: "https://example.com", // optional - failure: "https://example.com", // optional - scopes: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-token.md deleted file mode 100644 index df58414cba..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-token.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -Token result = await account.CreatePhoneToken( - userId: "<USER_ID>", - phone: "+12065550100" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-verification.md deleted file mode 100644 index 23ea8b1996..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-phone-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -Token result = await account.CreatePhoneVerification(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-recovery.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-recovery.md deleted file mode 100644 index d86edcf048..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-recovery.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -Token result = await account.CreateRecovery( - email: "email@example.com", - url: "https://example.com" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-session.md deleted file mode 100644 index 9b33e5ba93..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-session.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -Session result = await account.CreateSession( - userId: "<USER_ID>", - secret: "<SECRET>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create-verification.md b/docs/examples/1.6.x/server-dotnet/examples/account/create-verification.md deleted file mode 100644 index 7fd8668786..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -Token result = await account.CreateVerification( - url: "https://example.com" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/create.md b/docs/examples/1.6.x/server-dotnet/examples/account/create.md deleted file mode 100644 index 5073fa5606..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/create.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -User result = await account.Create( - userId: "<USER_ID>", - email: "email@example.com", - password: "", - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/delete-identity.md b/docs/examples/1.6.x/server-dotnet/examples/account/delete-identity.md deleted file mode 100644 index 0c54a3c677..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/delete-identity.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -await account.DeleteIdentity( - identityId: "<IDENTITY_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-dotnet/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 8cb1ac7956..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -await account.DeleteMfaAuthenticator( - type: AuthenticatorType.Totp -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/delete-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/delete-session.md deleted file mode 100644 index a2ae74662c..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/delete-session.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -await account.DeleteSession( - sessionId: "<SESSION_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-dotnet/examples/account/delete-sessions.md deleted file mode 100644 index e892d1d93b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/delete-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -await account.DeleteSessions(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index 8aa3376b31..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -MfaRecoveryCodes result = await account.GetMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/get-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/account/get-prefs.md deleted file mode 100644 index d65405a455..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -Preferences result = await account.GetPrefs(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/get-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/get-session.md deleted file mode 100644 index 55ff7fb1cb..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/get-session.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -Session result = await account.GetSession( - sessionId: "<SESSION_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/get.md b/docs/examples/1.6.x/server-dotnet/examples/account/get.md deleted file mode 100644 index ee8ddface7..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/get.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -User result = await account.Get(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/list-identities.md b/docs/examples/1.6.x/server-dotnet/examples/account/list-identities.md deleted file mode 100644 index 317475f2a3..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/list-identities.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -IdentityList result = await account.ListIdentities( - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/list-logs.md b/docs/examples/1.6.x/server-dotnet/examples/account/list-logs.md deleted file mode 100644 index 1ae4fcbefd..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/list-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -LogList result = await account.ListLogs( - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-dotnet/examples/account/list-mfa-factors.md deleted file mode 100644 index 00d818f61f..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -MfaFactors result = await account.ListMfaFactors(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/list-sessions.md b/docs/examples/1.6.x/server-dotnet/examples/account/list-sessions.md deleted file mode 100644 index bf6fdb2567..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/list-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -SessionList result = await account.ListSessions(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-email.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-email.md deleted file mode 100644 index 990202c952..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-email.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -User result = await account.UpdateEmail( - email: "email@example.com", - password: "password" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-m-f-a.md deleted file mode 100644 index 1604d7d0b2..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-m-f-a.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -User result = await account.UpdateMFA( - mfa: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 5964385630..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -Session result = await account.UpdateMagicURLSession( - userId: "<USER_ID>", - secret: "<SECRET>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-authenticator.md deleted file mode 100644 index 8f8cb09ffa..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -User result = await account.UpdateMfaAuthenticator( - type: AuthenticatorType.Totp, - otp: "<OTP>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-challenge.md deleted file mode 100644 index acf51e5093..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - - result = await account.UpdateMfaChallenge( - challengeId: "<CHALLENGE_ID>", - otp: "<OTP>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index 2733351ed1..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -MfaRecoveryCodes result = await account.UpdateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-name.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-name.md deleted file mode 100644 index 6979848f72..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-name.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -User result = await account.UpdateName( - name: "<NAME>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-password.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-password.md deleted file mode 100644 index 14aceaa2d1..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-password.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -User result = await account.UpdatePassword( - password: "", - oldPassword: "password" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-session.md deleted file mode 100644 index f3d6bf5da7..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-session.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -Session result = await account.UpdatePhoneSession( - userId: "<USER_ID>", - secret: "<SECRET>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-verification.md deleted file mode 100644 index e63f1a7cd6..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-phone-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -Token result = await account.UpdatePhoneVerification( - userId: "<USER_ID>", - secret: "<SECRET>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-phone.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-phone.md deleted file mode 100644 index 21ecfa585b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-phone.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -User result = await account.UpdatePhone( - phone: "+12065550100", - password: "password" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-prefs.md deleted file mode 100644 index a56f3ea7ec..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -User result = await account.UpdatePrefs( - prefs: [object] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-recovery.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-recovery.md deleted file mode 100644 index 6836da6710..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-recovery.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -Token result = await account.UpdateRecovery( - userId: "<USER_ID>", - secret: "<SECRET>", - password: "" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-session.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-session.md deleted file mode 100644 index 36c4ad345f..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-session.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -Session result = await account.UpdateSession( - sessionId: "<SESSION_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-status.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-status.md deleted file mode 100644 index eb66de894b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-status.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -User result = await account.UpdateStatus(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/account/update-verification.md b/docs/examples/1.6.x/server-dotnet/examples/account/update-verification.md deleted file mode 100644 index 0a60c554b8..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/account/update-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Account account = new Account(client); - -Token result = await account.UpdateVerification( - userId: "<USER_ID>", - secret: "<SECRET>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-browser.md deleted file mode 100644 index 6c7adb8a5d..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-browser.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -byte[] result = await avatars.GetBrowser( - code: Browser.AvantBrowser, - width: 0, // optional - height: 0, // optional - quality: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-credit-card.md deleted file mode 100644 index 2b6151dfcd..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -byte[] result = await avatars.GetCreditCard( - code: CreditCard.AmericanExpress, - width: 0, // optional - height: 0, // optional - quality: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-favicon.md deleted file mode 100644 index 8e6f170200..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-favicon.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -byte[] result = await avatars.GetFavicon( - url: "https://example.com" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-flag.md deleted file mode 100644 index 9e1ac41041..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-flag.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -byte[] result = await avatars.GetFlag( - code: Flag.Afghanistan, - width: 0, // optional - height: 0, // optional - quality: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-image.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-image.md deleted file mode 100644 index 1af7dc05e2..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-image.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -byte[] result = await avatars.GetImage( - url: "https://example.com", - width: 0, // optional - height: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-initials.md deleted file mode 100644 index 745eb47fbc..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-initials.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -byte[] result = await avatars.GetInitials( - name: "<NAME>", // optional - width: 0, // optional - height: 0, // optional - background: "" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-dotnet/examples/avatars/get-q-r.md deleted file mode 100644 index defeb130dc..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/avatars/get-q-r.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -byte[] result = await avatars.GetQR( - text: "<TEXT>", - size: 1, // optional - margin: 0, // optional - download: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-boolean-attribute.md deleted file mode 100644 index 6c6793cb8f..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeBoolean result = await databases.CreateBooleanAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: false, // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-collection.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-collection.md deleted file mode 100644 index 43fd90d516..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-collection.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -Collection result = await databases.CreateCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - name: "<NAME>", - permissions: ["read("any")"], // optional - documentSecurity: false, // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-datetime-attribute.md deleted file mode 100644 index b2a35549e1..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeDatetime result = await databases.CreateDatetimeAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "", // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-document.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-document.md deleted file mode 100644 index 16fa53ca38..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-document.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Databases databases = new Databases(client); - -Document result = await databases.CreateDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - data: [object], - permissions: ["read("any")"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-email-attribute.md deleted file mode 100644 index ff8a6fbe3c..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeEmail result = await databases.CreateEmailAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "email@example.com", // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-enum-attribute.md deleted file mode 100644 index 6b714e0e1d..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeEnum result = await databases.CreateEnumAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - elements: new List<string>(), - required: false, - default: "<DEFAULT>", // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-float-attribute.md deleted file mode 100644 index fc38da07ef..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeFloat result = await databases.CreateFloatAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, // optional - max: 0, // optional - default: 0, // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-index.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-index.md deleted file mode 100644 index cee911120d..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-index.md +++ /dev/null @@ -1,20 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -Index result = await databases.CreateIndex( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - type: IndexType.Key, - attributes: new List<string>(), - orders: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-integer-attribute.md deleted file mode 100644 index 91f8d422a3..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeInteger result = await databases.CreateIntegerAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, // optional - max: 0, // optional - default: 0, // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-ip-attribute.md deleted file mode 100644 index 912c553eba..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeIp result = await databases.CreateIpAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "", // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-relationship-attribute.md deleted file mode 100644 index a749ab2df2..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeRelationship result = await databases.CreateRelationshipAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - relatedCollectionId: "<RELATED_COLLECTION_ID>", - type: RelationshipType.OneToOne, - twoWay: false, // optional - key: "", // optional - twoWayKey: "", // optional - onDelete: RelationMutate.Cascade // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-string-attribute.md deleted file mode 100644 index 09a05c692c..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeString result = await databases.CreateStringAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - size: 1, - required: false, - default: "<DEFAULT>", // optional - array: false, // optional - encrypt: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create-url-attribute.md deleted file mode 100644 index 397ba17731..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeUrl result = await databases.CreateUrlAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "https://example.com", // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/create.md b/docs/examples/1.6.x/server-dotnet/examples/databases/create.md deleted file mode 100644 index b8f58e117c..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/create.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -Database result = await databases.Create( - databaseId: "<DATABASE_ID>", - name: "<NAME>", - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-attribute.md deleted file mode 100644 index 12a702de52..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -await databases.DeleteAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-collection.md deleted file mode 100644 index 0a5e837ac9..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-collection.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -await databases.DeleteCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-document.md b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-document.md deleted file mode 100644 index b986508afd..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-document.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Databases databases = new Databases(client); - -await databases.DeleteDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-index.md b/docs/examples/1.6.x/server-dotnet/examples/databases/delete-index.md deleted file mode 100644 index 5dd53c0143..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/delete-index.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -await databases.DeleteIndex( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/delete.md b/docs/examples/1.6.x/server-dotnet/examples/databases/delete.md deleted file mode 100644 index 8358d953a3..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -await databases.Delete( - databaseId: "<DATABASE_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/get-attribute.md deleted file mode 100644 index d5ecf81daa..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/get-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - - result = await databases.GetAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/get-collection.md b/docs/examples/1.6.x/server-dotnet/examples/databases/get-collection.md deleted file mode 100644 index 1fc63dc84b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/get-collection.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -Collection result = await databases.GetCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/get-document.md b/docs/examples/1.6.x/server-dotnet/examples/databases/get-document.md deleted file mode 100644 index 624639a46b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/get-document.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Databases databases = new Databases(client); - -Document result = await databases.GetDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/get-index.md b/docs/examples/1.6.x/server-dotnet/examples/databases/get-index.md deleted file mode 100644 index c8bef4d687..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/get-index.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -Index result = await databases.GetIndex( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/get.md b/docs/examples/1.6.x/server-dotnet/examples/databases/get.md deleted file mode 100644 index 9ce607c6c5..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/get.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -Database result = await databases.Get( - databaseId: "<DATABASE_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-dotnet/examples/databases/list-attributes.md deleted file mode 100644 index dd467262a4..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/list-attributes.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeList result = await databases.ListAttributes( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/list-collections.md b/docs/examples/1.6.x/server-dotnet/examples/databases/list-collections.md deleted file mode 100644 index 99341e3e00..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/list-collections.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -CollectionList result = await databases.ListCollections( - databaseId: "<DATABASE_ID>", - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/list-documents.md b/docs/examples/1.6.x/server-dotnet/examples/databases/list-documents.md deleted file mode 100644 index 1cc45b4fec..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/list-documents.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Databases databases = new Databases(client); - -DocumentList result = await databases.ListDocuments( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-dotnet/examples/databases/list-indexes.md deleted file mode 100644 index ebf0040f9b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/list-indexes.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -IndexList result = await databases.ListIndexes( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/list.md b/docs/examples/1.6.x/server-dotnet/examples/databases/list.md deleted file mode 100644 index 1fe1db1b0d..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/list.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -DatabaseList result = await databases.List( - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-boolean-attribute.md deleted file mode 100644 index e8356d0f4d..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeBoolean result = await databases.UpdateBooleanAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-collection.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-collection.md deleted file mode 100644 index 4238bd0597..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-collection.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -Collection result = await databases.UpdateCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - name: "<NAME>", - permissions: ["read("any")"], // optional - documentSecurity: false, // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-datetime-attribute.md deleted file mode 100644 index da1c6462b4..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeDatetime result = await databases.UpdateDatetimeAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-document.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-document.md deleted file mode 100644 index ee57ce6868..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-document.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Databases databases = new Databases(client); - -Document result = await databases.UpdateDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - data: [object], // optional - permissions: ["read("any")"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-email-attribute.md deleted file mode 100644 index e38a1773d8..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeEmail result = await databases.UpdateEmailAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "email@example.com" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-enum-attribute.md deleted file mode 100644 index 5c1bef8d87..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeEnum result = await databases.UpdateEnumAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - elements: new List<string>(), - required: false, - default: "<DEFAULT>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-float-attribute.md deleted file mode 100644 index ac21ad76ea..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeFloat result = await databases.UpdateFloatAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, - max: 0, - default: 0 -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-integer-attribute.md deleted file mode 100644 index d15a7658fe..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeInteger result = await databases.UpdateIntegerAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, - max: 0, - default: 0 -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-ip-attribute.md deleted file mode 100644 index e5f6dbd573..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeIp result = await databases.UpdateIpAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-relationship-attribute.md deleted file mode 100644 index 20f7831f09..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeRelationship result = await databases.UpdateRelationshipAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - onDelete: RelationMutate.Cascade // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-string-attribute.md deleted file mode 100644 index 87a8d1ef59..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeString result = await databases.UpdateStringAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "<DEFAULT>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update-url-attribute.md deleted file mode 100644 index 9f98a83f46..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -AttributeUrl result = await databases.UpdateUrlAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "https://example.com" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/databases/update.md b/docs/examples/1.6.x/server-dotnet/examples/databases/update.md deleted file mode 100644 index d52854a81b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/databases/update.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -Database result = await databases.Update( - databaseId: "<DATABASE_ID>", - name: "<NAME>", - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/create-build.md b/docs/examples/1.6.x/server-dotnet/examples/functions/create-build.md deleted file mode 100644 index fab595261f..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/create-build.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - - result = await functions.CreateBuild( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>", - buildId: "<BUILD_ID>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-dotnet/examples/functions/create-deployment.md deleted file mode 100644 index 88333e1ef1..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/create-deployment.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -Deployment result = await functions.CreateDeployment( - functionId: "<FUNCTION_ID>", - code: InputFile.FromPath("./path-to-files/image.jpg"), - activate: false, - entrypoint: "<ENTRYPOINT>", // optional - commands: "<COMMANDS>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/create-execution.md b/docs/examples/1.6.x/server-dotnet/examples/functions/create-execution.md deleted file mode 100644 index fb688cd01d..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/create-execution.md +++ /dev/null @@ -1,21 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Functions functions = new Functions(client); - -Execution result = await functions.CreateExecution( - functionId: "<FUNCTION_ID>", - body: "<BODY>", // optional - async: false, // optional - path: "<PATH>", // optional - method: ExecutionMethod.GET, // optional - headers: [object], // optional - scheduledAt: "" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/create-variable.md b/docs/examples/1.6.x/server-dotnet/examples/functions/create-variable.md deleted file mode 100644 index c8aa350af7..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/create-variable.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -Variable result = await functions.CreateVariable( - functionId: "<FUNCTION_ID>", - key: "<KEY>", - value: "<VALUE>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/create.md b/docs/examples/1.6.x/server-dotnet/examples/functions/create.md deleted file mode 100644 index 880a68ce3d..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/create.md +++ /dev/null @@ -1,35 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -Function result = await functions.Create( - functionId: "<FUNCTION_ID>", - name: "<NAME>", - runtime: .Node145, - execute: ["any"], // optional - events: new List<string>(), // optional - schedule: "", // optional - timeout: 1, // optional - enabled: false, // optional - logging: false, // optional - entrypoint: "<ENTRYPOINT>", // optional - commands: "<COMMANDS>", // optional - scopes: new List<string>(), // optional - installationId: "<INSTALLATION_ID>", // optional - providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", // optional - providerBranch: "<PROVIDER_BRANCH>", // optional - providerSilentMode: false, // optional - providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", // optional - templateRepository: "<TEMPLATE_REPOSITORY>", // optional - templateOwner: "<TEMPLATE_OWNER>", // optional - templateRootDirectory: "<TEMPLATE_ROOT_DIRECTORY>", // optional - templateBranch: "<TEMPLATE_BRANCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-dotnet/examples/functions/delete-deployment.md deleted file mode 100644 index c0aca0d19e..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/delete-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -await functions.DeleteDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-dotnet/examples/functions/delete-execution.md deleted file mode 100644 index 682d0e3dc8..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/delete-execution.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -await functions.DeleteExecution( - functionId: "<FUNCTION_ID>", - executionId: "<EXECUTION_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-dotnet/examples/functions/delete-variable.md deleted file mode 100644 index e08c0dfed2..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/delete-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -await functions.DeleteVariable( - functionId: "<FUNCTION_ID>", - variableId: "<VARIABLE_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/delete.md b/docs/examples/1.6.x/server-dotnet/examples/functions/delete.md deleted file mode 100644 index 2605aec24a..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -await functions.Delete( - functionId: "<FUNCTION_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-dotnet/examples/functions/download-deployment.md deleted file mode 100644 index 02fd5a59f1..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/download-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -byte[] result = await functions.DownloadDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-dotnet/examples/functions/get-deployment.md deleted file mode 100644 index d19b66ee52..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/get-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -Deployment result = await functions.GetDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/get-execution.md b/docs/examples/1.6.x/server-dotnet/examples/functions/get-execution.md deleted file mode 100644 index 08fea9f510..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/get-execution.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Functions functions = new Functions(client); - -Execution result = await functions.GetExecution( - functionId: "<FUNCTION_ID>", - executionId: "<EXECUTION_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/get-variable.md b/docs/examples/1.6.x/server-dotnet/examples/functions/get-variable.md deleted file mode 100644 index a441229209..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/get-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -Variable result = await functions.GetVariable( - functionId: "<FUNCTION_ID>", - variableId: "<VARIABLE_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/get.md b/docs/examples/1.6.x/server-dotnet/examples/functions/get.md deleted file mode 100644 index 39d846f1a5..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/get.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -Function result = await functions.Get( - functionId: "<FUNCTION_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-dotnet/examples/functions/list-deployments.md deleted file mode 100644 index 8d2f6837ee..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/list-deployments.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -DeploymentList result = await functions.ListDeployments( - functionId: "<FUNCTION_ID>", - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/list-executions.md b/docs/examples/1.6.x/server-dotnet/examples/functions/list-executions.md deleted file mode 100644 index 6e8478a1f2..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/list-executions.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Functions functions = new Functions(client); - -ExecutionList result = await functions.ListExecutions( - functionId: "<FUNCTION_ID>", - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-dotnet/examples/functions/list-runtimes.md deleted file mode 100644 index 8974e02c2b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/list-runtimes.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -RuntimeList result = await functions.ListRuntimes(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/list-variables.md b/docs/examples/1.6.x/server-dotnet/examples/functions/list-variables.md deleted file mode 100644 index 07f25ebc45..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/list-variables.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -VariableList result = await functions.ListVariables( - functionId: "<FUNCTION_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/list.md b/docs/examples/1.6.x/server-dotnet/examples/functions/list.md deleted file mode 100644 index 820647ac83..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/list.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -FunctionList result = await functions.List( - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment-build.md deleted file mode 100644 index bee45aef19..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -Build result = await functions.UpdateDeploymentBuild( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment.md deleted file mode 100644 index 12fcb9627c..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/update-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -Function result = await functions.UpdateDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/update-variable.md b/docs/examples/1.6.x/server-dotnet/examples/functions/update-variable.md deleted file mode 100644 index 68d700b66b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/update-variable.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -Variable result = await functions.UpdateVariable( - functionId: "<FUNCTION_ID>", - variableId: "<VARIABLE_ID>", - key: "<KEY>", - value: "<VALUE>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/functions/update.md b/docs/examples/1.6.x/server-dotnet/examples/functions/update.md deleted file mode 100644 index cfea7cd3dc..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/functions/update.md +++ /dev/null @@ -1,31 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -Function result = await functions.Update( - functionId: "<FUNCTION_ID>", - name: "<NAME>", - runtime: .Node145, // optional - execute: ["any"], // optional - events: new List<string>(), // optional - schedule: "", // optional - timeout: 1, // optional - enabled: false, // optional - logging: false, // optional - entrypoint: "<ENTRYPOINT>", // optional - commands: "<COMMANDS>", // optional - scopes: new List<string>(), // optional - installationId: "<INSTALLATION_ID>", // optional - providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", // optional - providerBranch: "<PROVIDER_BRANCH>", // optional - providerSilentMode: false, // optional - providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/graphql/mutation.md b/docs/examples/1.6.x/server-dotnet/examples/graphql/mutation.md deleted file mode 100644 index ac78156a9a..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/graphql/mutation.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Graphql graphql = new Graphql(client); - -Any result = await graphql.Mutation( - query: [object] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/graphql/query.md b/docs/examples/1.6.x/server-dotnet/examples/graphql/query.md deleted file mode 100644 index f8ecc7948a..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/graphql/query.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Graphql graphql = new Graphql(client); - -Any result = await graphql.Query( - query: [object] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-antivirus.md deleted file mode 100644 index e4bfbe5769..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-antivirus.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthAntivirus result = await health.GetAntivirus(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-cache.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-cache.md deleted file mode 100644 index 7c3495c67c..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-cache.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthStatus result = await health.GetCache(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-certificate.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-certificate.md deleted file mode 100644 index fbab107225..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-certificate.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthCertificate result = await health.GetCertificate( - domain: "" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-d-b.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-d-b.md deleted file mode 100644 index 5b42c312a3..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-d-b.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthStatus result = await health.GetDB(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-failed-jobs.md deleted file mode 100644 index 3ca51b6474..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetFailedJobs( - name: .V1Database, - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-pub-sub.md deleted file mode 100644 index 52d7b1bc74..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-pub-sub.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthStatus result = await health.GetPubSub(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-builds.md deleted file mode 100644 index 98d2d10f2b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-builds.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueBuilds( - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-certificates.md deleted file mode 100644 index 4b7bc7ff33..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueCertificates( - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-databases.md deleted file mode 100644 index e2dec7775e..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-databases.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueDatabases( - name: "<NAME>", // optional - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-deletes.md deleted file mode 100644 index 924f3785bb..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueDeletes( - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-functions.md deleted file mode 100644 index cfc29fb885..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-functions.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueFunctions( - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-logs.md deleted file mode 100644 index ae0c85e4ea..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueLogs( - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-mails.md deleted file mode 100644 index b747dec22e..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-mails.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueMails( - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-messaging.md deleted file mode 100644 index bc8d6fcc4d..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueMessaging( - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-migrations.md deleted file mode 100644 index 92539ea42b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueMigrations( - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage-dump.md deleted file mode 100644 index 9338172583..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueUsageDump( - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage.md deleted file mode 100644 index 07e7c4d761..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-usage.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueUsage( - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-webhooks.md deleted file mode 100644 index e6da4beac8..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthQueue result = await health.GetQueueWebhooks( - threshold: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-queue.md deleted file mode 100644 index 7cd0e355bc..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-queue.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthStatus result = await health.GetQueue(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-storage-local.md deleted file mode 100644 index 8aa1554008..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-storage-local.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthStatus result = await health.GetStorageLocal(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-storage.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-storage.md deleted file mode 100644 index 445e1f6c28..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-storage.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthStatus result = await health.GetStorage(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get-time.md b/docs/examples/1.6.x/server-dotnet/examples/health/get-time.md deleted file mode 100644 index 07297cf4c7..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get-time.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthTime result = await health.GetTime(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/health/get.md b/docs/examples/1.6.x/server-dotnet/examples/health/get.md deleted file mode 100644 index bac7246117..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/health/get.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -HealthStatus result = await health.Get(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/get.md b/docs/examples/1.6.x/server-dotnet/examples/locale/get.md deleted file mode 100644 index 2739b8f72c..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/locale/get.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -Locale result = await locale.Get(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-codes.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-codes.md deleted file mode 100644 index ed10936a6c..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/locale/list-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -LocaleCodeList result = await locale.ListCodes(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-continents.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-continents.md deleted file mode 100644 index bdbcb0e9ed..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/locale/list-continents.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -ContinentList result = await locale.ListContinents(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-e-u.md deleted file mode 100644 index bd634fb2f9..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -CountryList result = await locale.ListCountriesEU(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-phones.md deleted file mode 100644 index fc774574b5..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -PhoneList result = await locale.ListCountriesPhones(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries.md deleted file mode 100644 index 423611d91f..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/locale/list-countries.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -CountryList result = await locale.ListCountries(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-currencies.md deleted file mode 100644 index 248d01727a..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/locale/list-currencies.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -CurrencyList result = await locale.ListCurrencies(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/locale/list-languages.md b/docs/examples/1.6.x/server-dotnet/examples/locale/list-languages.md deleted file mode 100644 index 41ad81c809..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/locale/list-languages.md +++ /dev/null @@ -1,12 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -LanguageList result = await locale.ListLanguages(); diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-apns-provider.md deleted file mode 100644 index c10bbc0d71..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.CreateApnsProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - authKey: "<AUTH_KEY>", // optional - authKeyId: "<AUTH_KEY_ID>", // optional - teamId: "<TEAM_ID>", // optional - bundleId: "<BUNDLE_ID>", // optional - sandbox: false, // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-email.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-email.md deleted file mode 100644 index f6ab5457be..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-email.md +++ /dev/null @@ -1,25 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Message result = await messaging.CreateEmail( - messageId: "<MESSAGE_ID>", - subject: "<SUBJECT>", - content: "<CONTENT>", - topics: new List<string>(), // optional - users: new List<string>(), // optional - targets: new List<string>(), // optional - cc: new List<string>(), // optional - bcc: new List<string>(), // optional - attachments: new List<string>(), // optional - draft: false, // optional - html: false, // optional - scheduledAt: "" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-fcm-provider.md deleted file mode 100644 index c48efc389f..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.CreateFcmProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - serviceAccountJSON: [object], // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index 034ac71beb..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,23 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.CreateMailgunProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - apiKey: "<API_KEY>", // optional - domain: "<DOMAIN>", // optional - isEuRegion: false, // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "email@example.com", // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-msg91provider.md deleted file mode 100644 index d1442d58c6..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.CreateMsg91Provider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - templateId: "<TEMPLATE_ID>", // optional - senderId: "<SENDER_ID>", // optional - authKey: "<AUTH_KEY>", // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-push.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-push.md deleted file mode 100644 index 8b45b8cda9..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-push.md +++ /dev/null @@ -1,29 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Message result = await messaging.CreatePush( - messageId: "<MESSAGE_ID>", - title: "<TITLE>", - body: "<BODY>", - topics: new List<string>(), // optional - users: new List<string>(), // optional - targets: new List<string>(), // optional - data: [object], // optional - action: "<ACTION>", // optional - image: "[ID1:ID2]", // optional - icon: "<ICON>", // optional - sound: "<SOUND>", // optional - color: "<COLOR>", // optional - tag: "<TAG>", // optional - badge: "<BADGE>", // optional - draft: false, // optional - scheduledAt: "" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index 12969698bd..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.CreateSendgridProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - apiKey: "<API_KEY>", // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "email@example.com", // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sms.md deleted file mode 100644 index d9aa79ff8c..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-sms.md +++ /dev/null @@ -1,20 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Message result = await messaging.CreateSms( - messageId: "<MESSAGE_ID>", - content: "<CONTENT>", - topics: new List<string>(), // optional - users: new List<string>(), // optional - targets: new List<string>(), // optional - draft: false, // optional - scheduledAt: "" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-smtp-provider.md deleted file mode 100644 index 5a2e65f95f..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.CreateSmtpProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - host: "<HOST>", - port: 1, // optional - username: "<USERNAME>", // optional - password: "<PASSWORD>", // optional - encryption: SmtpEncryption.None, // optional - autoTLS: false, // optional - mailer: "<MAILER>", // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "email@example.com", // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-subscriber.md deleted file mode 100644 index ae0bd90e38..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetJWT("<YOUR_JWT>"); // Your secret JSON Web Token - -Messaging messaging = new Messaging(client); - -Subscriber result = await messaging.CreateSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>", - targetId: "<TARGET_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-telesign-provider.md deleted file mode 100644 index 8bfe9cfaac..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.CreateTelesignProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", // optional - customerId: "<CUSTOMER_ID>", // optional - apiKey: "<API_KEY>", // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index a9c73f9eb6..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.CreateTextmagicProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", // optional - username: "<USERNAME>", // optional - apiKey: "<API_KEY>", // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-topic.md deleted file mode 100644 index 2d8f78ac15..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-topic.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Topic result = await messaging.CreateTopic( - topicId: "<TOPIC_ID>", - name: "<NAME>", - subscribe: ["any"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-twilio-provider.md deleted file mode 100644 index 760be4691d..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.CreateTwilioProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", // optional - accountSid: "<ACCOUNT_SID>", // optional - authToken: "<AUTH_TOKEN>", // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/create-vonage-provider.md deleted file mode 100644 index 762930d066..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.CreateVonageProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", // optional - apiKey: "<API_KEY>", // optional - apiSecret: "<API_SECRET>", // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-provider.md deleted file mode 100644 index e2ec88d320..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-provider.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -await messaging.DeleteProvider( - providerId: "<PROVIDER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-subscriber.md deleted file mode 100644 index a2e9fab7e0..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetJWT("<YOUR_JWT>"); // Your secret JSON Web Token - -Messaging messaging = new Messaging(client); - -await messaging.DeleteSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-topic.md deleted file mode 100644 index 807431e5af..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -await messaging.DeleteTopic( - topicId: "<TOPIC_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/delete.md deleted file mode 100644 index 5cbd9c62e9..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -await messaging.Delete( - messageId: "<MESSAGE_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-message.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-message.md deleted file mode 100644 index 48a59fcc36..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-message.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Message result = await messaging.GetMessage( - messageId: "<MESSAGE_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-provider.md deleted file mode 100644 index 7aa8d02086..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-provider.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.GetProvider( - providerId: "<PROVIDER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-subscriber.md deleted file mode 100644 index addeb0589f..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Subscriber result = await messaging.GetSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/get-topic.md deleted file mode 100644 index 3f6adac550..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/get-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Topic result = await messaging.GetTopic( - topicId: "<TOPIC_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-message-logs.md deleted file mode 100644 index a391a5f28d..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -LogList result = await messaging.ListMessageLogs( - messageId: "<MESSAGE_ID>", - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-messages.md deleted file mode 100644 index ef3beafeca..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-messages.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -MessageList result = await messaging.ListMessages( - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-provider-logs.md deleted file mode 100644 index 877fed54ab..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -LogList result = await messaging.ListProviderLogs( - providerId: "<PROVIDER_ID>", - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-providers.md deleted file mode 100644 index c52c95be75..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-providers.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -ProviderList result = await messaging.ListProviders( - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index c63b654167..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -LogList result = await messaging.ListSubscriberLogs( - subscriberId: "<SUBSCRIBER_ID>", - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscribers.md deleted file mode 100644 index 6bcd7acbee..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -SubscriberList result = await messaging.ListSubscribers( - topicId: "<TOPIC_ID>", - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-targets.md deleted file mode 100644 index 13c616d909..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-targets.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -TargetList result = await messaging.ListTargets( - messageId: "<MESSAGE_ID>", - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topic-logs.md deleted file mode 100644 index 2089b5ea3c..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -LogList result = await messaging.ListTopicLogs( - topicId: "<TOPIC_ID>", - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topics.md deleted file mode 100644 index a0d3074673..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/list-topics.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -TopicList result = await messaging.ListTopics( - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-apns-provider.md deleted file mode 100644 index 7ac93b80f5..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.UpdateApnsProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - authKey: "<AUTH_KEY>", // optional - authKeyId: "<AUTH_KEY_ID>", // optional - teamId: "<TEAM_ID>", // optional - bundleId: "<BUNDLE_ID>", // optional - sandbox: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-email.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-email.md deleted file mode 100644 index 2e37a967a8..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-email.md +++ /dev/null @@ -1,25 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Message result = await messaging.UpdateEmail( - messageId: "<MESSAGE_ID>", - topics: new List<string>(), // optional - users: new List<string>(), // optional - targets: new List<string>(), // optional - subject: "<SUBJECT>", // optional - content: "<CONTENT>", // optional - draft: false, // optional - html: false, // optional - cc: new List<string>(), // optional - bcc: new List<string>(), // optional - scheduledAt: "", // optional - attachments: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-fcm-provider.md deleted file mode 100644 index 363edb346e..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.UpdateFcmProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - serviceAccountJSON: [object] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index 8df2b85c4b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,23 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.UpdateMailgunProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - apiKey: "<API_KEY>", // optional - domain: "<DOMAIN>", // optional - isEuRegion: false, // optional - enabled: false, // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "<REPLY_TO_EMAIL>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-msg91provider.md deleted file mode 100644 index 4dca186680..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.UpdateMsg91Provider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - templateId: "<TEMPLATE_ID>", // optional - senderId: "<SENDER_ID>", // optional - authKey: "<AUTH_KEY>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-push.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-push.md deleted file mode 100644 index 1d68ddfd50..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-push.md +++ /dev/null @@ -1,29 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Message result = await messaging.UpdatePush( - messageId: "<MESSAGE_ID>", - topics: new List<string>(), // optional - users: new List<string>(), // optional - targets: new List<string>(), // optional - title: "<TITLE>", // optional - body: "<BODY>", // optional - data: [object], // optional - action: "<ACTION>", // optional - image: "[ID1:ID2]", // optional - icon: "<ICON>", // optional - sound: "<SOUND>", // optional - color: "<COLOR>", // optional - tag: "<TAG>", // optional - badge: 0, // optional - draft: false, // optional - scheduledAt: "" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index 33387e5bc9..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.UpdateSendgridProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - apiKey: "<API_KEY>", // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "<REPLY_TO_EMAIL>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sms.md deleted file mode 100644 index 8d02a37945..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-sms.md +++ /dev/null @@ -1,20 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Message result = await messaging.UpdateSms( - messageId: "<MESSAGE_ID>", - topics: new List<string>(), // optional - users: new List<string>(), // optional - targets: new List<string>(), // optional - content: "<CONTENT>", // optional - draft: false, // optional - scheduledAt: "" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-smtp-provider.md deleted file mode 100644 index df288179f7..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.UpdateSmtpProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - host: "<HOST>", // optional - port: 1, // optional - username: "<USERNAME>", // optional - password: "<PASSWORD>", // optional - encryption: SmtpEncryption.None, // optional - autoTLS: false, // optional - mailer: "<MAILER>", // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "<REPLY_TO_EMAIL>", // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-telesign-provider.md deleted file mode 100644 index a91adf2dff..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.UpdateTelesignProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - customerId: "<CUSTOMER_ID>", // optional - apiKey: "<API_KEY>", // optional - from: "<FROM>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index 1d47ac1f57..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.UpdateTextmagicProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - username: "<USERNAME>", // optional - apiKey: "<API_KEY>", // optional - from: "<FROM>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-topic.md deleted file mode 100644 index 8999d6e258..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-topic.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Topic result = await messaging.UpdateTopic( - topicId: "<TOPIC_ID>", - name: "<NAME>", // optional - subscribe: ["any"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-twilio-provider.md deleted file mode 100644 index 749cb670ed..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.UpdateTwilioProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - accountSid: "<ACCOUNT_SID>", // optional - authToken: "<AUTH_TOKEN>", // optional - from: "<FROM>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-dotnet/examples/messaging/update-vonage-provider.md deleted file mode 100644 index b3c317c349..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -Provider result = await messaging.UpdateVonageProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - apiKey: "<API_KEY>", // optional - apiSecret: "<API_SECRET>", // optional - from: "<FROM>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-dotnet/examples/storage/create-bucket.md deleted file mode 100644 index d79549155e..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/create-bucket.md +++ /dev/null @@ -1,24 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Storage storage = new Storage(client); - -Bucket result = await storage.CreateBucket( - bucketId: "<BUCKET_ID>", - name: "<NAME>", - permissions: ["read("any")"], // optional - fileSecurity: false, // optional - enabled: false, // optional - maximumFileSize: 1, // optional - allowedFileExtensions: new List<string>(), // optional - compression: .None, // optional - encryption: false, // optional - antivirus: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/create-file.md b/docs/examples/1.6.x/server-dotnet/examples/storage/create-file.md deleted file mode 100644 index ffeb90d6ef..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/create-file.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -File result = await storage.CreateFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - file: InputFile.FromPath("./path-to-files/image.jpg"), - permissions: ["read("any")"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-dotnet/examples/storage/delete-bucket.md deleted file mode 100644 index db7af3a4ce..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/delete-bucket.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Storage storage = new Storage(client); - -await storage.DeleteBucket( - bucketId: "<BUCKET_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/delete-file.md b/docs/examples/1.6.x/server-dotnet/examples/storage/delete-file.md deleted file mode 100644 index fd3eb96d29..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/delete-file.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -await storage.DeleteFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-dotnet/examples/storage/get-bucket.md deleted file mode 100644 index 8c188971f2..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/get-bucket.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Storage storage = new Storage(client); - -Bucket result = await storage.GetBucket( - bucketId: "<BUCKET_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-download.md deleted file mode 100644 index b274cdfdb6..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-download.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -byte[] result = await storage.GetFileDownload( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-preview.md deleted file mode 100644 index 3643747369..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-preview.md +++ /dev/null @@ -1,27 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -byte[] result = await storage.GetFilePreview( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - width: 0, // optional - height: 0, // optional - gravity: ImageGravity.Center, // optional - quality: 0, // optional - borderWidth: 0, // optional - borderColor: "", // optional - borderRadius: 0, // optional - opacity: 0, // optional - rotation: -360, // optional - background: "", // optional - output: ImageFormat.Jpg // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-view.md deleted file mode 100644 index 0356ec1bee..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file-view.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -byte[] result = await storage.GetFileView( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file.md b/docs/examples/1.6.x/server-dotnet/examples/storage/get-file.md deleted file mode 100644 index b861800bc8..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/get-file.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -File result = await storage.GetFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-dotnet/examples/storage/list-buckets.md deleted file mode 100644 index bdb8f21fe7..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/list-buckets.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Storage storage = new Storage(client); - -BucketList result = await storage.ListBuckets( - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/list-files.md b/docs/examples/1.6.x/server-dotnet/examples/storage/list-files.md deleted file mode 100644 index 84869bb564..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/list-files.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -FileList result = await storage.ListFiles( - bucketId: "<BUCKET_ID>", - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-dotnet/examples/storage/update-bucket.md deleted file mode 100644 index e4f85a87b0..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/update-bucket.md +++ /dev/null @@ -1,24 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Storage storage = new Storage(client); - -Bucket result = await storage.UpdateBucket( - bucketId: "<BUCKET_ID>", - name: "<NAME>", - permissions: ["read("any")"], // optional - fileSecurity: false, // optional - enabled: false, // optional - maximumFileSize: 1, // optional - allowedFileExtensions: new List<string>(), // optional - compression: .None, // optional - encryption: false, // optional - antivirus: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/storage/update-file.md b/docs/examples/1.6.x/server-dotnet/examples/storage/update-file.md deleted file mode 100644 index 741b74adcc..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/storage/update-file.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -File result = await storage.UpdateFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - name: "<NAME>", // optional - permissions: ["read("any")"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/create-membership.md b/docs/examples/1.6.x/server-dotnet/examples/teams/create-membership.md deleted file mode 100644 index 1e71650c2e..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/create-membership.md +++ /dev/null @@ -1,20 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -Membership result = await teams.CreateMembership( - teamId: "<TEAM_ID>", - roles: new List<string>(), - email: "email@example.com", // optional - userId: "<USER_ID>", // optional - phone: "+12065550100", // optional - url: "https://example.com", // optional - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/create.md b/docs/examples/1.6.x/server-dotnet/examples/teams/create.md deleted file mode 100644 index 10c925a698..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/create.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -Team result = await teams.Create( - teamId: "<TEAM_ID>", - name: "<NAME>", - roles: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-dotnet/examples/teams/delete-membership.md deleted file mode 100644 index edf88761bb..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/delete-membership.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -await teams.DeleteMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/delete.md b/docs/examples/1.6.x/server-dotnet/examples/teams/delete.md deleted file mode 100644 index 22bd5a8ea4..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -await teams.Delete( - teamId: "<TEAM_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/get-membership.md b/docs/examples/1.6.x/server-dotnet/examples/teams/get-membership.md deleted file mode 100644 index c294385524..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/get-membership.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -Membership result = await teams.GetMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/teams/get-prefs.md deleted file mode 100644 index ccdccb3935..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/get-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -Preferences result = await teams.GetPrefs( - teamId: "<TEAM_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/get.md b/docs/examples/1.6.x/server-dotnet/examples/teams/get.md deleted file mode 100644 index 10549a907e..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/get.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -Team result = await teams.Get( - teamId: "<TEAM_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-dotnet/examples/teams/list-memberships.md deleted file mode 100644 index 2125040d94..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/list-memberships.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -MembershipList result = await teams.ListMemberships( - teamId: "<TEAM_ID>", - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/list.md b/docs/examples/1.6.x/server-dotnet/examples/teams/list.md deleted file mode 100644 index df7ab5e6d3..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/list.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -TeamList result = await teams.List( - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership-status.md deleted file mode 100644 index 61de48e1de..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership-status.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -Membership result = await teams.UpdateMembershipStatus( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>", - userId: "<USER_ID>", - secret: "<SECRET>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership.md b/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership.md deleted file mode 100644 index 40dd9c947f..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/update-membership.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -Membership result = await teams.UpdateMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>", - roles: new List<string>() -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/update-name.md b/docs/examples/1.6.x/server-dotnet/examples/teams/update-name.md deleted file mode 100644 index fed64a981a..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/update-name.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -Team result = await teams.UpdateName( - teamId: "<TEAM_ID>", - name: "<NAME>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/teams/update-prefs.md deleted file mode 100644 index 4547656acf..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/teams/update-prefs.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -Preferences result = await teams.UpdatePrefs( - teamId: "<TEAM_ID>", - prefs: [object] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-argon2user.md deleted file mode 100644 index 1f7eea86e0..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-argon2user.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.CreateArgon2User( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-bcrypt-user.md deleted file mode 100644 index c08650a9bb..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.CreateBcryptUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-j-w-t.md deleted file mode 100644 index d3a3fecc38..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-j-w-t.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -JWT result = await users.CreateJWT( - userId: "<USER_ID>", - sessionId: "<SESSION_ID>", // optional - duration: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-m-d5user.md deleted file mode 100644 index d0f4824ad7..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-m-d5user.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.CreateMD5User( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index 4a725f1bcd..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -MfaRecoveryCodes result = await users.CreateMfaRecoveryCodes( - userId: "<USER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-p-h-pass-user.md deleted file mode 100644 index 02d164b2fe..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,17 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.CreatePHPassUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-s-h-a-user.md deleted file mode 100644 index 26a660bc9a..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,19 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.CreateSHAUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - passwordVersion: PasswordHash.Sha1, // optional - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index 0fdb1136dc..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,20 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.CreateScryptModifiedUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - passwordSalt: "<PASSWORD_SALT>", - passwordSaltSeparator: "<PASSWORD_SALT_SEPARATOR>", - passwordSignerKey: "<PASSWORD_SIGNER_KEY>", - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-user.md deleted file mode 100644 index cd66ae9ea5..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,22 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.CreateScryptUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - passwordSalt: "<PASSWORD_SALT>", - passwordCpu: 0, - passwordMemory: 0, - passwordParallel: 0, - passwordLength: 0, - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-session.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-session.md deleted file mode 100644 index d26cb7e479..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-session.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -Session result = await users.CreateSession( - userId: "<USER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-target.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-target.md deleted file mode 100644 index 3e82d90634..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-target.md +++ /dev/null @@ -1,20 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -Target result = await users.CreateTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>", - providerType: MessagingProviderType.Email, - identifier: "<IDENTIFIER>", - providerId: "<PROVIDER_ID>", // optional - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create-token.md b/docs/examples/1.6.x/server-dotnet/examples/users/create-token.md deleted file mode 100644 index a37e90a8d5..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create-token.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -Token result = await users.CreateToken( - userId: "<USER_ID>", - length: 4, // optional - expire: 60 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/create.md b/docs/examples/1.6.x/server-dotnet/examples/users/create.md deleted file mode 100644 index 2a369f9567..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/create.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.Create( - userId: "<USER_ID>", - email: "email@example.com", // optional - phone: "+12065550100", // optional - password: "", // optional - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete-identity.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete-identity.md deleted file mode 100644 index ec45f5e7e4..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/delete-identity.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -await users.DeleteIdentity( - identityId: "<IDENTITY_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index 074c6c6fe2..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,16 +0,0 @@ -using Appwrite; -using Appwrite.Enums; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -await users.DeleteMfaAuthenticator( - userId: "<USER_ID>", - type: AuthenticatorType.Totp -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete-session.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete-session.md deleted file mode 100644 index 483208d137..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/delete-session.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -await users.DeleteSession( - userId: "<USER_ID>", - sessionId: "<SESSION_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete-sessions.md deleted file mode 100644 index 4d5e68ba3e..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/delete-sessions.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -await users.DeleteSessions( - userId: "<USER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete-target.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete-target.md deleted file mode 100644 index a0f14ccae8..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/delete-target.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -await users.DeleteTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/delete.md b/docs/examples/1.6.x/server-dotnet/examples/users/delete.md deleted file mode 100644 index 95e2fcd362..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -await users.Delete( - userId: "<USER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index c5a8daadb8..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -MfaRecoveryCodes result = await users.GetMfaRecoveryCodes( - userId: "<USER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/get-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/users/get-prefs.md deleted file mode 100644 index edfc8cd5a2..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/get-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -Preferences result = await users.GetPrefs( - userId: "<USER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/get-target.md b/docs/examples/1.6.x/server-dotnet/examples/users/get-target.md deleted file mode 100644 index 6ca5eda798..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/get-target.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -Target result = await users.GetTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/get.md b/docs/examples/1.6.x/server-dotnet/examples/users/get.md deleted file mode 100644 index 58109c4eaa..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/get.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.Get( - userId: "<USER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-identities.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-identities.md deleted file mode 100644 index b64981ca86..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/list-identities.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -IdentityList result = await users.ListIdentities( - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-logs.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-logs.md deleted file mode 100644 index 75529b31a3..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/list-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -LogList result = await users.ListLogs( - userId: "<USER_ID>", - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-memberships.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-memberships.md deleted file mode 100644 index e9e6fb739a..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/list-memberships.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -MembershipList result = await users.ListMemberships( - userId: "<USER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-mfa-factors.md deleted file mode 100644 index e7d9c8bb97..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -MfaFactors result = await users.ListMfaFactors( - userId: "<USER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-sessions.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-sessions.md deleted file mode 100644 index 2b488e1520..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/list-sessions.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -SessionList result = await users.ListSessions( - userId: "<USER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list-targets.md b/docs/examples/1.6.x/server-dotnet/examples/users/list-targets.md deleted file mode 100644 index e6cc0b5748..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/list-targets.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -TargetList result = await users.ListTargets( - userId: "<USER_ID>", - queries: new List<string>() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/list.md b/docs/examples/1.6.x/server-dotnet/examples/users/list.md deleted file mode 100644 index ea880bcaa8..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/list.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -UserList result = await users.List( - queries: new List<string>(), // optional - search: "<SEARCH>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-email-verification.md deleted file mode 100644 index 6154f55524..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-email-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.UpdateEmailVerification( - userId: "<USER_ID>", - emailVerification: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-email.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-email.md deleted file mode 100644 index 1f3e1856be..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-email.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.UpdateEmail( - userId: "<USER_ID>", - email: "email@example.com" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-labels.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-labels.md deleted file mode 100644 index fd0337916b..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-labels.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.UpdateLabels( - userId: "<USER_ID>", - labels: new List<string>() -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index 55a021a7ed..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,14 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -MfaRecoveryCodes result = await users.UpdateMfaRecoveryCodes( - userId: "<USER_ID>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa.md deleted file mode 100644 index 711ca07575..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-mfa.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.UpdateMfa( - userId: "<USER_ID>", - mfa: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-name.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-name.md deleted file mode 100644 index 19add9e9e8..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-name.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.UpdateName( - userId: "<USER_ID>", - name: "<NAME>" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-password.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-password.md deleted file mode 100644 index b11bb28883..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-password.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.UpdatePassword( - userId: "<USER_ID>", - password: "" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-phone-verification.md deleted file mode 100644 index 135359f995..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-phone-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.UpdatePhoneVerification( - userId: "<USER_ID>", - phoneVerification: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-phone.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-phone.md deleted file mode 100644 index 9dd9757ea7..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-phone.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.UpdatePhone( - userId: "<USER_ID>", - number: "+12065550100" -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-prefs.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-prefs.md deleted file mode 100644 index 775fb848a0..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-prefs.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -Preferences result = await users.UpdatePrefs( - userId: "<USER_ID>", - prefs: [object] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-status.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-status.md deleted file mode 100644 index 5e52c4c294..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-status.md +++ /dev/null @@ -1,15 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -User result = await users.UpdateStatus( - userId: "<USER_ID>", - status: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-dotnet/examples/users/update-target.md b/docs/examples/1.6.x/server-dotnet/examples/users/update-target.md deleted file mode 100644 index 0a1387ca43..0000000000 --- a/docs/examples/1.6.x/server-dotnet/examples/users/update-target.md +++ /dev/null @@ -1,18 +0,0 @@ -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("<YOUR_PROJECT_ID>") // Your project ID - .SetKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -Target result = await users.UpdateTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>", - identifier: "<IDENTIFIER>", // optional - providerId: "<PROVIDER_ID>", // optional - name: "<NAME>" // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-graphql/examples/account/create-anonymous-session.md deleted file mode 100644 index 92c12acee5..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,33 +0,0 @@ -mutation { - accountCreateAnonymousSession { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-graphql/examples/account/create-email-password-session.md deleted file mode 100644 index 931bb4add0..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-email-password-session.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountCreateEmailPasswordSession( - email: "email@example.com", - password: "password" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-email-token.md b/docs/examples/1.6.x/server-graphql/examples/account/create-email-token.md deleted file mode 100644 index de320b45ed..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-email-token.md +++ /dev/null @@ -1,14 +0,0 @@ -mutation { - accountCreateEmailToken( - userId: "<USER_ID>", - email: "email@example.com", - phrase: false - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-graphql/examples/account/create-j-w-t.md deleted file mode 100644 index a5204f1256..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-j-w-t.md +++ /dev/null @@ -1,5 +0,0 @@ -mutation { - accountCreateJWT { - jwt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-graphql/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 4024a5b3a9..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,15 +0,0 @@ -mutation { - accountCreateMagicURLToken( - userId: "<USER_ID>", - email: "email@example.com", - url: "https://example.com", - phrase: false - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 6b29292494..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - accountCreateMfaAuthenticator( - type: "totp" - ) { - secret - uri - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-challenge.md deleted file mode 100644 index eb5cba127d..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,10 +0,0 @@ -mutation { - accountCreateMfaChallenge( - factor: "email" - ) { - _id - _createdAt - userId - expire - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index f39b7d080d..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,5 +0,0 @@ -mutation { - accountCreateMfaRecoveryCodes { - recoveryCodes - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-graphql/examples/account/create-phone-token.md deleted file mode 100644 index b56c4eb4e4..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-phone-token.md +++ /dev/null @@ -1,13 +0,0 @@ -mutation { - accountCreatePhoneToken( - userId: "<USER_ID>", - phone: "+12065550100" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-graphql/examples/account/create-phone-verification.md deleted file mode 100644 index a4cad59b1a..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-phone-verification.md +++ /dev/null @@ -1,10 +0,0 @@ -mutation { - accountCreatePhoneVerification { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-recovery.md b/docs/examples/1.6.x/server-graphql/examples/account/create-recovery.md deleted file mode 100644 index ad31fd82d7..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-recovery.md +++ /dev/null @@ -1,13 +0,0 @@ -mutation { - accountCreateRecovery( - email: "email@example.com", - url: "https://example.com" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-session.md b/docs/examples/1.6.x/server-graphql/examples/account/create-session.md deleted file mode 100644 index f473d14207..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-session.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountCreateSession( - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create-verification.md b/docs/examples/1.6.x/server-graphql/examples/account/create-verification.md deleted file mode 100644 index df50dda529..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -mutation { - accountCreateVerification( - url: "https://example.com" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/create.md b/docs/examples/1.6.x/server-graphql/examples/account/create.md deleted file mode 100644 index 3f8e3c3cf7..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/create.md +++ /dev/null @@ -1,39 +0,0 @@ -mutation { - accountCreate( - userId: "<USER_ID>", - email: "email@example.com", - password: "", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/delete-identity.md b/docs/examples/1.6.x/server-graphql/examples/account/delete-identity.md deleted file mode 100644 index f3c2e2e7b9..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/delete-identity.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - accountDeleteIdentity( - identityId: "<IDENTITY_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-graphql/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index fc5486623a..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - accountDeleteMfaAuthenticator( - type: "totp" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/delete-session.md b/docs/examples/1.6.x/server-graphql/examples/account/delete-session.md deleted file mode 100644 index 09aff38fdd..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/delete-session.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - accountDeleteSession( - sessionId: "<SESSION_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-graphql/examples/account/delete-sessions.md deleted file mode 100644 index b0d61daa81..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/delete-sessions.md +++ /dev/null @@ -1,5 +0,0 @@ -mutation { - accountDeleteSessions { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index e2de72b57f..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,5 +0,0 @@ -query { - accountGetMfaRecoveryCodes { - recoveryCodes - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/get-prefs.md b/docs/examples/1.6.x/server-graphql/examples/account/get-prefs.md deleted file mode 100644 index 6cb48d2b58..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/get-prefs.md +++ /dev/null @@ -1,5 +0,0 @@ -query { - accountGetPrefs { - data - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/get-session.md b/docs/examples/1.6.x/server-graphql/examples/account/get-session.md deleted file mode 100644 index 65c824f68b..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/get-session.md +++ /dev/null @@ -1,35 +0,0 @@ -query { - accountGetSession( - sessionId: "<SESSION_ID>" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/get.md b/docs/examples/1.6.x/server-graphql/examples/account/get.md deleted file mode 100644 index e4db8f0e41..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/get.md +++ /dev/null @@ -1,34 +0,0 @@ -query { - accountGet { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/list-identities.md b/docs/examples/1.6.x/server-graphql/examples/account/list-identities.md deleted file mode 100644 index b7a2a6d39a..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/list-identities.md +++ /dev/null @@ -1,19 +0,0 @@ -query { - accountListIdentities( - queries: [] - ) { - total - identities { - _id - _createdAt - _updatedAt - userId - provider - providerUid - providerEmail - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/list-logs.md b/docs/examples/1.6.x/server-graphql/examples/account/list-logs.md deleted file mode 100644 index 1e17b2f69f..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/list-logs.md +++ /dev/null @@ -1,30 +0,0 @@ -query { - accountListLogs( - queries: [] - ) { - total - logs { - event - userId - userEmail - userName - mode - ip - time - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-graphql/examples/account/list-mfa-factors.md deleted file mode 100644 index 2a78b901b3..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,8 +0,0 @@ -query { - accountListMfaFactors { - totp - phone - email - recoveryCode - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/list-sessions.md b/docs/examples/1.6.x/server-graphql/examples/account/list-sessions.md deleted file mode 100644 index 6d45f1d4ae..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/list-sessions.md +++ /dev/null @@ -1,36 +0,0 @@ -query { - accountListSessions { - total - sessions { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-email.md b/docs/examples/1.6.x/server-graphql/examples/account/update-email.md deleted file mode 100644 index b207bad4bb..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-email.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - accountUpdateEmail( - email: "email@example.com", - password: "password" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-graphql/examples/account/update-m-f-a.md deleted file mode 100644 index d2cd3d6ae5..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-m-f-a.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountUpdateMFA( - mfa: false - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-graphql/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 075bc91d17..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountUpdateMagicURLSession( - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-authenticator.md deleted file mode 100644 index c74062c7d4..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - accountUpdateMfaAuthenticator( - type: "totp", - otp: "<OTP>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-challenge.md deleted file mode 100644 index 8237431bcf..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - accountUpdateMfaChallenge( - challengeId: "<CHALLENGE_ID>", - otp: "<OTP>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index e706d2b9d7..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,5 +0,0 @@ -mutation { - accountUpdateMfaRecoveryCodes { - recoveryCodes - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-name.md b/docs/examples/1.6.x/server-graphql/examples/account/update-name.md deleted file mode 100644 index 850b5760a0..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-name.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountUpdateName( - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-password.md b/docs/examples/1.6.x/server-graphql/examples/account/update-password.md deleted file mode 100644 index 5904da0842..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-password.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - accountUpdatePassword( - password: "", - oldPassword: "password" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-graphql/examples/account/update-phone-session.md deleted file mode 100644 index 199e774ab0..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-phone-session.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountUpdatePhoneSession( - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-graphql/examples/account/update-phone-verification.md deleted file mode 100644 index dd62298bb9..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -mutation { - accountUpdatePhoneVerification( - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-phone.md b/docs/examples/1.6.x/server-graphql/examples/account/update-phone.md deleted file mode 100644 index 408a203300..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-phone.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - accountUpdatePhone( - phone: "+12065550100", - password: "password" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-prefs.md b/docs/examples/1.6.x/server-graphql/examples/account/update-prefs.md deleted file mode 100644 index 40db7b43db..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-prefs.md +++ /dev/null @@ -1,36 +0,0 @@ -mutation { - accountUpdatePrefs( - prefs: "{}" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-recovery.md b/docs/examples/1.6.x/server-graphql/examples/account/update-recovery.md deleted file mode 100644 index 2d15fdcaa1..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -mutation { - accountUpdateRecovery( - userId: "<USER_ID>", - secret: "<SECRET>", - password: "" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-session.md b/docs/examples/1.6.x/server-graphql/examples/account/update-session.md deleted file mode 100644 index 29a8979872..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-session.md +++ /dev/null @@ -1,35 +0,0 @@ -mutation { - accountUpdateSession( - sessionId: "<SESSION_ID>" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-status.md b/docs/examples/1.6.x/server-graphql/examples/account/update-status.md deleted file mode 100644 index aca8c098e7..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-status.md +++ /dev/null @@ -1,34 +0,0 @@ -mutation { - accountUpdateStatus { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/account/update-verification.md b/docs/examples/1.6.x/server-graphql/examples/account/update-verification.md deleted file mode 100644 index 11e63c7da3..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/account/update-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -mutation { - accountUpdateVerification( - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-browser.md deleted file mode 100644 index 817e1e54c2..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/avatars/get-browser.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - avatarsGetBrowser( - code: "aa", - width: 0, - height: 0, - quality: 0 - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-credit-card.md deleted file mode 100644 index e4b5dc18d9..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - avatarsGetCreditCard( - code: "amex", - width: 0, - height: 0, - quality: 0 - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-favicon.md deleted file mode 100644 index bfea71f498..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/avatars/get-favicon.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - avatarsGetFavicon( - url: "https://example.com" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-flag.md deleted file mode 100644 index 1502128581..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/avatars/get-flag.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - avatarsGetFlag( - code: "af", - width: 0, - height: 0, - quality: 0 - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-image.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-image.md deleted file mode 100644 index 3b9aa104dc..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/avatars/get-image.md +++ /dev/null @@ -1,9 +0,0 @@ -query { - avatarsGetImage( - url: "https://example.com", - width: 0, - height: 0 - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-initials.md deleted file mode 100644 index 51ae36136b..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/avatars/get-initials.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - avatarsGetInitials( - name: "<NAME>", - width: 0, - height: 0, - background: "" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-graphql/examples/avatars/get-q-r.md deleted file mode 100644 index a19f218412..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/avatars/get-q-r.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - avatarsGetQR( - text: "<TEXT>", - size: 1, - margin: 0, - download: false - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-boolean-attribute.md deleted file mode 100644 index 6e969a587e..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -mutation { - databasesCreateBooleanAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: false, - array: false - ) { - key - type - status - error - required - array - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-collection.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-collection.md deleted file mode 100644 index 05175cc1e7..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-collection.md +++ /dev/null @@ -1,28 +0,0 @@ -mutation { - databasesCreateCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - name: "<NAME>", - permissions: ["read("any")"], - documentSecurity: false, - enabled: false - ) { - _id - _createdAt - _updatedAt - _permissions - databaseId - name - enabled - documentSecurity - attributes - indexes { - key - type - status - error - attributes - orders - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-datetime-attribute.md deleted file mode 100644 index fcd5cb37a2..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -mutation { - databasesCreateDatetimeAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "", - array: false - ) { - key - type - status - error - required - array - format - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-document.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-document.md deleted file mode 100644 index 4e2d90660b..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-document.md +++ /dev/null @@ -1,17 +0,0 @@ -mutation { - databasesCreateDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - data: "{}", - permissions: ["read("any")"] - ) { - _id - _collectionId - _databaseId - _createdAt - _updatedAt - _permissions - data - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-email-attribute.md deleted file mode 100644 index 1f23a23ba7..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -mutation { - databasesCreateEmailAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "email@example.com", - array: false - ) { - key - type - status - error - required - array - format - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-enum-attribute.md deleted file mode 100644 index 410a7983b4..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -mutation { - databasesCreateEnumAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - elements: [], - required: false, - default: "<DEFAULT>", - array: false - ) { - key - type - status - error - required - array - elements - format - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-float-attribute.md deleted file mode 100644 index ae6f9f72d6..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -mutation { - databasesCreateFloatAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, - max: 0, - default: 0, - array: false - ) { - key - type - status - error - required - array - min - max - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-index.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-index.md deleted file mode 100644 index efc92a798c..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-index.md +++ /dev/null @@ -1,17 +0,0 @@ -mutation { - databasesCreateIndex( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - type: "key", - attributes: [], - orders: [] - ) { - key - type - status - error - attributes - orders - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-integer-attribute.md deleted file mode 100644 index 1dc43f6b0d..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -mutation { - databasesCreateIntegerAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, - max: 0, - default: 0, - array: false - ) { - key - type - status - error - required - array - min - max - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-ip-attribute.md deleted file mode 100644 index b2fd7215a0..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -mutation { - databasesCreateIpAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "", - array: false - ) { - key - type - status - error - required - array - format - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-relationship-attribute.md deleted file mode 100644 index ddca20b83a..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,25 +0,0 @@ -mutation { - databasesCreateRelationshipAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - relatedCollectionId: "<RELATED_COLLECTION_ID>", - type: "oneToOne", - twoWay: false, - key: "", - twoWayKey: "", - onDelete: "cascade" - ) { - key - type - status - error - required - array - relatedCollection - relationType - twoWay - twoWayKey - onDelete - side - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-string-attribute.md deleted file mode 100644 index 3c290712e9..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -mutation { - databasesCreateStringAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - size: 1, - required: false, - default: "<DEFAULT>", - array: false, - encrypt: false - ) { - key - type - status - error - required - array - size - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/create-url-attribute.md deleted file mode 100644 index d2a39756c9..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -mutation { - databasesCreateUrlAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "https://example.com", - array: false - ) { - key - type - status - error - required - array - format - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/create.md b/docs/examples/1.6.x/server-graphql/examples/databases/create.md deleted file mode 100644 index c48e024e7c..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/create.md +++ /dev/null @@ -1,13 +0,0 @@ -mutation { - databasesCreate( - databaseId: "<DATABASE_ID>", - name: "<NAME>", - enabled: false - ) { - _id - name - _createdAt - _updatedAt - enabled - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/delete-attribute.md deleted file mode 100644 index af0f9d6615..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/delete-attribute.md +++ /dev/null @@ -1,9 +0,0 @@ -mutation { - databasesDeleteAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-graphql/examples/databases/delete-collection.md deleted file mode 100644 index 8683bd87a4..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/delete-collection.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - databasesDeleteCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/delete-document.md b/docs/examples/1.6.x/server-graphql/examples/databases/delete-document.md deleted file mode 100644 index 848371bca0..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/delete-document.md +++ /dev/null @@ -1,9 +0,0 @@ -mutation { - databasesDeleteDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/delete-index.md b/docs/examples/1.6.x/server-graphql/examples/databases/delete-index.md deleted file mode 100644 index a2389cf9d4..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/delete-index.md +++ /dev/null @@ -1,9 +0,0 @@ -mutation { - databasesDeleteIndex( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/delete.md b/docs/examples/1.6.x/server-graphql/examples/databases/delete.md deleted file mode 100644 index 7cd4c92341..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/delete.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - databasesDelete( - databaseId: "<DATABASE_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/get-attribute.md deleted file mode 100644 index 873d03b708..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/get-attribute.md +++ /dev/null @@ -1,9 +0,0 @@ -query { - databasesGetAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/get-collection.md b/docs/examples/1.6.x/server-graphql/examples/databases/get-collection.md deleted file mode 100644 index f76b71b6ba..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/get-collection.md +++ /dev/null @@ -1,24 +0,0 @@ -query { - databasesGetCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>" - ) { - _id - _createdAt - _updatedAt - _permissions - databaseId - name - enabled - documentSecurity - attributes - indexes { - key - type - status - error - attributes - orders - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/get-document.md b/docs/examples/1.6.x/server-graphql/examples/databases/get-document.md deleted file mode 100644 index 7cff0a18c1..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/get-document.md +++ /dev/null @@ -1,16 +0,0 @@ -query { - databasesGetDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - queries: [] - ) { - _id - _collectionId - _databaseId - _createdAt - _updatedAt - _permissions - data - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/get-index.md b/docs/examples/1.6.x/server-graphql/examples/databases/get-index.md deleted file mode 100644 index de3c44ebe0..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/get-index.md +++ /dev/null @@ -1,14 +0,0 @@ -query { - databasesGetIndex( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" - ) { - key - type - status - error - attributes - orders - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/get.md b/docs/examples/1.6.x/server-graphql/examples/databases/get.md deleted file mode 100644 index 74c4fe5619..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/get.md +++ /dev/null @@ -1,11 +0,0 @@ -query { - databasesGet( - databaseId: "<DATABASE_ID>" - ) { - _id - name - _createdAt - _updatedAt - enabled - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-graphql/examples/databases/list-attributes.md deleted file mode 100644 index 660c0945a7..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/list-attributes.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - databasesListAttributes( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - queries: [] - ) { - total - attributes - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/list-collections.md b/docs/examples/1.6.x/server-graphql/examples/databases/list-collections.md deleted file mode 100644 index b821b6c4cf..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/list-collections.md +++ /dev/null @@ -1,28 +0,0 @@ -query { - databasesListCollections( - databaseId: "<DATABASE_ID>", - queries: [], - search: "<SEARCH>" - ) { - total - collections { - _id - _createdAt - _updatedAt - _permissions - databaseId - name - enabled - documentSecurity - attributes - indexes { - key - type - status - error - attributes - orders - } - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/list-documents.md b/docs/examples/1.6.x/server-graphql/examples/databases/list-documents.md deleted file mode 100644 index 077d7c8f12..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/list-documents.md +++ /dev/null @@ -1,18 +0,0 @@ -query { - databasesListDocuments( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - queries: [] - ) { - total - documents { - _id - _collectionId - _databaseId - _createdAt - _updatedAt - _permissions - data - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-graphql/examples/databases/list-indexes.md deleted file mode 100644 index e1c11b6c03..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/list-indexes.md +++ /dev/null @@ -1,17 +0,0 @@ -query { - databasesListIndexes( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - queries: [] - ) { - total - indexes { - key - type - status - error - attributes - orders - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/list.md b/docs/examples/1.6.x/server-graphql/examples/databases/list.md deleted file mode 100644 index 1adf3d3b48..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/list.md +++ /dev/null @@ -1,15 +0,0 @@ -query { - databasesList( - queries: [], - search: "<SEARCH>" - ) { - total - databases { - _id - name - _createdAt - _updatedAt - enabled - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-boolean-attribute.md deleted file mode 100644 index 4c9aa62ef0..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -mutation { - databasesUpdateBooleanAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: false - ) { - key - type - status - error - required - array - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-collection.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-collection.md deleted file mode 100644 index fc78bb8efc..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-collection.md +++ /dev/null @@ -1,28 +0,0 @@ -mutation { - databasesUpdateCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - name: "<NAME>", - permissions: ["read("any")"], - documentSecurity: false, - enabled: false - ) { - _id - _createdAt - _updatedAt - _permissions - databaseId - name - enabled - documentSecurity - attributes - indexes { - key - type - status - error - attributes - orders - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-datetime-attribute.md deleted file mode 100644 index 3da4483837..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -mutation { - databasesUpdateDatetimeAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "" - ) { - key - type - status - error - required - array - format - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-document.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-document.md deleted file mode 100644 index 5e80894620..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-document.md +++ /dev/null @@ -1,17 +0,0 @@ -mutation { - databasesUpdateDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - data: "{}", - permissions: ["read("any")"] - ) { - _id - _collectionId - _databaseId - _createdAt - _updatedAt - _permissions - data - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-email-attribute.md deleted file mode 100644 index 36dd14d646..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -mutation { - databasesUpdateEmailAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "email@example.com" - ) { - key - type - status - error - required - array - format - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-enum-attribute.md deleted file mode 100644 index f2954f070f..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - databasesUpdateEnumAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - elements: [], - required: false, - default: "<DEFAULT>" - ) { - key - type - status - error - required - array - elements - format - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-float-attribute.md deleted file mode 100644 index de987485a7..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -mutation { - databasesUpdateFloatAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, - max: 0, - default: 0 - ) { - key - type - status - error - required - array - min - max - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-integer-attribute.md deleted file mode 100644 index 34ceca93af..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -mutation { - databasesUpdateIntegerAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, - max: 0, - default: 0 - ) { - key - type - status - error - required - array - min - max - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-ip-attribute.md deleted file mode 100644 index a3a2aec585..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -mutation { - databasesUpdateIpAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "" - ) { - key - type - status - error - required - array - format - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-relationship-attribute.md deleted file mode 100644 index aa994f14ae..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -mutation { - databasesUpdateRelationshipAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - onDelete: "cascade" - ) { - key - type - status - error - required - array - relatedCollection - relationType - twoWay - twoWayKey - onDelete - side - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-string-attribute.md deleted file mode 100644 index cc98a1a177..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -mutation { - databasesUpdateStringAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "<DEFAULT>" - ) { - key - type - status - error - required - array - size - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-graphql/examples/databases/update-url-attribute.md deleted file mode 100644 index e94723efe1..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -mutation { - databasesUpdateUrlAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "https://example.com" - ) { - key - type - status - error - required - array - format - default - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/databases/update.md b/docs/examples/1.6.x/server-graphql/examples/databases/update.md deleted file mode 100644 index 88d286dc8a..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/databases/update.md +++ /dev/null @@ -1,13 +0,0 @@ -mutation { - databasesUpdate( - databaseId: "<DATABASE_ID>", - name: "<NAME>", - enabled: false - ) { - _id - name - _createdAt - _updatedAt - enabled - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/create-build.md b/docs/examples/1.6.x/server-graphql/examples/functions/create-build.md deleted file mode 100644 index b9b711eac0..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/create-build.md +++ /dev/null @@ -1,9 +0,0 @@ -mutation { - functionsCreateBuild( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>", - buildId: "<BUILD_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-graphql/examples/functions/create-deployment.md deleted file mode 100644 index a6a01aae53..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/create-deployment.md +++ /dev/null @@ -1,24 +0,0 @@ -POST /v1/functions/{functionId}/deployments HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -Content-Length: *Length of your entity body in bytes* - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="operations" - -{ "query": "mutation { functionsCreateDeployment(functionId: $functionId, code: $code, activate: $activate, entrypoint: $entrypoint, commands: $commands) { id }" }, "variables": { "functionId": "<FUNCTION_ID>", "code": null, "activate": false, "entrypoint": "<ENTRYPOINT>", "commands": "<COMMANDS>" } } - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="map" - -{ "0": ["variables.code"], } - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="0"; filename="code.ext" - -File contents - ---cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/create-execution.md b/docs/examples/1.6.x/server-graphql/examples/functions/create-execution.md deleted file mode 100644 index be459ee5ab..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/create-execution.md +++ /dev/null @@ -1,34 +0,0 @@ -mutation { - functionsCreateExecution( - functionId: "<FUNCTION_ID>", - body: "<BODY>", - async: false, - path: "<PATH>", - method: "GET", - headers: "{}", - scheduledAt: "" - ) { - _id - _createdAt - _updatedAt - _permissions - functionId - trigger - status - requestMethod - requestPath - requestHeaders { - name - value - } - responseStatusCode - responseBody - responseHeaders { - name - value - } - logs - errors - duration - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/create-variable.md b/docs/examples/1.6.x/server-graphql/examples/functions/create-variable.md deleted file mode 100644 index 9f67458e7b..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/create-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -mutation { - functionsCreateVariable( - functionId: "<FUNCTION_ID>", - key: "<KEY>", - value: "<VALUE>" - ) { - _id - _createdAt - _updatedAt - key - value - resourceType - resourceId - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/create.md b/docs/examples/1.6.x/server-graphql/examples/functions/create.md deleted file mode 100644 index 9cc14dacda..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/create.md +++ /dev/null @@ -1,57 +0,0 @@ -mutation { - functionsCreate( - functionId: "<FUNCTION_ID>", - name: "<NAME>", - runtime: "node-14.5", - execute: ["any"], - events: [], - schedule: "", - timeout: 1, - enabled: false, - logging: false, - entrypoint: "<ENTRYPOINT>", - commands: "<COMMANDS>", - scopes: [], - installationId: "<INSTALLATION_ID>", - providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", - providerBranch: "<PROVIDER_BRANCH>", - providerSilentMode: false, - providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", - templateRepository: "<TEMPLATE_REPOSITORY>", - templateOwner: "<TEMPLATE_OWNER>", - templateRootDirectory: "<TEMPLATE_ROOT_DIRECTORY>", - templateBranch: "<TEMPLATE_BRANCH>" - ) { - _id - _createdAt - _updatedAt - execute - name - enabled - live - logging - runtime - deployment - scopes - vars { - _id - _createdAt - _updatedAt - key - value - resourceType - resourceId - } - events - schedule - timeout - entrypoint - commands - version - installationId - providerRepositoryId - providerBranch - providerRootDirectory - providerSilentMode - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-graphql/examples/functions/delete-deployment.md deleted file mode 100644 index 8d83f28d4f..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/delete-deployment.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - functionsDeleteDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-graphql/examples/functions/delete-execution.md deleted file mode 100644 index c6e950afc9..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/delete-execution.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - functionsDeleteExecution( - functionId: "<FUNCTION_ID>", - executionId: "<EXECUTION_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-graphql/examples/functions/delete-variable.md deleted file mode 100644 index 9bc2d9b6e6..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/delete-variable.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - functionsDeleteVariable( - functionId: "<FUNCTION_ID>", - variableId: "<VARIABLE_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/delete.md b/docs/examples/1.6.x/server-graphql/examples/functions/delete.md deleted file mode 100644 index db019bf376..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/delete.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - functionsDelete( - functionId: "<FUNCTION_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-graphql/examples/functions/download-deployment.md deleted file mode 100644 index f791338765..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/download-deployment.md +++ /dev/null @@ -1,8 +0,0 @@ -query { - functionsDownloadDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-graphql/examples/functions/get-deployment.md deleted file mode 100644 index 1e1e7208a3..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/get-deployment.md +++ /dev/null @@ -1,30 +0,0 @@ -query { - functionsGetDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" - ) { - _id - _createdAt - _updatedAt - type - resourceId - resourceType - entrypoint - size - buildId - activate - status - buildLogs - buildTime - providerRepositoryName - providerRepositoryOwner - providerRepositoryUrl - providerBranch - providerCommitHash - providerCommitAuthorUrl - providerCommitAuthor - providerCommitMessage - providerCommitUrl - providerBranchUrl - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/get-execution.md b/docs/examples/1.6.x/server-graphql/examples/functions/get-execution.md deleted file mode 100644 index f9f8ef0552..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/get-execution.md +++ /dev/null @@ -1,29 +0,0 @@ -query { - functionsGetExecution( - functionId: "<FUNCTION_ID>", - executionId: "<EXECUTION_ID>" - ) { - _id - _createdAt - _updatedAt - _permissions - functionId - trigger - status - requestMethod - requestPath - requestHeaders { - name - value - } - responseStatusCode - responseBody - responseHeaders { - name - value - } - logs - errors - duration - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/get-variable.md b/docs/examples/1.6.x/server-graphql/examples/functions/get-variable.md deleted file mode 100644 index cd683f0dbd..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/get-variable.md +++ /dev/null @@ -1,14 +0,0 @@ -query { - functionsGetVariable( - functionId: "<FUNCTION_ID>", - variableId: "<VARIABLE_ID>" - ) { - _id - _createdAt - _updatedAt - key - value - resourceType - resourceId - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/get.md b/docs/examples/1.6.x/server-graphql/examples/functions/get.md deleted file mode 100644 index 8d38535c55..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/get.md +++ /dev/null @@ -1,37 +0,0 @@ -query { - functionsGet( - functionId: "<FUNCTION_ID>" - ) { - _id - _createdAt - _updatedAt - execute - name - enabled - live - logging - runtime - deployment - scopes - vars { - _id - _createdAt - _updatedAt - key - value - resourceType - resourceId - } - events - schedule - timeout - entrypoint - commands - version - installationId - providerRepositoryId - providerBranch - providerRootDirectory - providerSilentMode - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-graphql/examples/functions/list-deployments.md deleted file mode 100644 index b736744384..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/list-deployments.md +++ /dev/null @@ -1,34 +0,0 @@ -query { - functionsListDeployments( - functionId: "<FUNCTION_ID>", - queries: [], - search: "<SEARCH>" - ) { - total - deployments { - _id - _createdAt - _updatedAt - type - resourceId - resourceType - entrypoint - size - buildId - activate - status - buildLogs - buildTime - providerRepositoryName - providerRepositoryOwner - providerRepositoryUrl - providerBranch - providerCommitHash - providerCommitAuthorUrl - providerCommitAuthor - providerCommitMessage - providerCommitUrl - providerBranchUrl - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/list-executions.md b/docs/examples/1.6.x/server-graphql/examples/functions/list-executions.md deleted file mode 100644 index 745ec32377..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/list-executions.md +++ /dev/null @@ -1,33 +0,0 @@ -query { - functionsListExecutions( - functionId: "<FUNCTION_ID>", - queries: [], - search: "<SEARCH>" - ) { - total - executions { - _id - _createdAt - _updatedAt - _permissions - functionId - trigger - status - requestMethod - requestPath - requestHeaders { - name - value - } - responseStatusCode - responseBody - responseHeaders { - name - value - } - logs - errors - duration - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-graphql/examples/functions/list-runtimes.md deleted file mode 100644 index 2c2b207e60..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/list-runtimes.md +++ /dev/null @@ -1,14 +0,0 @@ -query { - functionsListRuntimes { - total - runtimes { - _id - name - version - base - image - logo - supports - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/list-variables.md b/docs/examples/1.6.x/server-graphql/examples/functions/list-variables.md deleted file mode 100644 index 583107bd2e..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/list-variables.md +++ /dev/null @@ -1,16 +0,0 @@ -query { - functionsListVariables( - functionId: "<FUNCTION_ID>" - ) { - total - variables { - _id - _createdAt - _updatedAt - key - value - resourceType - resourceId - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/list.md b/docs/examples/1.6.x/server-graphql/examples/functions/list.md deleted file mode 100644 index 0b022dda6d..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/list.md +++ /dev/null @@ -1,41 +0,0 @@ -query { - functionsList( - queries: [], - search: "<SEARCH>" - ) { - total - functions { - _id - _createdAt - _updatedAt - execute - name - enabled - live - logging - runtime - deployment - scopes - vars { - _id - _createdAt - _updatedAt - key - value - resourceType - resourceId - } - events - schedule - timeout - entrypoint - commands - version - installationId - providerRepositoryId - providerBranch - providerRootDirectory - providerSilentMode - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment-build.md deleted file mode 100644 index 484d4b39ce..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,16 +0,0 @@ -mutation { - functionsUpdateDeploymentBuild( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" - ) { - _id - deploymentId - status - stdout - stderr - startTime - endTime - duration - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment.md deleted file mode 100644 index 580a503f03..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/update-deployment.md +++ /dev/null @@ -1,38 +0,0 @@ -mutation { - functionsUpdateDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" - ) { - _id - _createdAt - _updatedAt - execute - name - enabled - live - logging - runtime - deployment - scopes - vars { - _id - _createdAt - _updatedAt - key - value - resourceType - resourceId - } - events - schedule - timeout - entrypoint - commands - version - installationId - providerRepositoryId - providerBranch - providerRootDirectory - providerSilentMode - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/update-variable.md b/docs/examples/1.6.x/server-graphql/examples/functions/update-variable.md deleted file mode 100644 index 7f7fe4aab7..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/update-variable.md +++ /dev/null @@ -1,16 +0,0 @@ -mutation { - functionsUpdateVariable( - functionId: "<FUNCTION_ID>", - variableId: "<VARIABLE_ID>", - key: "<KEY>", - value: "<VALUE>" - ) { - _id - _createdAt - _updatedAt - key - value - resourceType - resourceId - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/functions/update.md b/docs/examples/1.6.x/server-graphql/examples/functions/update.md deleted file mode 100644 index cd2caec0b1..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/functions/update.md +++ /dev/null @@ -1,53 +0,0 @@ -mutation { - functionsUpdate( - functionId: "<FUNCTION_ID>", - name: "<NAME>", - runtime: "node-14.5", - execute: ["any"], - events: [], - schedule: "", - timeout: 1, - enabled: false, - logging: false, - entrypoint: "<ENTRYPOINT>", - commands: "<COMMANDS>", - scopes: [], - installationId: "<INSTALLATION_ID>", - providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", - providerBranch: "<PROVIDER_BRANCH>", - providerSilentMode: false, - providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>" - ) { - _id - _createdAt - _updatedAt - execute - name - enabled - live - logging - runtime - deployment - scopes - vars { - _id - _createdAt - _updatedAt - key - value - resourceType - resourceId - } - events - schedule - timeout - entrypoint - commands - version - installationId - providerRepositoryId - providerBranch - providerRootDirectory - providerSilentMode - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-graphql/examples/health/get-antivirus.md deleted file mode 100644 index 3634dc11c1..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-antivirus.md +++ /dev/null @@ -1,6 +0,0 @@ -query { - healthGetAntivirus { - version - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-cache.md b/docs/examples/1.6.x/server-graphql/examples/health/get-cache.md deleted file mode 100644 index 3db4076257..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-cache.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetCache { - name - ping - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-certificate.md b/docs/examples/1.6.x/server-graphql/examples/health/get-certificate.md deleted file mode 100644 index 91356f8512..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-certificate.md +++ /dev/null @@ -1,12 +0,0 @@ -query { - healthGetCertificate( - domain: "" - ) { - name - subjectSN - issuerOrganisation - validFrom - validTo - signatureTypeSN - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-d-b.md b/docs/examples/1.6.x/server-graphql/examples/health/get-d-b.md deleted file mode 100644 index 16e67c674e..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-d-b.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetDB { - name - ping - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-graphql/examples/health/get-failed-jobs.md deleted file mode 100644 index ca17166a89..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,8 +0,0 @@ -query { - healthGetFailedJobs( - name: "v1-database", - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-graphql/examples/health/get-pub-sub.md deleted file mode 100644 index cec6469b31..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-pub-sub.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetPubSub { - name - ping - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-builds.md deleted file mode 100644 index 26fb7f89fa..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-builds.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueueBuilds( - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-certificates.md deleted file mode 100644 index 8073528cc6..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueueCertificates( - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-databases.md deleted file mode 100644 index 3e77623903..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-databases.md +++ /dev/null @@ -1,8 +0,0 @@ -query { - healthGetQueueDatabases( - name: "<NAME>", - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-deletes.md deleted file mode 100644 index 8e7dedcf54..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueueDeletes( - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-functions.md deleted file mode 100644 index a827c9a143..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-functions.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueueFunctions( - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-logs.md deleted file mode 100644 index 96c93304bd..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-logs.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueueLogs( - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-mails.md deleted file mode 100644 index a30747567b..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-mails.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueueMails( - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-messaging.md deleted file mode 100644 index 9209550b11..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueueMessaging( - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-migrations.md deleted file mode 100644 index 99fd99134d..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueueMigrations( - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage-dump.md deleted file mode 100644 index 0c8d1dcd42..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueueUsageDump( - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage.md deleted file mode 100644 index 2d9f7cb14b..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-usage.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueueUsage( - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue-webhooks.md deleted file mode 100644 index 3e95e2fc0d..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueueWebhooks( - threshold: 0 - ) { - size - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-queue.md b/docs/examples/1.6.x/server-graphql/examples/health/get-queue.md deleted file mode 100644 index 721501e4bb..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-queue.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetQueue { - name - ping - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-graphql/examples/health/get-storage-local.md deleted file mode 100644 index 953af346ae..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-storage-local.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetStorageLocal { - name - ping - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-storage.md b/docs/examples/1.6.x/server-graphql/examples/health/get-storage.md deleted file mode 100644 index d7161df205..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-storage.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetStorage { - name - ping - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get-time.md b/docs/examples/1.6.x/server-graphql/examples/health/get-time.md deleted file mode 100644 index 0def76b9ad..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get-time.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGetTime { - remoteTime - localTime - diff - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/health/get.md b/docs/examples/1.6.x/server-graphql/examples/health/get.md deleted file mode 100644 index 8481d3625a..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/health/get.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - healthGet { - name - ping - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/get.md b/docs/examples/1.6.x/server-graphql/examples/locale/get.md deleted file mode 100644 index 2b2bbcc1f1..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/locale/get.md +++ /dev/null @@ -1,11 +0,0 @@ -query { - localeGet { - ip - countryCode - country - continentCode - continent - eu - currency - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-codes.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-codes.md deleted file mode 100644 index 0164cc3782..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/locale/list-codes.md +++ /dev/null @@ -1,9 +0,0 @@ -query { - localeListCodes { - total - localeCodes { - code - name - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-continents.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-continents.md deleted file mode 100644 index 41f672c565..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/locale/list-continents.md +++ /dev/null @@ -1,9 +0,0 @@ -query { - localeListContinents { - total - continents { - name - code - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-e-u.md deleted file mode 100644 index 00cd4652f9..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,9 +0,0 @@ -query { - localeListCountriesEU { - total - countries { - name - code - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-phones.md deleted file mode 100644 index 33d2296850..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - localeListCountriesPhones { - total - phones { - code - countryCode - countryName - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-countries.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-countries.md deleted file mode 100644 index 9312bc94b1..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/locale/list-countries.md +++ /dev/null @@ -1,9 +0,0 @@ -query { - localeListCountries { - total - countries { - name - code - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-currencies.md deleted file mode 100644 index cde3ab488a..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/locale/list-currencies.md +++ /dev/null @@ -1,14 +0,0 @@ -query { - localeListCurrencies { - total - currencies { - symbol - name - symbolNative - decimalDigits - rounding - code - namePlural - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/locale/list-languages.md b/docs/examples/1.6.x/server-graphql/examples/locale/list-languages.md deleted file mode 100644 index b0d76c522b..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/locale/list-languages.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - localeListLanguages { - total - languages { - name - code - nativeName - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-apns-provider.md deleted file mode 100644 index 425b3bb8dc..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -mutation { - messagingCreateApnsProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - authKey: "<AUTH_KEY>", - authKeyId: "<AUTH_KEY_ID>", - teamId: "<TEAM_ID>", - bundleId: "<BUNDLE_ID>", - sandbox: false, - enabled: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-email.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-email.md deleted file mode 100644 index a1e35aad19..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-email.md +++ /dev/null @@ -1,30 +0,0 @@ -mutation { - messagingCreateEmail( - messageId: "<MESSAGE_ID>", - subject: "<SUBJECT>", - content: "<CONTENT>", - topics: [], - users: [], - targets: [], - cc: [], - bcc: [], - attachments: [], - draft: false, - html: false, - scheduledAt: "" - ) { - _id - _createdAt - _updatedAt - providerType - topics - users - targets - scheduledAt - deliveredAt - deliveryErrors - deliveredTotal - data - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-fcm-provider.md deleted file mode 100644 index 0aa48a9e2f..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -mutation { - messagingCreateFcmProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - serviceAccountJSON: "{}", - enabled: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index 9da1e23847..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,24 +0,0 @@ -mutation { - messagingCreateMailgunProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - apiKey: "<API_KEY>", - domain: "<DOMAIN>", - isEuRegion: false, - fromName: "<FROM_NAME>", - fromEmail: "email@example.com", - replyToName: "<REPLY_TO_NAME>", - replyToEmail: "email@example.com", - enabled: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-msg91provider.md deleted file mode 100644 index ddaf2d4c2b..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - messagingCreateMsg91Provider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - templateId: "<TEMPLATE_ID>", - senderId: "<SENDER_ID>", - authKey: "<AUTH_KEY>", - enabled: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-push.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-push.md deleted file mode 100644 index 3084c97635..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-push.md +++ /dev/null @@ -1,34 +0,0 @@ -mutation { - messagingCreatePush( - messageId: "<MESSAGE_ID>", - title: "<TITLE>", - body: "<BODY>", - topics: [], - users: [], - targets: [], - data: "{}", - action: "<ACTION>", - image: "[ID1:ID2]", - icon: "<ICON>", - sound: "<SOUND>", - color: "<COLOR>", - tag: "<TAG>", - badge: "<BADGE>", - draft: false, - scheduledAt: "" - ) { - _id - _createdAt - _updatedAt - providerType - topics - users - targets - scheduledAt - deliveredAt - deliveryErrors - deliveredTotal - data - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index cda0652d67..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -mutation { - messagingCreateSendgridProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - apiKey: "<API_KEY>", - fromName: "<FROM_NAME>", - fromEmail: "email@example.com", - replyToName: "<REPLY_TO_NAME>", - replyToEmail: "email@example.com", - enabled: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-sms.md deleted file mode 100644 index 99af83b154..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-sms.md +++ /dev/null @@ -1,25 +0,0 @@ -mutation { - messagingCreateSms( - messageId: "<MESSAGE_ID>", - content: "<CONTENT>", - topics: [], - users: [], - targets: [], - draft: false, - scheduledAt: "" - ) { - _id - _createdAt - _updatedAt - providerType - topics - users - targets - scheduledAt - deliveredAt - deliveryErrors - deliveredTotal - data - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-smtp-provider.md deleted file mode 100644 index b7b24bc1a5..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -mutation { - messagingCreateSmtpProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - host: "<HOST>", - port: 1, - username: "<USERNAME>", - password: "<PASSWORD>", - encryption: "none", - autoTLS: false, - mailer: "<MAILER>", - fromName: "<FROM_NAME>", - fromEmail: "email@example.com", - replyToName: "<REPLY_TO_NAME>", - replyToEmail: "email@example.com", - enabled: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-subscriber.md deleted file mode 100644 index b2712ebb48..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,26 +0,0 @@ -mutation { - messagingCreateSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>", - targetId: "<TARGET_ID>" - ) { - _id - _createdAt - _updatedAt - targetId - target { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - userId - userName - topicId - providerType - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-telesign-provider.md deleted file mode 100644 index 7960a8427f..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - messagingCreateTelesignProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", - customerId: "<CUSTOMER_ID>", - apiKey: "<API_KEY>", - enabled: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index e082097b70..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - messagingCreateTextmagicProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", - username: "<USERNAME>", - apiKey: "<API_KEY>", - enabled: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-topic.md deleted file mode 100644 index 6216c4cda5..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-topic.md +++ /dev/null @@ -1,16 +0,0 @@ -mutation { - messagingCreateTopic( - topicId: "<TOPIC_ID>", - name: "<NAME>", - subscribe: ["any"] - ) { - _id - _createdAt - _updatedAt - name - emailTotal - smsTotal - pushTotal - subscribe - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-twilio-provider.md deleted file mode 100644 index ac14d1d32b..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - messagingCreateTwilioProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", - accountSid: "<ACCOUNT_SID>", - authToken: "<AUTH_TOKEN>", - enabled: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/create-vonage-provider.md deleted file mode 100644 index ca7a710896..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - messagingCreateVonageProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", - apiKey: "<API_KEY>", - apiSecret: "<API_SECRET>", - enabled: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/delete-provider.md deleted file mode 100644 index 8d9ac35953..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/delete-provider.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - messagingDeleteProvider( - providerId: "<PROVIDER_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-graphql/examples/messaging/delete-subscriber.md deleted file mode 100644 index ededffcaac..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - messagingDeleteSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-graphql/examples/messaging/delete-topic.md deleted file mode 100644 index e49cd1ed91..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/delete-topic.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - messagingDeleteTopic( - topicId: "<TOPIC_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/delete.md b/docs/examples/1.6.x/server-graphql/examples/messaging/delete.md deleted file mode 100644 index 495557ef18..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/delete.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - messagingDelete( - messageId: "<MESSAGE_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/get-message.md b/docs/examples/1.6.x/server-graphql/examples/messaging/get-message.md deleted file mode 100644 index a6824cd911..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/get-message.md +++ /dev/null @@ -1,19 +0,0 @@ -query { - messagingGetMessage( - messageId: "<MESSAGE_ID>" - ) { - _id - _createdAt - _updatedAt - providerType - topics - users - targets - scheduledAt - deliveredAt - deliveryErrors - deliveredTotal - data - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/get-provider.md deleted file mode 100644 index 03fb039be2..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/get-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -query { - messagingGetProvider( - providerId: "<PROVIDER_ID>" - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-graphql/examples/messaging/get-subscriber.md deleted file mode 100644 index 54096dd70a..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,25 +0,0 @@ -query { - messagingGetSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>" - ) { - _id - _createdAt - _updatedAt - targetId - target { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - userId - userName - topicId - providerType - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-graphql/examples/messaging/get-topic.md deleted file mode 100644 index 7f0dd01ee6..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/get-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -query { - messagingGetTopic( - topicId: "<TOPIC_ID>" - ) { - _id - _createdAt - _updatedAt - name - emailTotal - smsTotal - pushTotal - subscribe - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-message-logs.md deleted file mode 100644 index b1e32d8e99..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,31 +0,0 @@ -query { - messagingListMessageLogs( - messageId: "<MESSAGE_ID>", - queries: [] - ) { - total - logs { - event - userId - userEmail - userName - mode - ip - time - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-messages.md deleted file mode 100644 index 7cdf05c7d8..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/list-messages.md +++ /dev/null @@ -1,23 +0,0 @@ -query { - messagingListMessages( - queries: [], - search: "<SEARCH>" - ) { - total - messages { - _id - _createdAt - _updatedAt - providerType - topics - users - targets - scheduledAt - deliveredAt - deliveryErrors - deliveredTotal - data - status - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-provider-logs.md deleted file mode 100644 index 69df6fa06d..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,31 +0,0 @@ -query { - messagingListProviderLogs( - providerId: "<PROVIDER_ID>", - queries: [] - ) { - total - logs { - event - userId - userEmail - userName - mode - ip - time - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-providers.md deleted file mode 100644 index d7ae7b16ba..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/list-providers.md +++ /dev/null @@ -1,19 +0,0 @@ -query { - messagingListProviders( - queries: [], - search: "<SEARCH>" - ) { - total - providers { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index 23e117a07d..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,31 +0,0 @@ -query { - messagingListSubscriberLogs( - subscriberId: "<SUBSCRIBER_ID>", - queries: [] - ) { - total - logs { - event - userId - userEmail - userName - mode - ip - time - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscribers.md deleted file mode 100644 index 5c48ae34bb..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,29 +0,0 @@ -query { - messagingListSubscribers( - topicId: "<TOPIC_ID>", - queries: [], - search: "<SEARCH>" - ) { - total - subscribers { - _id - _createdAt - _updatedAt - targetId - target { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - userId - userName - topicId - providerType - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-targets.md deleted file mode 100644 index 8e356dce5f..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/list-targets.md +++ /dev/null @@ -1,18 +0,0 @@ -query { - messagingListTargets( - messageId: "<MESSAGE_ID>", - queries: [] - ) { - total - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-topic-logs.md deleted file mode 100644 index 0b0a5f9a4b..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,31 +0,0 @@ -query { - messagingListTopicLogs( - topicId: "<TOPIC_ID>", - queries: [] - ) { - total - logs { - event - userId - userEmail - userName - mode - ip - time - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-graphql/examples/messaging/list-topics.md deleted file mode 100644 index 4b36c92511..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/list-topics.md +++ /dev/null @@ -1,18 +0,0 @@ -query { - messagingListTopics( - queries: [], - search: "<SEARCH>" - ) { - total - topics { - _id - _createdAt - _updatedAt - name - emailTotal - smsTotal - pushTotal - subscribe - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-apns-provider.md deleted file mode 100644 index b3d6e8745e..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -mutation { - messagingUpdateApnsProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - enabled: false, - authKey: "<AUTH_KEY>", - authKeyId: "<AUTH_KEY_ID>", - teamId: "<TEAM_ID>", - bundleId: "<BUNDLE_ID>", - sandbox: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-email.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-email.md deleted file mode 100644 index 1d1302efc4..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-email.md +++ /dev/null @@ -1,30 +0,0 @@ -mutation { - messagingUpdateEmail( - messageId: "<MESSAGE_ID>", - topics: [], - users: [], - targets: [], - subject: "<SUBJECT>", - content: "<CONTENT>", - draft: false, - html: false, - cc: [], - bcc: [], - scheduledAt: "", - attachments: [] - ) { - _id - _createdAt - _updatedAt - providerType - topics - users - targets - scheduledAt - deliveredAt - deliveryErrors - deliveredTotal - data - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-fcm-provider.md deleted file mode 100644 index a0b3f9e3da..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -mutation { - messagingUpdateFcmProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - enabled: false, - serviceAccountJSON: "{}" - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index 6c26d52ff2..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,24 +0,0 @@ -mutation { - messagingUpdateMailgunProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - apiKey: "<API_KEY>", - domain: "<DOMAIN>", - isEuRegion: false, - enabled: false, - fromName: "<FROM_NAME>", - fromEmail: "email@example.com", - replyToName: "<REPLY_TO_NAME>", - replyToEmail: "<REPLY_TO_EMAIL>" - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-msg91provider.md deleted file mode 100644 index a6552a4734..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - messagingUpdateMsg91Provider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - enabled: false, - templateId: "<TEMPLATE_ID>", - senderId: "<SENDER_ID>", - authKey: "<AUTH_KEY>" - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-push.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-push.md deleted file mode 100644 index 9039792573..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-push.md +++ /dev/null @@ -1,34 +0,0 @@ -mutation { - messagingUpdatePush( - messageId: "<MESSAGE_ID>", - topics: [], - users: [], - targets: [], - title: "<TITLE>", - body: "<BODY>", - data: "{}", - action: "<ACTION>", - image: "[ID1:ID2]", - icon: "<ICON>", - sound: "<SOUND>", - color: "<COLOR>", - tag: "<TAG>", - badge: 0, - draft: false, - scheduledAt: "" - ) { - _id - _createdAt - _updatedAt - providerType - topics - users - targets - scheduledAt - deliveredAt - deliveryErrors - deliveredTotal - data - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index 319dcea461..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -mutation { - messagingUpdateSendgridProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - enabled: false, - apiKey: "<API_KEY>", - fromName: "<FROM_NAME>", - fromEmail: "email@example.com", - replyToName: "<REPLY_TO_NAME>", - replyToEmail: "<REPLY_TO_EMAIL>" - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-sms.md deleted file mode 100644 index 7b45f09abc..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-sms.md +++ /dev/null @@ -1,25 +0,0 @@ -mutation { - messagingUpdateSms( - messageId: "<MESSAGE_ID>", - topics: [], - users: [], - targets: [], - content: "<CONTENT>", - draft: false, - scheduledAt: "" - ) { - _id - _createdAt - _updatedAt - providerType - topics - users - targets - scheduledAt - deliveredAt - deliveryErrors - deliveredTotal - data - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-smtp-provider.md deleted file mode 100644 index a091685655..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -mutation { - messagingUpdateSmtpProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - host: "<HOST>", - port: 1, - username: "<USERNAME>", - password: "<PASSWORD>", - encryption: "none", - autoTLS: false, - mailer: "<MAILER>", - fromName: "<FROM_NAME>", - fromEmail: "email@example.com", - replyToName: "<REPLY_TO_NAME>", - replyToEmail: "<REPLY_TO_EMAIL>", - enabled: false - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-telesign-provider.md deleted file mode 100644 index c9c96c0d5d..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - messagingUpdateTelesignProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - enabled: false, - customerId: "<CUSTOMER_ID>", - apiKey: "<API_KEY>", - from: "<FROM>" - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index 3fd68ed8e9..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - messagingUpdateTextmagicProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - enabled: false, - username: "<USERNAME>", - apiKey: "<API_KEY>", - from: "<FROM>" - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-topic.md deleted file mode 100644 index 8d3dc84c72..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-topic.md +++ /dev/null @@ -1,16 +0,0 @@ -mutation { - messagingUpdateTopic( - topicId: "<TOPIC_ID>", - name: "<NAME>", - subscribe: ["any"] - ) { - _id - _createdAt - _updatedAt - name - emailTotal - smsTotal - pushTotal - subscribe - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-twilio-provider.md deleted file mode 100644 index 6f10839567..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - messagingUpdateTwilioProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - enabled: false, - accountSid: "<ACCOUNT_SID>", - authToken: "<AUTH_TOKEN>", - from: "<FROM>" - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-graphql/examples/messaging/update-vonage-provider.md deleted file mode 100644 index f42670a428..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - messagingUpdateVonageProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - enabled: false, - apiKey: "<API_KEY>", - apiSecret: "<API_SECRET>", - from: "<FROM>" - ) { - _id - _createdAt - _updatedAt - name - provider - enabled - type - credentials - options - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-graphql/examples/storage/create-bucket.md deleted file mode 100644 index 45d03802d2..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/create-bucket.md +++ /dev/null @@ -1,27 +0,0 @@ -mutation { - storageCreateBucket( - bucketId: "<BUCKET_ID>", - name: "<NAME>", - permissions: ["read("any")"], - fileSecurity: false, - enabled: false, - maximumFileSize: 1, - allowedFileExtensions: [], - compression: "none", - encryption: false, - antivirus: false - ) { - _id - _createdAt - _updatedAt - _permissions - fileSecurity - name - enabled - maximumFileSize - allowedFileExtensions - compression - encryption - antivirus - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/create-file.md b/docs/examples/1.6.x/server-graphql/examples/storage/create-file.md deleted file mode 100644 index f77747cd79..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/create-file.md +++ /dev/null @@ -1,26 +0,0 @@ -POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> -Content-Length: *Length of your entity body in bytes* - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="operations" - -{ "query": "mutation { storageCreateFile(bucketId: $bucketId, fileId: $fileId, file: $file, permissions: $permissions) { id }" }, "variables": { "bucketId": "<BUCKET_ID>", "fileId": "<FILE_ID>", "file": null, "permissions": ["read("any")"] } } - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="map" - -{ "0": ["variables.file"], } - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="0"; filename="file.ext" - -File contents - ---cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-graphql/examples/storage/delete-bucket.md deleted file mode 100644 index 3dadd1f072..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/delete-bucket.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - storageDeleteBucket( - bucketId: "<BUCKET_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/delete-file.md b/docs/examples/1.6.x/server-graphql/examples/storage/delete-file.md deleted file mode 100644 index 17ec89931a..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/delete-file.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - storageDeleteFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-graphql/examples/storage/get-bucket.md deleted file mode 100644 index 4ce0f626ab..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/get-bucket.md +++ /dev/null @@ -1,18 +0,0 @@ -query { - storageGetBucket( - bucketId: "<BUCKET_ID>" - ) { - _id - _createdAt - _updatedAt - _permissions - fileSecurity - name - enabled - maximumFileSize - allowedFileExtensions - compression - encryption - antivirus - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-graphql/examples/storage/get-file-download.md deleted file mode 100644 index 8325e8a230..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/get-file-download.md +++ /dev/null @@ -1,8 +0,0 @@ -query { - storageGetFileDownload( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-graphql/examples/storage/get-file-preview.md deleted file mode 100644 index df32e88350..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/get-file-preview.md +++ /dev/null @@ -1,19 +0,0 @@ -query { - storageGetFilePreview( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - width: 0, - height: 0, - gravity: "center", - quality: 0, - borderWidth: 0, - borderColor: "", - borderRadius: 0, - opacity: 0, - rotation: -360, - background: "", - output: "jpg" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-graphql/examples/storage/get-file-view.md deleted file mode 100644 index 434328a1ec..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/get-file-view.md +++ /dev/null @@ -1,8 +0,0 @@ -query { - storageGetFileView( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/get-file.md b/docs/examples/1.6.x/server-graphql/examples/storage/get-file.md deleted file mode 100644 index 60886b0f6f..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/get-file.md +++ /dev/null @@ -1,18 +0,0 @@ -query { - storageGetFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" - ) { - _id - bucketId - _createdAt - _updatedAt - _permissions - name - signature - mimeType - sizeOriginal - chunksTotal - chunksUploaded - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-graphql/examples/storage/list-buckets.md deleted file mode 100644 index e4d636ccde..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/list-buckets.md +++ /dev/null @@ -1,22 +0,0 @@ -query { - storageListBuckets( - queries: [], - search: "<SEARCH>" - ) { - total - buckets { - _id - _createdAt - _updatedAt - _permissions - fileSecurity - name - enabled - maximumFileSize - allowedFileExtensions - compression - encryption - antivirus - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/list-files.md b/docs/examples/1.6.x/server-graphql/examples/storage/list-files.md deleted file mode 100644 index 774cc51b97..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/list-files.md +++ /dev/null @@ -1,22 +0,0 @@ -query { - storageListFiles( - bucketId: "<BUCKET_ID>", - queries: [], - search: "<SEARCH>" - ) { - total - files { - _id - bucketId - _createdAt - _updatedAt - _permissions - name - signature - mimeType - sizeOriginal - chunksTotal - chunksUploaded - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-graphql/examples/storage/update-bucket.md deleted file mode 100644 index 8265a15a58..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/update-bucket.md +++ /dev/null @@ -1,27 +0,0 @@ -mutation { - storageUpdateBucket( - bucketId: "<BUCKET_ID>", - name: "<NAME>", - permissions: ["read("any")"], - fileSecurity: false, - enabled: false, - maximumFileSize: 1, - allowedFileExtensions: [], - compression: "none", - encryption: false, - antivirus: false - ) { - _id - _createdAt - _updatedAt - _permissions - fileSecurity - name - enabled - maximumFileSize - allowedFileExtensions - compression - encryption - antivirus - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/storage/update-file.md b/docs/examples/1.6.x/server-graphql/examples/storage/update-file.md deleted file mode 100644 index b7832048c7..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/storage/update-file.md +++ /dev/null @@ -1,20 +0,0 @@ -mutation { - storageUpdateFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - name: "<NAME>", - permissions: ["read("any")"] - ) { - _id - bucketId - _createdAt - _updatedAt - _permissions - name - signature - mimeType - sizeOriginal - chunksTotal - chunksUploaded - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/create-membership.md b/docs/examples/1.6.x/server-graphql/examples/teams/create-membership.md deleted file mode 100644 index fe741f080d..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/create-membership.md +++ /dev/null @@ -1,25 +0,0 @@ -mutation { - teamsCreateMembership( - teamId: "<TEAM_ID>", - roles: [], - email: "email@example.com", - userId: "<USER_ID>", - phone: "+12065550100", - url: "https://example.com", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - userId - userName - userEmail - teamId - teamName - invited - joined - confirm - mfa - roles - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/create.md b/docs/examples/1.6.x/server-graphql/examples/teams/create.md deleted file mode 100644 index 1f2a7ab3f2..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/create.md +++ /dev/null @@ -1,16 +0,0 @@ -mutation { - teamsCreate( - teamId: "<TEAM_ID>", - name: "<NAME>", - roles: [] - ) { - _id - _createdAt - _updatedAt - name - total - prefs { - data - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-graphql/examples/teams/delete-membership.md deleted file mode 100644 index e391b6f6fa..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/delete-membership.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - teamsDeleteMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/delete.md b/docs/examples/1.6.x/server-graphql/examples/teams/delete.md deleted file mode 100644 index df0d36c5b5..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/delete.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - teamsDelete( - teamId: "<TEAM_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/get-membership.md b/docs/examples/1.6.x/server-graphql/examples/teams/get-membership.md deleted file mode 100644 index c33528609e..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/get-membership.md +++ /dev/null @@ -1,20 +0,0 @@ -query { - teamsGetMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>" - ) { - _id - _createdAt - _updatedAt - userId - userName - userEmail - teamId - teamName - invited - joined - confirm - mfa - roles - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-graphql/examples/teams/get-prefs.md deleted file mode 100644 index fe498079cf..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/get-prefs.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - teamsGetPrefs( - teamId: "<TEAM_ID>" - ) { - data - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/get.md b/docs/examples/1.6.x/server-graphql/examples/teams/get.md deleted file mode 100644 index a3fbb491e0..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/get.md +++ /dev/null @@ -1,14 +0,0 @@ -query { - teamsGet( - teamId: "<TEAM_ID>" - ) { - _id - _createdAt - _updatedAt - name - total - prefs { - data - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-graphql/examples/teams/list-memberships.md deleted file mode 100644 index bf7f0d1eed..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/list-memberships.md +++ /dev/null @@ -1,24 +0,0 @@ -query { - teamsListMemberships( - teamId: "<TEAM_ID>", - queries: [], - search: "<SEARCH>" - ) { - total - memberships { - _id - _createdAt - _updatedAt - userId - userName - userEmail - teamId - teamName - invited - joined - confirm - mfa - roles - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/list.md b/docs/examples/1.6.x/server-graphql/examples/teams/list.md deleted file mode 100644 index e7005b5326..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/list.md +++ /dev/null @@ -1,18 +0,0 @@ -query { - teamsList( - queries: [], - search: "<SEARCH>" - ) { - total - teams { - _id - _createdAt - _updatedAt - name - total - prefs { - data - } - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-graphql/examples/teams/update-membership-status.md deleted file mode 100644 index 9b24450a86..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/update-membership-status.md +++ /dev/null @@ -1,22 +0,0 @@ -mutation { - teamsUpdateMembershipStatus( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>", - userId: "<USER_ID>", - secret: "<SECRET>" - ) { - _id - _createdAt - _updatedAt - userId - userName - userEmail - teamId - teamName - invited - joined - confirm - mfa - roles - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/update-membership.md b/docs/examples/1.6.x/server-graphql/examples/teams/update-membership.md deleted file mode 100644 index 1c6a04f078..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/update-membership.md +++ /dev/null @@ -1,21 +0,0 @@ -mutation { - teamsUpdateMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>", - roles: [] - ) { - _id - _createdAt - _updatedAt - userId - userName - userEmail - teamId - teamName - invited - joined - confirm - mfa - roles - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/update-name.md b/docs/examples/1.6.x/server-graphql/examples/teams/update-name.md deleted file mode 100644 index c40543b5cd..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/update-name.md +++ /dev/null @@ -1,15 +0,0 @@ -mutation { - teamsUpdateName( - teamId: "<TEAM_ID>", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - total - prefs { - data - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-graphql/examples/teams/update-prefs.md deleted file mode 100644 index 95737e33f9..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/teams/update-prefs.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - teamsUpdatePrefs( - teamId: "<TEAM_ID>", - prefs: "{}" - ) { - data - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-argon2user.md deleted file mode 100644 index 464dc754c9..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-argon2user.md +++ /dev/null @@ -1,39 +0,0 @@ -mutation { - usersCreateArgon2User( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-bcrypt-user.md deleted file mode 100644 index 4d4bb09194..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,39 +0,0 @@ -mutation { - usersCreateBcryptUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-graphql/examples/users/create-j-w-t.md deleted file mode 100644 index bf0b1bd638..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-j-w-t.md +++ /dev/null @@ -1,9 +0,0 @@ -mutation { - usersCreateJWT( - userId: "<USER_ID>", - sessionId: "<SESSION_ID>", - duration: 0 - ) { - jwt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-m-d5user.md deleted file mode 100644 index e8e833e6de..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-m-d5user.md +++ /dev/null @@ -1,39 +0,0 @@ -mutation { - usersCreateMD5User( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index 7c4f1c5575..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - usersCreateMfaRecoveryCodes( - userId: "<USER_ID>" - ) { - recoveryCodes - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-p-h-pass-user.md deleted file mode 100644 index 53960e7890..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,39 +0,0 @@ -mutation { - usersCreatePHPassUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-s-h-a-user.md deleted file mode 100644 index 17e287f8b3..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,40 +0,0 @@ -mutation { - usersCreateSHAUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - passwordVersion: "sha1", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index 6d51fb29ba..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,42 +0,0 @@ -mutation { - usersCreateScryptModifiedUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - passwordSalt: "<PASSWORD_SALT>", - passwordSaltSeparator: "<PASSWORD_SALT_SEPARATOR>", - passwordSignerKey: "<PASSWORD_SIGNER_KEY>", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-user.md deleted file mode 100644 index 0d4bac1db8..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,44 +0,0 @@ -mutation { - usersCreateScryptUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - passwordSalt: "<PASSWORD_SALT>", - passwordCpu: 0, - passwordMemory: 0, - passwordParallel: 0, - passwordLength: 0, - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-session.md b/docs/examples/1.6.x/server-graphql/examples/users/create-session.md deleted file mode 100644 index 701ddf501f..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-session.md +++ /dev/null @@ -1,35 +0,0 @@ -mutation { - usersCreateSession( - userId: "<USER_ID>" - ) { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-target.md b/docs/examples/1.6.x/server-graphql/examples/users/create-target.md deleted file mode 100644 index a3a0696dec..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-target.md +++ /dev/null @@ -1,19 +0,0 @@ -mutation { - usersCreateTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>", - providerType: "email", - identifier: "<IDENTIFIER>", - providerId: "<PROVIDER_ID>", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create-token.md b/docs/examples/1.6.x/server-graphql/examples/users/create-token.md deleted file mode 100644 index 78255f7676..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create-token.md +++ /dev/null @@ -1,14 +0,0 @@ -mutation { - usersCreateToken( - userId: "<USER_ID>", - length: 4, - expire: 60 - ) { - _id - _createdAt - userId - secret - expire - phrase - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/create.md b/docs/examples/1.6.x/server-graphql/examples/users/create.md deleted file mode 100644 index 826a5168ef..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/create.md +++ /dev/null @@ -1,40 +0,0 @@ -mutation { - usersCreate( - userId: "<USER_ID>", - email: "email@example.com", - phone: "+12065550100", - password: "", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete-identity.md b/docs/examples/1.6.x/server-graphql/examples/users/delete-identity.md deleted file mode 100644 index 1ea0d990b1..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/delete-identity.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - usersDeleteIdentity( - identityId: "<IDENTITY_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-graphql/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index 227c340c68..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - usersDeleteMfaAuthenticator( - userId: "<USER_ID>", - type: "totp" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete-session.md b/docs/examples/1.6.x/server-graphql/examples/users/delete-session.md deleted file mode 100644 index 7e6538b34a..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/delete-session.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - usersDeleteSession( - userId: "<USER_ID>", - sessionId: "<SESSION_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-graphql/examples/users/delete-sessions.md deleted file mode 100644 index d1ccaa26f4..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/delete-sessions.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - usersDeleteSessions( - userId: "<USER_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete-target.md b/docs/examples/1.6.x/server-graphql/examples/users/delete-target.md deleted file mode 100644 index 92d0a16ac5..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/delete-target.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - usersDeleteTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/delete.md b/docs/examples/1.6.x/server-graphql/examples/users/delete.md deleted file mode 100644 index 2cf392b7f1..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/delete.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - usersDelete( - userId: "<USER_ID>" - ) { - status - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index c4ca9f79b4..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - usersGetMfaRecoveryCodes( - userId: "<USER_ID>" - ) { - recoveryCodes - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/get-prefs.md b/docs/examples/1.6.x/server-graphql/examples/users/get-prefs.md deleted file mode 100644 index fe08758d99..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/get-prefs.md +++ /dev/null @@ -1,7 +0,0 @@ -query { - usersGetPrefs( - userId: "<USER_ID>" - ) { - data - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/get-target.md b/docs/examples/1.6.x/server-graphql/examples/users/get-target.md deleted file mode 100644 index e4ba1a04a1..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/get-target.md +++ /dev/null @@ -1,15 +0,0 @@ -query { - usersGetTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>" - ) { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/get.md b/docs/examples/1.6.x/server-graphql/examples/users/get.md deleted file mode 100644 index f94a5818ed..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/get.md +++ /dev/null @@ -1,36 +0,0 @@ -query { - usersGet( - userId: "<USER_ID>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-identities.md b/docs/examples/1.6.x/server-graphql/examples/users/list-identities.md deleted file mode 100644 index 38ab302f38..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/list-identities.md +++ /dev/null @@ -1,20 +0,0 @@ -query { - usersListIdentities( - queries: [], - search: "<SEARCH>" - ) { - total - identities { - _id - _createdAt - _updatedAt - userId - provider - providerUid - providerEmail - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-logs.md b/docs/examples/1.6.x/server-graphql/examples/users/list-logs.md deleted file mode 100644 index 8594e87b22..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/list-logs.md +++ /dev/null @@ -1,31 +0,0 @@ -query { - usersListLogs( - userId: "<USER_ID>", - queries: [] - ) { - total - logs { - event - userId - userEmail - userName - mode - ip - time - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-memberships.md b/docs/examples/1.6.x/server-graphql/examples/users/list-memberships.md deleted file mode 100644 index cf64f61f10..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/list-memberships.md +++ /dev/null @@ -1,22 +0,0 @@ -query { - usersListMemberships( - userId: "<USER_ID>" - ) { - total - memberships { - _id - _createdAt - _updatedAt - userId - userName - userEmail - teamId - teamName - invited - joined - confirm - mfa - roles - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-graphql/examples/users/list-mfa-factors.md deleted file mode 100644 index 12c910835a..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,10 +0,0 @@ -query { - usersListMfaFactors( - userId: "<USER_ID>" - ) { - totp - phone - email - recoveryCode - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-sessions.md b/docs/examples/1.6.x/server-graphql/examples/users/list-sessions.md deleted file mode 100644 index 1a09c9ffe0..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/list-sessions.md +++ /dev/null @@ -1,38 +0,0 @@ -query { - usersListSessions( - userId: "<USER_ID>" - ) { - total - sessions { - _id - _createdAt - _updatedAt - userId - expire - provider - providerUid - providerAccessToken - providerAccessTokenExpiry - providerRefreshToken - ip - osCode - osName - osVersion - clientType - clientCode - clientName - clientVersion - clientEngine - clientEngineVersion - deviceName - deviceBrand - deviceModel - countryCode - countryName - current - factors - secret - mfaUpdatedAt - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list-targets.md b/docs/examples/1.6.x/server-graphql/examples/users/list-targets.md deleted file mode 100644 index 05e796f167..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/list-targets.md +++ /dev/null @@ -1,18 +0,0 @@ -query { - usersListTargets( - userId: "<USER_ID>", - queries: [] - ) { - total - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/list.md b/docs/examples/1.6.x/server-graphql/examples/users/list.md deleted file mode 100644 index e2326dd1a2..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/list.md +++ /dev/null @@ -1,40 +0,0 @@ -query { - usersList( - queries: [], - search: "<SEARCH>" - ) { - total - users { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-graphql/examples/users/update-email-verification.md deleted file mode 100644 index 6bb2781854..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-email-verification.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - usersUpdateEmailVerification( - userId: "<USER_ID>", - emailVerification: false - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-email.md b/docs/examples/1.6.x/server-graphql/examples/users/update-email.md deleted file mode 100644 index 046937ac04..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-email.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - usersUpdateEmail( - userId: "<USER_ID>", - email: "email@example.com" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-labels.md b/docs/examples/1.6.x/server-graphql/examples/users/update-labels.md deleted file mode 100644 index 93da33d805..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-labels.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - usersUpdateLabels( - userId: "<USER_ID>", - labels: [] - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-graphql/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index dbef2bd345..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,7 +0,0 @@ -mutation { - usersUpdateMfaRecoveryCodes( - userId: "<USER_ID>" - ) { - recoveryCodes - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-mfa.md b/docs/examples/1.6.x/server-graphql/examples/users/update-mfa.md deleted file mode 100644 index 9219aa1aea..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-mfa.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - usersUpdateMfa( - userId: "<USER_ID>", - mfa: false - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-name.md b/docs/examples/1.6.x/server-graphql/examples/users/update-name.md deleted file mode 100644 index 01a53ce479..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-name.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - usersUpdateName( - userId: "<USER_ID>", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-password.md b/docs/examples/1.6.x/server-graphql/examples/users/update-password.md deleted file mode 100644 index c95637c4ce..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-password.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - usersUpdatePassword( - userId: "<USER_ID>", - password: "" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-graphql/examples/users/update-phone-verification.md deleted file mode 100644 index 58343ae365..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-phone-verification.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - usersUpdatePhoneVerification( - userId: "<USER_ID>", - phoneVerification: false - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-phone.md b/docs/examples/1.6.x/server-graphql/examples/users/update-phone.md deleted file mode 100644 index dbcb076c65..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-phone.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - usersUpdatePhone( - userId: "<USER_ID>", - number: "+12065550100" - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-prefs.md b/docs/examples/1.6.x/server-graphql/examples/users/update-prefs.md deleted file mode 100644 index 431664c2a1..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-prefs.md +++ /dev/null @@ -1,8 +0,0 @@ -mutation { - usersUpdatePrefs( - userId: "<USER_ID>", - prefs: "{}" - ) { - data - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-status.md b/docs/examples/1.6.x/server-graphql/examples/users/update-status.md deleted file mode 100644 index ad05bc75ff..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-status.md +++ /dev/null @@ -1,37 +0,0 @@ -mutation { - usersUpdateStatus( - userId: "<USER_ID>", - status: false - ) { - _id - _createdAt - _updatedAt - name - password - hash - hashOptions - registration - status - labels - passwordUpdate - email - phone - emailVerification - phoneVerification - mfa - prefs { - data - } - targets { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } - accessedAt - } -} diff --git a/docs/examples/1.6.x/server-graphql/examples/users/update-target.md b/docs/examples/1.6.x/server-graphql/examples/users/update-target.md deleted file mode 100644 index fe3444ede7..0000000000 --- a/docs/examples/1.6.x/server-graphql/examples/users/update-target.md +++ /dev/null @@ -1,18 +0,0 @@ -mutation { - usersUpdateTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>", - identifier: "<IDENTIFIER>", - providerId: "<PROVIDER_ID>", - name: "<NAME>" - ) { - _id - _createdAt - _updatedAt - name - userId - providerId - providerType - identifier - } -} diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-anonymous-session.md b/docs/examples/1.6.x/server-kotlin/java/account/create-anonymous-session.md deleted file mode 100644 index afb56be804..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-anonymous-session.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createAnonymousSession(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-email-password-session.md b/docs/examples/1.6.x/server-kotlin/java/account/create-email-password-session.md deleted file mode 100644 index 88fd5a70ff..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-email-password-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createEmailPasswordSession( - "email@example.com", // email - "password", // password - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-email-token.md b/docs/examples/1.6.x/server-kotlin/java/account/create-email-token.md deleted file mode 100644 index 460f62954f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-email-token.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createEmailToken( - "<USER_ID>", // userId - "email@example.com", // email - false, // phrase (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-j-w-t.md b/docs/examples/1.6.x/server-kotlin/java/account/create-j-w-t.md deleted file mode 100644 index f22573630b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-j-w-t.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createJWT(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-kotlin/java/account/create-magic-u-r-l-token.md deleted file mode 100644 index 1f54eb392b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createMagicURLToken( - "<USER_ID>", // userId - "email@example.com", // email - "https://example.com", // url (optional) - false, // phrase (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-authenticator.md deleted file mode 100644 index 717d8dc06f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-authenticator.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; -import io.appwrite.enums.AuthenticatorType; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.createMfaAuthenticator( - AuthenticatorType.TOTP, // type - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-challenge.md deleted file mode 100644 index 6539f6aef8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-challenge.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; -import io.appwrite.enums.AuthenticationFactor; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createMfaChallenge( - AuthenticationFactor.EMAIL, // factor - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-recovery-codes.md deleted file mode 100644 index 80320549ff..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.createMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-o-auth2token.md b/docs/examples/1.6.x/server-kotlin/java/account/create-o-auth2token.md deleted file mode 100644 index 49831ab0d7..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-o-auth2token.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; -import io.appwrite.enums.OAuthProvider; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createOAuth2Token( - OAuthProvider.AMAZON, // provider - "https://example.com", // success (optional) - "https://example.com", // failure (optional) - listOf(), // scopes (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-phone-token.md b/docs/examples/1.6.x/server-kotlin/java/account/create-phone-token.md deleted file mode 100644 index 1c10fdced0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-phone-token.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createPhoneToken( - "<USER_ID>", // userId - "+12065550100", // phone - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-phone-verification.md b/docs/examples/1.6.x/server-kotlin/java/account/create-phone-verification.md deleted file mode 100644 index 1210764b23..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-phone-verification.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.createPhoneVerification(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-recovery.md b/docs/examples/1.6.x/server-kotlin/java/account/create-recovery.md deleted file mode 100644 index b7378759e9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-recovery.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.createRecovery( - "email@example.com", // email - "https://example.com", // url - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-session.md b/docs/examples/1.6.x/server-kotlin/java/account/create-session.md deleted file mode 100644 index d94a033e25..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.createSession( - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create-verification.md b/docs/examples/1.6.x/server-kotlin/java/account/create-verification.md deleted file mode 100644 index cace2e21c2..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create-verification.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.createVerification( - "https://example.com", // url - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/create.md b/docs/examples/1.6.x/server-kotlin/java/account/create.md deleted file mode 100644 index 4993399fbf..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/create.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.create( - "<USER_ID>", // userId - "email@example.com", // email - "", // password - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/delete-identity.md b/docs/examples/1.6.x/server-kotlin/java/account/delete-identity.md deleted file mode 100644 index e79ec7ca31..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/delete-identity.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.deleteIdentity( - "<IDENTITY_ID>", // identityId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/java/account/delete-mfa-authenticator.md deleted file mode 100644 index caec63e106..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; -import io.appwrite.enums.AuthenticatorType; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.deleteMfaAuthenticator( - AuthenticatorType.TOTP, // type - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/delete-session.md b/docs/examples/1.6.x/server-kotlin/java/account/delete-session.md deleted file mode 100644 index 31ef4a09bc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/delete-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.deleteSession( - "<SESSION_ID>", // sessionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/delete-sessions.md b/docs/examples/1.6.x/server-kotlin/java/account/delete-sessions.md deleted file mode 100644 index 1243f07336..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/delete-sessions.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.deleteSessions(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/account/get-mfa-recovery-codes.md deleted file mode 100644 index bea98a8709..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.getMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/get-prefs.md b/docs/examples/1.6.x/server-kotlin/java/account/get-prefs.md deleted file mode 100644 index 66278dde9b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/get-prefs.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.getPrefs(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/get-session.md b/docs/examples/1.6.x/server-kotlin/java/account/get-session.md deleted file mode 100644 index 3cdc9bae29..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/get-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.getSession( - "<SESSION_ID>", // sessionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/get.md b/docs/examples/1.6.x/server-kotlin/java/account/get.md deleted file mode 100644 index bcb05ae9b2..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/get.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.get(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/list-identities.md b/docs/examples/1.6.x/server-kotlin/java/account/list-identities.md deleted file mode 100644 index ca25eaab38..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/list-identities.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.listIdentities( - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/list-logs.md b/docs/examples/1.6.x/server-kotlin/java/account/list-logs.md deleted file mode 100644 index cee5a3fbf9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/list-logs.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.listLogs( - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/list-mfa-factors.md b/docs/examples/1.6.x/server-kotlin/java/account/list-mfa-factors.md deleted file mode 100644 index 4cee6beb3c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/list-mfa-factors.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.listMfaFactors(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/list-sessions.md b/docs/examples/1.6.x/server-kotlin/java/account/list-sessions.md deleted file mode 100644 index 0a39b9ffc3..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/list-sessions.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.listSessions(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-email.md b/docs/examples/1.6.x/server-kotlin/java/account/update-email.md deleted file mode 100644 index ad141ec783..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-email.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updateEmail( - "email@example.com", // email - "password", // password - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-m-f-a.md b/docs/examples/1.6.x/server-kotlin/java/account/update-m-f-a.md deleted file mode 100644 index c7570cf35a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-m-f-a.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updateMFA( - false, // mfa - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-kotlin/java/account/update-magic-u-r-l-session.md deleted file mode 100644 index 386d73ce44..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updateMagicURLSession( - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-authenticator.md deleted file mode 100644 index 397e02b49f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-authenticator.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; -import io.appwrite.enums.AuthenticatorType; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updateMfaAuthenticator( - AuthenticatorType.TOTP, // type - "<OTP>", // otp - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-challenge.md deleted file mode 100644 index 6ff8166b27..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-challenge.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updateMfaChallenge( - "<CHALLENGE_ID>", // challengeId - "<OTP>", // otp - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-recovery-codes.md deleted file mode 100644 index f3f653a8d4..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updateMfaRecoveryCodes(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-name.md b/docs/examples/1.6.x/server-kotlin/java/account/update-name.md deleted file mode 100644 index bf366fa6d7..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-name.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updateName( - "<NAME>", // name - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-password.md b/docs/examples/1.6.x/server-kotlin/java/account/update-password.md deleted file mode 100644 index b896c85778..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-password.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updatePassword( - "", // password - "password", // oldPassword (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-phone-session.md b/docs/examples/1.6.x/server-kotlin/java/account/update-phone-session.md deleted file mode 100644 index 6a8ba10995..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-phone-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>"); // Your project ID - -Account account = new Account(client); - -account.updatePhoneSession( - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-phone-verification.md b/docs/examples/1.6.x/server-kotlin/java/account/update-phone-verification.md deleted file mode 100644 index 0fe5bcb4c8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-phone-verification.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updatePhoneVerification( - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-phone.md b/docs/examples/1.6.x/server-kotlin/java/account/update-phone.md deleted file mode 100644 index 06217d293e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-phone.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updatePhone( - "+12065550100", // phone - "password", // password - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-prefs.md b/docs/examples/1.6.x/server-kotlin/java/account/update-prefs.md deleted file mode 100644 index aa063a48a1..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-prefs.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updatePrefs( - mapOf( "a" to "b" ), // prefs - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-recovery.md b/docs/examples/1.6.x/server-kotlin/java/account/update-recovery.md deleted file mode 100644 index e510c8e68b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-recovery.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updateRecovery( - "<USER_ID>", // userId - "<SECRET>", // secret - "", // password - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-session.md b/docs/examples/1.6.x/server-kotlin/java/account/update-session.md deleted file mode 100644 index a98b4c7f32..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updateSession( - "<SESSION_ID>", // sessionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-status.md b/docs/examples/1.6.x/server-kotlin/java/account/update-status.md deleted file mode 100644 index 3db7321168..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-status.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updateStatus(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/account/update-verification.md b/docs/examples/1.6.x/server-kotlin/java/account/update-verification.md deleted file mode 100644 index 6f977a849f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/account/update-verification.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Account; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Account account = new Account(client); - -account.updateVerification( - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-browser.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-browser.md deleted file mode 100644 index 472b13997a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/avatars/get-browser.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; -import io.appwrite.enums.Browser; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -avatars.getBrowser( - Browser.AVANT_BROWSER, // code - 0, // width (optional) - 0, // height (optional) - 0, // quality (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-credit-card.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-credit-card.md deleted file mode 100644 index 078baa931a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/avatars/get-credit-card.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; -import io.appwrite.enums.CreditCard; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -avatars.getCreditCard( - CreditCard.AMERICAN_EXPRESS, // code - 0, // width (optional) - 0, // height (optional) - 0, // quality (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-favicon.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-favicon.md deleted file mode 100644 index ce323b88dc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/avatars/get-favicon.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -avatars.getFavicon( - "https://example.com", // url - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-flag.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-flag.md deleted file mode 100644 index 26ae93997e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/avatars/get-flag.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; -import io.appwrite.enums.Flag; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -avatars.getFlag( - Flag.AFGHANISTAN, // code - 0, // width (optional) - 0, // height (optional) - 0, // quality (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-image.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-image.md deleted file mode 100644 index 1523a225fc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/avatars/get-image.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -avatars.getImage( - "https://example.com", // url - 0, // width (optional) - 0, // height (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-initials.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-initials.md deleted file mode 100644 index 54ff820c73..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/avatars/get-initials.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -avatars.getInitials( - "<NAME>", // name (optional) - 0, // width (optional) - 0, // height (optional) - "", // background (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/avatars/get-q-r.md b/docs/examples/1.6.x/server-kotlin/java/avatars/get-q-r.md deleted file mode 100644 index 479f3de2e2..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/avatars/get-q-r.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Avatars; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Avatars avatars = new Avatars(client); - -avatars.getQR( - "<TEXT>", // text - 1, // size (optional) - 0, // margin (optional) - false, // download (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-boolean-attribute.md deleted file mode 100644 index d53bc5ce70..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-boolean-attribute.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createBooleanAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - false, // default (optional) - false, // array (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-collection.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-collection.md deleted file mode 100644 index 4e5d750039..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-collection.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createCollection( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "<NAME>", // name - listOf("read("any")"), // permissions (optional) - false, // documentSecurity (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-datetime-attribute.md deleted file mode 100644 index d68ec098b4..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-datetime-attribute.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createDatetimeAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - "", // default (optional) - false, // array (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-document.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-document.md deleted file mode 100644 index d97c95b701..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-document.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Databases databases = new Databases(client); - -databases.createDocument( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "<DOCUMENT_ID>", // documentId - mapOf( "a" to "b" ), // data - listOf("read("any")"), // permissions (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-email-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-email-attribute.md deleted file mode 100644 index bb15a80759..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-email-attribute.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createEmailAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - "email@example.com", // default (optional) - false, // array (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-enum-attribute.md deleted file mode 100644 index 4abe265ef0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-enum-attribute.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createEnumAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - listOf(), // elements - false, // required - "<DEFAULT>", // default (optional) - false, // array (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-float-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-float-attribute.md deleted file mode 100644 index 8d915e1aec..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-float-attribute.md +++ /dev/null @@ -1,30 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createFloatAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - 0, // min (optional) - 0, // max (optional) - 0, // default (optional) - false, // array (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-index.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-index.md deleted file mode 100644 index 409c341c5d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-index.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; -import io.appwrite.enums.IndexType; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createIndex( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - IndexType.KEY, // type - listOf(), // attributes - listOf(), // orders (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-integer-attribute.md deleted file mode 100644 index b2eb37aff8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-integer-attribute.md +++ /dev/null @@ -1,30 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createIntegerAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - 0, // min (optional) - 0, // max (optional) - 0, // default (optional) - false, // array (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-ip-attribute.md deleted file mode 100644 index 66492bbd61..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-ip-attribute.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createIpAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - "", // default (optional) - false, // array (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-relationship-attribute.md deleted file mode 100644 index 4e76489755..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-relationship-attribute.md +++ /dev/null @@ -1,31 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; -import io.appwrite.enums.RelationshipType; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createRelationshipAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "<RELATED_COLLECTION_ID>", // relatedCollectionId - RelationshipType.ONETOONE, // type - false, // twoWay (optional) - "", // key (optional) - "", // twoWayKey (optional) - RelationMutate.CASCADE, // onDelete (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-string-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-string-attribute.md deleted file mode 100644 index 64c3f60da2..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-string-attribute.md +++ /dev/null @@ -1,30 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createStringAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - 1, // size - false, // required - "<DEFAULT>", // default (optional) - false, // array (optional) - false, // encrypt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create-url-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/create-url-attribute.md deleted file mode 100644 index 1c68dc7a0d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create-url-attribute.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.createUrlAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - "https://example.com", // default (optional) - false, // array (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/create.md b/docs/examples/1.6.x/server-kotlin/java/databases/create.md deleted file mode 100644 index a9a13a9573..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/create.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.create( - "<DATABASE_ID>", // databaseId - "<NAME>", // name - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/delete-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/delete-attribute.md deleted file mode 100644 index 48daa6ba8b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/delete-attribute.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.deleteAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/delete-collection.md b/docs/examples/1.6.x/server-kotlin/java/databases/delete-collection.md deleted file mode 100644 index dfe3c7a787..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/delete-collection.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.deleteCollection( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/delete-document.md b/docs/examples/1.6.x/server-kotlin/java/databases/delete-document.md deleted file mode 100644 index 4d4f552335..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/delete-document.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Databases databases = new Databases(client); - -databases.deleteDocument( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "<DOCUMENT_ID>", // documentId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/delete-index.md b/docs/examples/1.6.x/server-kotlin/java/databases/delete-index.md deleted file mode 100644 index aa21f3bab2..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/delete-index.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.deleteIndex( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/delete.md b/docs/examples/1.6.x/server-kotlin/java/databases/delete.md deleted file mode 100644 index 137908cedb..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/delete.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.delete( - "<DATABASE_ID>", // databaseId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/get-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/get-attribute.md deleted file mode 100644 index c413490e11..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/get-attribute.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.getAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/get-collection.md b/docs/examples/1.6.x/server-kotlin/java/databases/get-collection.md deleted file mode 100644 index 271e7bcae5..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/get-collection.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.getCollection( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/get-document.md b/docs/examples/1.6.x/server-kotlin/java/databases/get-document.md deleted file mode 100644 index 3a371f31be..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/get-document.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Databases databases = new Databases(client); - -databases.getDocument( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "<DOCUMENT_ID>", // documentId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/get-index.md b/docs/examples/1.6.x/server-kotlin/java/databases/get-index.md deleted file mode 100644 index 0e8e2114cd..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/get-index.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.getIndex( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/get.md b/docs/examples/1.6.x/server-kotlin/java/databases/get.md deleted file mode 100644 index 8468ea27c9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/get.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.get( - "<DATABASE_ID>", // databaseId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/list-attributes.md b/docs/examples/1.6.x/server-kotlin/java/databases/list-attributes.md deleted file mode 100644 index 198135e8c8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/list-attributes.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.listAttributes( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/list-collections.md b/docs/examples/1.6.x/server-kotlin/java/databases/list-collections.md deleted file mode 100644 index a45ec1e26b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/list-collections.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.listCollections( - "<DATABASE_ID>", // databaseId - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/list-documents.md b/docs/examples/1.6.x/server-kotlin/java/databases/list-documents.md deleted file mode 100644 index 7b713310ef..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/list-documents.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Databases databases = new Databases(client); - -databases.listDocuments( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/list-indexes.md b/docs/examples/1.6.x/server-kotlin/java/databases/list-indexes.md deleted file mode 100644 index a68d32ce8f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/list-indexes.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.listIndexes( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/list.md b/docs/examples/1.6.x/server-kotlin/java/databases/list.md deleted file mode 100644 index 4c32c5d710..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/list.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.list( - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-boolean-attribute.md deleted file mode 100644 index 0603e65f68..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-boolean-attribute.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateBooleanAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - false, // default - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-collection.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-collection.md deleted file mode 100644 index 635b90a5fa..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-collection.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateCollection( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "<NAME>", // name - listOf("read("any")"), // permissions (optional) - false, // documentSecurity (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-datetime-attribute.md deleted file mode 100644 index fc18da151f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-datetime-attribute.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateDatetimeAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - "", // default - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-document.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-document.md deleted file mode 100644 index 640844e7a5..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-document.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Databases databases = new Databases(client); - -databases.updateDocument( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "<DOCUMENT_ID>", // documentId - mapOf( "a" to "b" ), // data (optional) - listOf("read("any")"), // permissions (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-email-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-email-attribute.md deleted file mode 100644 index bba1515d9a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-email-attribute.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateEmailAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - "email@example.com", // default - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-enum-attribute.md deleted file mode 100644 index c72daa53f7..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-enum-attribute.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateEnumAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - listOf(), // elements - false, // required - "<DEFAULT>", // default - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-float-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-float-attribute.md deleted file mode 100644 index 95b53aa41e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-float-attribute.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateFloatAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - 0, // min - 0, // max - 0, // default - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-integer-attribute.md deleted file mode 100644 index dbac379835..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-integer-attribute.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateIntegerAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - 0, // min - 0, // max - 0, // default - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-ip-attribute.md deleted file mode 100644 index c9b699f37a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-ip-attribute.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateIpAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - "", // default - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-relationship-attribute.md deleted file mode 100644 index b84cbe7877..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-relationship-attribute.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateRelationshipAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - RelationMutate.CASCADE, // onDelete (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-string-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-string-attribute.md deleted file mode 100644 index f314048e86..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-string-attribute.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateStringAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - "<DEFAULT>", // default - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update-url-attribute.md b/docs/examples/1.6.x/server-kotlin/java/databases/update-url-attribute.md deleted file mode 100644 index 6deacfb3e1..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update-url-attribute.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateUrlAttribute( - "<DATABASE_ID>", // databaseId - "<COLLECTION_ID>", // collectionId - "", // key - false, // required - "https://example.com", // default - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/databases/update.md b/docs/examples/1.6.x/server-kotlin/java/databases/update.md deleted file mode 100644 index f7b7ee75fb..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/databases/update.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Databases databases = new Databases(client); - -databases.update( - "<DATABASE_ID>", // databaseId - "<NAME>", // name - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/create-build.md b/docs/examples/1.6.x/server-kotlin/java/functions/create-build.md deleted file mode 100644 index 7ac366e2dd..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/create-build.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.createBuild( - "<FUNCTION_ID>", // functionId - "<DEPLOYMENT_ID>", // deploymentId - "<BUILD_ID>", // buildId (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/create-deployment.md b/docs/examples/1.6.x/server-kotlin/java/functions/create-deployment.md deleted file mode 100644 index a798515cef..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/create-deployment.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.models.InputFile; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.createDeployment( - "<FUNCTION_ID>", // functionId - InputFile.fromPath("file.png"), // code - false, // activate - "<ENTRYPOINT>", // entrypoint (optional) - "<COMMANDS>", // commands (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/create-execution.md b/docs/examples/1.6.x/server-kotlin/java/functions/create-execution.md deleted file mode 100644 index bd293011a7..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/create-execution.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Functions functions = new Functions(client); - -functions.createExecution( - "<FUNCTION_ID>", // functionId - "<BODY>", // body (optional) - false, // async (optional) - "<PATH>", // path (optional) - ExecutionMethod.GET, // method (optional) - mapOf( "a" to "b" ), // headers (optional) - "", // scheduledAt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/create-variable.md b/docs/examples/1.6.x/server-kotlin/java/functions/create-variable.md deleted file mode 100644 index 0190350dc1..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/create-variable.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.createVariable( - "<FUNCTION_ID>", // functionId - "<KEY>", // key - "<VALUE>", // value - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/create.md b/docs/examples/1.6.x/server-kotlin/java/functions/create.md deleted file mode 100644 index 5c577d176a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/create.md +++ /dev/null @@ -1,44 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; -import io.appwrite.enums.Runtime; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.create( - "<FUNCTION_ID>", // functionId - "<NAME>", // name - .NODE_14_5, // runtime - listOf("any"), // execute (optional) - listOf(), // events (optional) - "", // schedule (optional) - 1, // timeout (optional) - false, // enabled (optional) - false, // logging (optional) - "<ENTRYPOINT>", // entrypoint (optional) - "<COMMANDS>", // commands (optional) - listOf(), // scopes (optional) - "<INSTALLATION_ID>", // installationId (optional) - "<PROVIDER_REPOSITORY_ID>", // providerRepositoryId (optional) - "<PROVIDER_BRANCH>", // providerBranch (optional) - false, // providerSilentMode (optional) - "<PROVIDER_ROOT_DIRECTORY>", // providerRootDirectory (optional) - "<TEMPLATE_REPOSITORY>", // templateRepository (optional) - "<TEMPLATE_OWNER>", // templateOwner (optional) - "<TEMPLATE_ROOT_DIRECTORY>", // templateRootDirectory (optional) - "<TEMPLATE_BRANCH>", // templateBranch (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/delete-deployment.md b/docs/examples/1.6.x/server-kotlin/java/functions/delete-deployment.md deleted file mode 100644 index 8394c022bb..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/delete-deployment.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.deleteDeployment( - "<FUNCTION_ID>", // functionId - "<DEPLOYMENT_ID>", // deploymentId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/delete-execution.md b/docs/examples/1.6.x/server-kotlin/java/functions/delete-execution.md deleted file mode 100644 index 05d1146ff0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/delete-execution.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.deleteExecution( - "<FUNCTION_ID>", // functionId - "<EXECUTION_ID>", // executionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/delete-variable.md b/docs/examples/1.6.x/server-kotlin/java/functions/delete-variable.md deleted file mode 100644 index 6de7a49f47..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/delete-variable.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.deleteVariable( - "<FUNCTION_ID>", // functionId - "<VARIABLE_ID>", // variableId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/delete.md b/docs/examples/1.6.x/server-kotlin/java/functions/delete.md deleted file mode 100644 index cf083dc79e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/delete.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.delete( - "<FUNCTION_ID>", // functionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/download-deployment.md b/docs/examples/1.6.x/server-kotlin/java/functions/download-deployment.md deleted file mode 100644 index 7a05d1d133..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/download-deployment.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.downloadDeployment( - "<FUNCTION_ID>", // functionId - "<DEPLOYMENT_ID>", // deploymentId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/get-deployment.md b/docs/examples/1.6.x/server-kotlin/java/functions/get-deployment.md deleted file mode 100644 index 1b4252fbf4..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/get-deployment.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.getDeployment( - "<FUNCTION_ID>", // functionId - "<DEPLOYMENT_ID>", // deploymentId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/get-execution.md b/docs/examples/1.6.x/server-kotlin/java/functions/get-execution.md deleted file mode 100644 index e4172cb0c3..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/get-execution.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Functions functions = new Functions(client); - -functions.getExecution( - "<FUNCTION_ID>", // functionId - "<EXECUTION_ID>", // executionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/get-variable.md b/docs/examples/1.6.x/server-kotlin/java/functions/get-variable.md deleted file mode 100644 index 2ef45c0645..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/get-variable.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.getVariable( - "<FUNCTION_ID>", // functionId - "<VARIABLE_ID>", // variableId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/get.md b/docs/examples/1.6.x/server-kotlin/java/functions/get.md deleted file mode 100644 index ff467f7df4..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/get.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.get( - "<FUNCTION_ID>", // functionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/list-deployments.md b/docs/examples/1.6.x/server-kotlin/java/functions/list-deployments.md deleted file mode 100644 index c5b9f0d5da..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/list-deployments.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.listDeployments( - "<FUNCTION_ID>", // functionId - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/list-executions.md b/docs/examples/1.6.x/server-kotlin/java/functions/list-executions.md deleted file mode 100644 index 8990b5fe16..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/list-executions.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Functions functions = new Functions(client); - -functions.listExecutions( - "<FUNCTION_ID>", // functionId - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/list-runtimes.md b/docs/examples/1.6.x/server-kotlin/java/functions/list-runtimes.md deleted file mode 100644 index 3fff39063a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/list-runtimes.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.listRuntimes(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/list-variables.md b/docs/examples/1.6.x/server-kotlin/java/functions/list-variables.md deleted file mode 100644 index 8fb1809a46..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/list-variables.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.listVariables( - "<FUNCTION_ID>", // functionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/list.md b/docs/examples/1.6.x/server-kotlin/java/functions/list.md deleted file mode 100644 index 8ec39b4341..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/list.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.list( - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment-build.md b/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment-build.md deleted file mode 100644 index 49aba048b4..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment-build.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.updateDeploymentBuild( - "<FUNCTION_ID>", // functionId - "<DEPLOYMENT_ID>", // deploymentId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment.md b/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment.md deleted file mode 100644 index 2e3e853a73..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/update-deployment.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.updateDeployment( - "<FUNCTION_ID>", // functionId - "<DEPLOYMENT_ID>", // deploymentId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/update-variable.md b/docs/examples/1.6.x/server-kotlin/java/functions/update-variable.md deleted file mode 100644 index fb75e39bba..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/update-variable.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.updateVariable( - "<FUNCTION_ID>", // functionId - "<VARIABLE_ID>", // variableId - "<KEY>", // key - "<VALUE>", // value (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/functions/update.md b/docs/examples/1.6.x/server-kotlin/java/functions/update.md deleted file mode 100644 index 208b0b7fa3..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/functions/update.md +++ /dev/null @@ -1,39 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Functions; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Functions functions = new Functions(client); - -functions.update( - "<FUNCTION_ID>", // functionId - "<NAME>", // name - .NODE_14_5, // runtime (optional) - listOf("any"), // execute (optional) - listOf(), // events (optional) - "", // schedule (optional) - 1, // timeout (optional) - false, // enabled (optional) - false, // logging (optional) - "<ENTRYPOINT>", // entrypoint (optional) - "<COMMANDS>", // commands (optional) - listOf(), // scopes (optional) - "<INSTALLATION_ID>", // installationId (optional) - "<PROVIDER_REPOSITORY_ID>", // providerRepositoryId (optional) - "<PROVIDER_BRANCH>", // providerBranch (optional) - false, // providerSilentMode (optional) - "<PROVIDER_ROOT_DIRECTORY>", // providerRootDirectory (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/graphql/mutation.md b/docs/examples/1.6.x/server-kotlin/java/graphql/mutation.md deleted file mode 100644 index 6027a76f96..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/graphql/mutation.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Graphql; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Graphql graphql = new Graphql(client); - -graphql.mutation( - mapOf( "a" to "b" ), // query - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/graphql/query.md b/docs/examples/1.6.x/server-kotlin/java/graphql/query.md deleted file mode 100644 index 00c1fb8b36..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/graphql/query.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Graphql; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Graphql graphql = new Graphql(client); - -graphql.query( - mapOf( "a" to "b" ), // query - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-antivirus.md b/docs/examples/1.6.x/server-kotlin/java/health/get-antivirus.md deleted file mode 100644 index 67d5a32e1f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-antivirus.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getAntivirus(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-cache.md b/docs/examples/1.6.x/server-kotlin/java/health/get-cache.md deleted file mode 100644 index 0403d593e3..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-cache.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getCache(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-certificate.md b/docs/examples/1.6.x/server-kotlin/java/health/get-certificate.md deleted file mode 100644 index 60b0aa0e90..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-certificate.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getCertificate( - "", // domain (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-d-b.md b/docs/examples/1.6.x/server-kotlin/java/health/get-d-b.md deleted file mode 100644 index 7f5d86b7ac..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-d-b.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getDB(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-failed-jobs.md b/docs/examples/1.6.x/server-kotlin/java/health/get-failed-jobs.md deleted file mode 100644 index e5a62b0d05..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-failed-jobs.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; -import io.appwrite.enums.Name; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getFailedJobs( - .V1_DATABASE, // name - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-pub-sub.md b/docs/examples/1.6.x/server-kotlin/java/health/get-pub-sub.md deleted file mode 100644 index a842469051..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-pub-sub.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getPubSub(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-builds.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-builds.md deleted file mode 100644 index af9d794851..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-builds.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueBuilds( - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-certificates.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-certificates.md deleted file mode 100644 index 7a7b8ac65b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-certificates.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueCertificates( - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-databases.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-databases.md deleted file mode 100644 index 5c76eb3778..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-databases.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueDatabases( - "<NAME>", // name (optional) - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-deletes.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-deletes.md deleted file mode 100644 index a070618884..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-deletes.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueDeletes( - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-functions.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-functions.md deleted file mode 100644 index 0449422e01..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-functions.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueFunctions( - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-logs.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-logs.md deleted file mode 100644 index 1f1cdaef2e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-logs.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueLogs( - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-mails.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-mails.md deleted file mode 100644 index d10e9216d5..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-mails.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueMails( - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-messaging.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-messaging.md deleted file mode 100644 index ab4f6ce286..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-messaging.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueMessaging( - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-migrations.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-migrations.md deleted file mode 100644 index ade6eba83e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-migrations.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueMigrations( - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage-dump.md deleted file mode 100644 index aad0c4501a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage-dump.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueUsageDump( - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage.md deleted file mode 100644 index 3b56152288..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-usage.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueUsage( - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue-webhooks.md deleted file mode 100644 index 5a31cc934e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue-webhooks.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueueWebhooks( - 0, // threshold (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-queue.md b/docs/examples/1.6.x/server-kotlin/java/health/get-queue.md deleted file mode 100644 index b4fe3d6523..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-queue.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getQueue(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-storage-local.md b/docs/examples/1.6.x/server-kotlin/java/health/get-storage-local.md deleted file mode 100644 index 943189f0ce..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-storage-local.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getStorageLocal(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-storage.md b/docs/examples/1.6.x/server-kotlin/java/health/get-storage.md deleted file mode 100644 index cde88d48ce..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-storage.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getStorage(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get-time.md b/docs/examples/1.6.x/server-kotlin/java/health/get-time.md deleted file mode 100644 index e82314f308..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get-time.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.getTime(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/health/get.md b/docs/examples/1.6.x/server-kotlin/java/health/get.md deleted file mode 100644 index 21c537ed87..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/health/get.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Health; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Health health = new Health(client); - -health.get(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/get.md b/docs/examples/1.6.x/server-kotlin/java/locale/get.md deleted file mode 100644 index 3ae989ccd5..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/locale/get.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -locale.get(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-codes.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-codes.md deleted file mode 100644 index c6cab74b77..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/locale/list-codes.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -locale.listCodes(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-continents.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-continents.md deleted file mode 100644 index 8e405df37b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/locale/list-continents.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -locale.listContinents(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-e-u.md deleted file mode 100644 index 60d3dd9aaf..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-e-u.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -locale.listCountriesEU(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-phones.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-phones.md deleted file mode 100644 index 170f7407a6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/locale/list-countries-phones.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -locale.listCountriesPhones(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-countries.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-countries.md deleted file mode 100644 index 2ca54be387..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/locale/list-countries.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -locale.listCountries(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-currencies.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-currencies.md deleted file mode 100644 index 2acd674d44..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/locale/list-currencies.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -locale.listCurrencies(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/locale/list-languages.md b/docs/examples/1.6.x/server-kotlin/java/locale/list-languages.md deleted file mode 100644 index c616511e17..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/locale/list-languages.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Locale; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Locale locale = new Locale(client); - -locale.listLanguages(new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); -})); diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-apns-provider.md deleted file mode 100644 index 6a2d5f4898..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-apns-provider.md +++ /dev/null @@ -1,30 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createApnsProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name - "<AUTH_KEY>", // authKey (optional) - "<AUTH_KEY_ID>", // authKeyId (optional) - "<TEAM_ID>", // teamId (optional) - "<BUNDLE_ID>", // bundleId (optional) - false, // sandbox (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-email.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-email.md deleted file mode 100644 index 4efc2431df..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-email.md +++ /dev/null @@ -1,34 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createEmail( - "<MESSAGE_ID>", // messageId - "<SUBJECT>", // subject - "<CONTENT>", // content - listOf(), // topics (optional) - listOf(), // users (optional) - listOf(), // targets (optional) - listOf(), // cc (optional) - listOf(), // bcc (optional) - listOf(), // attachments (optional) - false, // draft (optional) - false, // html (optional) - "", // scheduledAt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-fcm-provider.md deleted file mode 100644 index 2f396d42ad..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-fcm-provider.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createFcmProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name - mapOf( "a" to "b" ), // serviceAccountJSON (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-mailgun-provider.md deleted file mode 100644 index f04fe96d83..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,32 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createMailgunProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name - "<API_KEY>", // apiKey (optional) - "<DOMAIN>", // domain (optional) - false, // isEuRegion (optional) - "<FROM_NAME>", // fromName (optional) - "email@example.com", // fromEmail (optional) - "<REPLY_TO_NAME>", // replyToName (optional) - "email@example.com", // replyToEmail (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-msg91provider.md deleted file mode 100644 index 9ca7d4661b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-msg91provider.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createMsg91Provider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name - "<TEMPLATE_ID>", // templateId (optional) - "<SENDER_ID>", // senderId (optional) - "<AUTH_KEY>", // authKey (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-push.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-push.md deleted file mode 100644 index 125cff194e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-push.md +++ /dev/null @@ -1,38 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createPush( - "<MESSAGE_ID>", // messageId - "<TITLE>", // title - "<BODY>", // body - listOf(), // topics (optional) - listOf(), // users (optional) - listOf(), // targets (optional) - mapOf( "a" to "b" ), // data (optional) - "<ACTION>", // action (optional) - "[ID1:ID2]", // image (optional) - "<ICON>", // icon (optional) - "<SOUND>", // sound (optional) - "<COLOR>", // color (optional) - "<TAG>", // tag (optional) - "<BADGE>", // badge (optional) - false, // draft (optional) - "", // scheduledAt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-sendgrid-provider.md deleted file mode 100644 index d23c18a34c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,30 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createSendgridProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name - "<API_KEY>", // apiKey (optional) - "<FROM_NAME>", // fromName (optional) - "email@example.com", // fromEmail (optional) - "<REPLY_TO_NAME>", // replyToName (optional) - "email@example.com", // replyToEmail (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-sms.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-sms.md deleted file mode 100644 index f4e79bd272..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-sms.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createSms( - "<MESSAGE_ID>", // messageId - "<CONTENT>", // content - listOf(), // topics (optional) - listOf(), // users (optional) - listOf(), // targets (optional) - false, // draft (optional) - "", // scheduledAt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-smtp-provider.md deleted file mode 100644 index e459c32cb8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-smtp-provider.md +++ /dev/null @@ -1,36 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createSmtpProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name - "<HOST>", // host - 1, // port (optional) - "<USERNAME>", // username (optional) - "<PASSWORD>", // password (optional) - SmtpEncryption.NONE, // encryption (optional) - false, // autoTLS (optional) - "<MAILER>", // mailer (optional) - "<FROM_NAME>", // fromName (optional) - "email@example.com", // fromEmail (optional) - "<REPLY_TO_NAME>", // replyToName (optional) - "email@example.com", // replyToEmail (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-subscriber.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-subscriber.md deleted file mode 100644 index 7ac08fccf2..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-subscriber.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setJWT("<YOUR_JWT>"); // Your secret JSON Web Token - -Messaging messaging = new Messaging(client); - -messaging.createSubscriber( - "<TOPIC_ID>", // topicId - "<SUBSCRIBER_ID>", // subscriberId - "<TARGET_ID>", // targetId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-telesign-provider.md deleted file mode 100644 index 1e6a0816fc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-telesign-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createTelesignProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name - "+12065550100", // from (optional) - "<CUSTOMER_ID>", // customerId (optional) - "<API_KEY>", // apiKey (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-textmagic-provider.md deleted file mode 100644 index 4077900ada..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createTextmagicProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name - "+12065550100", // from (optional) - "<USERNAME>", // username (optional) - "<API_KEY>", // apiKey (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-topic.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-topic.md deleted file mode 100644 index 4f0adffd1a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-topic.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createTopic( - "<TOPIC_ID>", // topicId - "<NAME>", // name - listOf("any"), // subscribe (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-twilio-provider.md deleted file mode 100644 index 8193a70d4c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-twilio-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createTwilioProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name - "+12065550100", // from (optional) - "<ACCOUNT_SID>", // accountSid (optional) - "<AUTH_TOKEN>", // authToken (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/create-vonage-provider.md deleted file mode 100644 index 52e58913b0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/create-vonage-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.createVonageProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name - "+12065550100", // from (optional) - "<API_KEY>", // apiKey (optional) - "<API_SECRET>", // apiSecret (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/delete-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/delete-provider.md deleted file mode 100644 index 9a4b0c2d6f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/delete-provider.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.deleteProvider( - "<PROVIDER_ID>", // providerId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-kotlin/java/messaging/delete-subscriber.md deleted file mode 100644 index 42e46f1437..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/delete-subscriber.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setJWT("<YOUR_JWT>"); // Your secret JSON Web Token - -Messaging messaging = new Messaging(client); - -messaging.deleteSubscriber( - "<TOPIC_ID>", // topicId - "<SUBSCRIBER_ID>", // subscriberId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/delete-topic.md b/docs/examples/1.6.x/server-kotlin/java/messaging/delete-topic.md deleted file mode 100644 index 755fda8308..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/delete-topic.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.deleteTopic( - "<TOPIC_ID>", // topicId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/delete.md b/docs/examples/1.6.x/server-kotlin/java/messaging/delete.md deleted file mode 100644 index d16b5d17d5..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/delete.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.delete( - "<MESSAGE_ID>", // messageId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/get-message.md b/docs/examples/1.6.x/server-kotlin/java/messaging/get-message.md deleted file mode 100644 index b591ba6f90..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/get-message.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.getMessage( - "<MESSAGE_ID>", // messageId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/get-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/get-provider.md deleted file mode 100644 index fc5869aa7c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/get-provider.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.getProvider( - "<PROVIDER_ID>", // providerId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/get-subscriber.md b/docs/examples/1.6.x/server-kotlin/java/messaging/get-subscriber.md deleted file mode 100644 index 3b1efb13c4..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/get-subscriber.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.getSubscriber( - "<TOPIC_ID>", // topicId - "<SUBSCRIBER_ID>", // subscriberId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/get-topic.md b/docs/examples/1.6.x/server-kotlin/java/messaging/get-topic.md deleted file mode 100644 index 103be8518d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/get-topic.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.getTopic( - "<TOPIC_ID>", // topicId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-message-logs.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-message-logs.md deleted file mode 100644 index c665b28404..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/list-message-logs.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.listMessageLogs( - "<MESSAGE_ID>", // messageId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-messages.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-messages.md deleted file mode 100644 index d337ab8c6c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/list-messages.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.listMessages( - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-provider-logs.md deleted file mode 100644 index 5b6384fe5f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/list-provider-logs.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.listProviderLogs( - "<PROVIDER_ID>", // providerId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-providers.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-providers.md deleted file mode 100644 index 1fe366343c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/list-providers.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.listProviders( - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscriber-logs.md deleted file mode 100644 index 5a85cd8860..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.listSubscriberLogs( - "<SUBSCRIBER_ID>", // subscriberId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscribers.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscribers.md deleted file mode 100644 index da0903628c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/list-subscribers.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.listSubscribers( - "<TOPIC_ID>", // topicId - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-targets.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-targets.md deleted file mode 100644 index 7e3a843e5a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/list-targets.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.listTargets( - "<MESSAGE_ID>", // messageId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-topic-logs.md deleted file mode 100644 index 74d27a9686..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/list-topic-logs.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.listTopicLogs( - "<TOPIC_ID>", // topicId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/list-topics.md b/docs/examples/1.6.x/server-kotlin/java/messaging/list-topics.md deleted file mode 100644 index 7fa18e3215..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/list-topics.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.listTopics( - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-apns-provider.md deleted file mode 100644 index eac01ee769..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-apns-provider.md +++ /dev/null @@ -1,30 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateApnsProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name (optional) - false, // enabled (optional) - "<AUTH_KEY>", // authKey (optional) - "<AUTH_KEY_ID>", // authKeyId (optional) - "<TEAM_ID>", // teamId (optional) - "<BUNDLE_ID>", // bundleId (optional) - false, // sandbox (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-email.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-email.md deleted file mode 100644 index fc58dbb0a0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-email.md +++ /dev/null @@ -1,34 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateEmail( - "<MESSAGE_ID>", // messageId - listOf(), // topics (optional) - listOf(), // users (optional) - listOf(), // targets (optional) - "<SUBJECT>", // subject (optional) - "<CONTENT>", // content (optional) - false, // draft (optional) - false, // html (optional) - listOf(), // cc (optional) - listOf(), // bcc (optional) - "", // scheduledAt (optional) - listOf(), // attachments (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-fcm-provider.md deleted file mode 100644 index f7450b5141..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-fcm-provider.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateFcmProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name (optional) - false, // enabled (optional) - mapOf( "a" to "b" ), // serviceAccountJSON (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-mailgun-provider.md deleted file mode 100644 index 7c1c0e136f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,32 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateMailgunProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name (optional) - "<API_KEY>", // apiKey (optional) - "<DOMAIN>", // domain (optional) - false, // isEuRegion (optional) - false, // enabled (optional) - "<FROM_NAME>", // fromName (optional) - "email@example.com", // fromEmail (optional) - "<REPLY_TO_NAME>", // replyToName (optional) - "<REPLY_TO_EMAIL>", // replyToEmail (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-msg91provider.md deleted file mode 100644 index 4014002343..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-msg91provider.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateMsg91Provider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name (optional) - false, // enabled (optional) - "<TEMPLATE_ID>", // templateId (optional) - "<SENDER_ID>", // senderId (optional) - "<AUTH_KEY>", // authKey (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-push.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-push.md deleted file mode 100644 index 5455a05773..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-push.md +++ /dev/null @@ -1,38 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updatePush( - "<MESSAGE_ID>", // messageId - listOf(), // topics (optional) - listOf(), // users (optional) - listOf(), // targets (optional) - "<TITLE>", // title (optional) - "<BODY>", // body (optional) - mapOf( "a" to "b" ), // data (optional) - "<ACTION>", // action (optional) - "[ID1:ID2]", // image (optional) - "<ICON>", // icon (optional) - "<SOUND>", // sound (optional) - "<COLOR>", // color (optional) - "<TAG>", // tag (optional) - 0, // badge (optional) - false, // draft (optional) - "", // scheduledAt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-sendgrid-provider.md deleted file mode 100644 index 9e6cd5e1a0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,30 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateSendgridProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name (optional) - false, // enabled (optional) - "<API_KEY>", // apiKey (optional) - "<FROM_NAME>", // fromName (optional) - "email@example.com", // fromEmail (optional) - "<REPLY_TO_NAME>", // replyToName (optional) - "<REPLY_TO_EMAIL>", // replyToEmail (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-sms.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-sms.md deleted file mode 100644 index 1839bb0d21..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-sms.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateSms( - "<MESSAGE_ID>", // messageId - listOf(), // topics (optional) - listOf(), // users (optional) - listOf(), // targets (optional) - "<CONTENT>", // content (optional) - false, // draft (optional) - "", // scheduledAt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-smtp-provider.md deleted file mode 100644 index 0522418b86..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-smtp-provider.md +++ /dev/null @@ -1,36 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateSmtpProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name (optional) - "<HOST>", // host (optional) - 1, // port (optional) - "<USERNAME>", // username (optional) - "<PASSWORD>", // password (optional) - SmtpEncryption.NONE, // encryption (optional) - false, // autoTLS (optional) - "<MAILER>", // mailer (optional) - "<FROM_NAME>", // fromName (optional) - "email@example.com", // fromEmail (optional) - "<REPLY_TO_NAME>", // replyToName (optional) - "<REPLY_TO_EMAIL>", // replyToEmail (optional) - false, // enabled (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-telesign-provider.md deleted file mode 100644 index 6d7701cfe7..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-telesign-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateTelesignProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name (optional) - false, // enabled (optional) - "<CUSTOMER_ID>", // customerId (optional) - "<API_KEY>", // apiKey (optional) - "<FROM>", // from (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-textmagic-provider.md deleted file mode 100644 index bdd6e28c96..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateTextmagicProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name (optional) - false, // enabled (optional) - "<USERNAME>", // username (optional) - "<API_KEY>", // apiKey (optional) - "<FROM>", // from (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-topic.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-topic.md deleted file mode 100644 index e40b0828dd..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-topic.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateTopic( - "<TOPIC_ID>", // topicId - "<NAME>", // name (optional) - listOf("any"), // subscribe (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-twilio-provider.md deleted file mode 100644 index ec4b143c24..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-twilio-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateTwilioProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name (optional) - false, // enabled (optional) - "<ACCOUNT_SID>", // accountSid (optional) - "<AUTH_TOKEN>", // authToken (optional) - "<FROM>", // from (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-kotlin/java/messaging/update-vonage-provider.md deleted file mode 100644 index 793c5cd0e2..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/messaging/update-vonage-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Messaging; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Messaging messaging = new Messaging(client); - -messaging.updateVonageProvider( - "<PROVIDER_ID>", // providerId - "<NAME>", // name (optional) - false, // enabled (optional) - "<API_KEY>", // apiKey (optional) - "<API_SECRET>", // apiSecret (optional) - "<FROM>", // from (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/create-bucket.md b/docs/examples/1.6.x/server-kotlin/java/storage/create-bucket.md deleted file mode 100644 index e4c88e9db8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/create-bucket.md +++ /dev/null @@ -1,32 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Storage storage = new Storage(client); - -storage.createBucket( - "<BUCKET_ID>", // bucketId - "<NAME>", // name - listOf("read("any")"), // permissions (optional) - false, // fileSecurity (optional) - false, // enabled (optional) - 1, // maximumFileSize (optional) - listOf(), // allowedFileExtensions (optional) - .NONE, // compression (optional) - false, // encryption (optional) - false, // antivirus (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/create-file.md b/docs/examples/1.6.x/server-kotlin/java/storage/create-file.md deleted file mode 100644 index 16e31ffddc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/create-file.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.models.InputFile; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -storage.createFile( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - InputFile.fromPath("file.png"), // file - listOf("read("any")"), // permissions (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/delete-bucket.md b/docs/examples/1.6.x/server-kotlin/java/storage/delete-bucket.md deleted file mode 100644 index ebe69ac757..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/delete-bucket.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Storage storage = new Storage(client); - -storage.deleteBucket( - "<BUCKET_ID>", // bucketId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/delete-file.md b/docs/examples/1.6.x/server-kotlin/java/storage/delete-file.md deleted file mode 100644 index c34239d51e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/delete-file.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -storage.deleteFile( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/get-bucket.md b/docs/examples/1.6.x/server-kotlin/java/storage/get-bucket.md deleted file mode 100644 index bf30afd397..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/get-bucket.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Storage storage = new Storage(client); - -storage.getBucket( - "<BUCKET_ID>", // bucketId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/get-file-download.md b/docs/examples/1.6.x/server-kotlin/java/storage/get-file-download.md deleted file mode 100644 index 6433b17e3b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/get-file-download.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -storage.getFileDownload( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/get-file-preview.md b/docs/examples/1.6.x/server-kotlin/java/storage/get-file-preview.md deleted file mode 100644 index d2e5fcb085..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/get-file-preview.md +++ /dev/null @@ -1,35 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -storage.getFilePreview( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - 0, // width (optional) - 0, // height (optional) - ImageGravity.CENTER, // gravity (optional) - 0, // quality (optional) - 0, // borderWidth (optional) - "", // borderColor (optional) - 0, // borderRadius (optional) - 0, // opacity (optional) - -360, // rotation (optional) - "", // background (optional) - ImageFormat.JPG, // output (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/get-file-view.md b/docs/examples/1.6.x/server-kotlin/java/storage/get-file-view.md deleted file mode 100644 index ad842bb6fe..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/get-file-view.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -storage.getFileView( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/get-file.md b/docs/examples/1.6.x/server-kotlin/java/storage/get-file.md deleted file mode 100644 index 84fb364f12..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/get-file.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -storage.getFile( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/list-buckets.md b/docs/examples/1.6.x/server-kotlin/java/storage/list-buckets.md deleted file mode 100644 index 6b2c1a00a6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/list-buckets.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Storage storage = new Storage(client); - -storage.listBuckets( - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/list-files.md b/docs/examples/1.6.x/server-kotlin/java/storage/list-files.md deleted file mode 100644 index 9483f07509..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/list-files.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -storage.listFiles( - "<BUCKET_ID>", // bucketId - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/update-bucket.md b/docs/examples/1.6.x/server-kotlin/java/storage/update-bucket.md deleted file mode 100644 index 4c13f3a4d0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/update-bucket.md +++ /dev/null @@ -1,32 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Storage storage = new Storage(client); - -storage.updateBucket( - "<BUCKET_ID>", // bucketId - "<NAME>", // name - listOf("read("any")"), // permissions (optional) - false, // fileSecurity (optional) - false, // enabled (optional) - 1, // maximumFileSize (optional) - listOf(), // allowedFileExtensions (optional) - .NONE, // compression (optional) - false, // encryption (optional) - false, // antivirus (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/storage/update-file.md b/docs/examples/1.6.x/server-kotlin/java/storage/update-file.md deleted file mode 100644 index 949d3bc1b9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/storage/update-file.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Storage; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Storage storage = new Storage(client); - -storage.updateFile( - "<BUCKET_ID>", // bucketId - "<FILE_ID>", // fileId - "<NAME>", // name (optional) - listOf("read("any")"), // permissions (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/create-membership.md b/docs/examples/1.6.x/server-kotlin/java/teams/create-membership.md deleted file mode 100644 index 0f804b5555..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/create-membership.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.createMembership( - "<TEAM_ID>", // teamId - listOf(), // roles - "email@example.com", // email (optional) - "<USER_ID>", // userId (optional) - "+12065550100", // phone (optional) - "https://example.com", // url (optional) - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/create.md b/docs/examples/1.6.x/server-kotlin/java/teams/create.md deleted file mode 100644 index 61d09c786d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/create.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.create( - "<TEAM_ID>", // teamId - "<NAME>", // name - listOf(), // roles (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/delete-membership.md b/docs/examples/1.6.x/server-kotlin/java/teams/delete-membership.md deleted file mode 100644 index 07fd42a509..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/delete-membership.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.deleteMembership( - "<TEAM_ID>", // teamId - "<MEMBERSHIP_ID>", // membershipId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/delete.md b/docs/examples/1.6.x/server-kotlin/java/teams/delete.md deleted file mode 100644 index d076b11c50..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/delete.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.delete( - "<TEAM_ID>", // teamId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/get-membership.md b/docs/examples/1.6.x/server-kotlin/java/teams/get-membership.md deleted file mode 100644 index 3dbea3016e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/get-membership.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.getMembership( - "<TEAM_ID>", // teamId - "<MEMBERSHIP_ID>", // membershipId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/get-prefs.md b/docs/examples/1.6.x/server-kotlin/java/teams/get-prefs.md deleted file mode 100644 index 1ff7a99565..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/get-prefs.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.getPrefs( - "<TEAM_ID>", // teamId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/get.md b/docs/examples/1.6.x/server-kotlin/java/teams/get.md deleted file mode 100644 index c06c107ac2..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/get.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.get( - "<TEAM_ID>", // teamId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/list-memberships.md b/docs/examples/1.6.x/server-kotlin/java/teams/list-memberships.md deleted file mode 100644 index a44a977e40..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/list-memberships.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.listMemberships( - "<TEAM_ID>", // teamId - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/list.md b/docs/examples/1.6.x/server-kotlin/java/teams/list.md deleted file mode 100644 index 9559fe0e03..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/list.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.list( - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/update-membership-status.md b/docs/examples/1.6.x/server-kotlin/java/teams/update-membership-status.md deleted file mode 100644 index a938842e57..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/update-membership-status.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.updateMembershipStatus( - "<TEAM_ID>", // teamId - "<MEMBERSHIP_ID>", // membershipId - "<USER_ID>", // userId - "<SECRET>", // secret - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/update-membership.md b/docs/examples/1.6.x/server-kotlin/java/teams/update-membership.md deleted file mode 100644 index e5d2c982d8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/update-membership.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.updateMembership( - "<TEAM_ID>", // teamId - "<MEMBERSHIP_ID>", // membershipId - listOf(), // roles - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/update-name.md b/docs/examples/1.6.x/server-kotlin/java/teams/update-name.md deleted file mode 100644 index 1ef086e66c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/update-name.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.updateName( - "<TEAM_ID>", // teamId - "<NAME>", // name - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/teams/update-prefs.md b/docs/examples/1.6.x/server-kotlin/java/teams/update-prefs.md deleted file mode 100644 index e6bc00d58e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/teams/update-prefs.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Teams; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession(""); // The user session to authenticate with - -Teams teams = new Teams(client); - -teams.updatePrefs( - "<TEAM_ID>", // teamId - mapOf( "a" to "b" ), // prefs - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-argon2user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-argon2user.md deleted file mode 100644 index 057b7d740c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-argon2user.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createArgon2User( - "<USER_ID>", // userId - "email@example.com", // email - "password", // password - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-bcrypt-user.md deleted file mode 100644 index e6f2de69d0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-bcrypt-user.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createBcryptUser( - "<USER_ID>", // userId - "email@example.com", // email - "password", // password - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-j-w-t.md b/docs/examples/1.6.x/server-kotlin/java/users/create-j-w-t.md deleted file mode 100644 index 376680bd31..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-j-w-t.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createJWT( - "<USER_ID>", // userId - "<SESSION_ID>", // sessionId (optional) - 0, // duration (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-m-d5user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-m-d5user.md deleted file mode 100644 index 8880553b54..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-m-d5user.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createMD5User( - "<USER_ID>", // userId - "email@example.com", // email - "password", // password - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/users/create-mfa-recovery-codes.md deleted file mode 100644 index e6b566bb2d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createMfaRecoveryCodes( - "<USER_ID>", // userId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-p-h-pass-user.md deleted file mode 100644 index d8065325ca..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-p-h-pass-user.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createPHPassUser( - "<USER_ID>", // userId - "email@example.com", // email - "password", // password - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-s-h-a-user.md deleted file mode 100644 index 3894a2b890..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-s-h-a-user.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createSHAUser( - "<USER_ID>", // userId - "email@example.com", // email - "password", // password - PasswordHash.SHA1, // passwordVersion (optional) - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-modified-user.md deleted file mode 100644 index 10a020174f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createScryptModifiedUser( - "<USER_ID>", // userId - "email@example.com", // email - "password", // password - "<PASSWORD_SALT>", // passwordSalt - "<PASSWORD_SALT_SEPARATOR>", // passwordSaltSeparator - "<PASSWORD_SIGNER_KEY>", // passwordSignerKey - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-user.md b/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-user.md deleted file mode 100644 index fb32f0d764..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-scrypt-user.md +++ /dev/null @@ -1,31 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createScryptUser( - "<USER_ID>", // userId - "email@example.com", // email - "password", // password - "<PASSWORD_SALT>", // passwordSalt - 0, // passwordCpu - 0, // passwordMemory - 0, // passwordParallel - 0, // passwordLength - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-session.md b/docs/examples/1.6.x/server-kotlin/java/users/create-session.md deleted file mode 100644 index ca60f50f06..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-session.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createSession( - "<USER_ID>", // userId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-target.md b/docs/examples/1.6.x/server-kotlin/java/users/create-target.md deleted file mode 100644 index c5cbfa0c28..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-target.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; -import io.appwrite.enums.MessagingProviderType; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createTarget( - "<USER_ID>", // userId - "<TARGET_ID>", // targetId - MessagingProviderType.EMAIL, // providerType - "<IDENTIFIER>", // identifier - "<PROVIDER_ID>", // providerId (optional) - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create-token.md b/docs/examples/1.6.x/server-kotlin/java/users/create-token.md deleted file mode 100644 index 32a0f9772e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create-token.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.createToken( - "<USER_ID>", // userId - 4, // length (optional) - 60, // expire (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/create.md b/docs/examples/1.6.x/server-kotlin/java/users/create.md deleted file mode 100644 index 6ff315c0c6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/create.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.create( - "<USER_ID>", // userId - "email@example.com", // email (optional) - "+12065550100", // phone (optional) - "", // password (optional) - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete-identity.md b/docs/examples/1.6.x/server-kotlin/java/users/delete-identity.md deleted file mode 100644 index 39462b1df0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/delete-identity.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.deleteIdentity( - "<IDENTITY_ID>", // identityId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/java/users/delete-mfa-authenticator.md deleted file mode 100644 index 5e32ef9e18..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; -import io.appwrite.enums.AuthenticatorType; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.deleteMfaAuthenticator( - "<USER_ID>", // userId - AuthenticatorType.TOTP, // type - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete-session.md b/docs/examples/1.6.x/server-kotlin/java/users/delete-session.md deleted file mode 100644 index 658d0ef879..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/delete-session.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.deleteSession( - "<USER_ID>", // userId - "<SESSION_ID>", // sessionId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete-sessions.md b/docs/examples/1.6.x/server-kotlin/java/users/delete-sessions.md deleted file mode 100644 index 3e6cfeae2a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/delete-sessions.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.deleteSessions( - "<USER_ID>", // userId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete-target.md b/docs/examples/1.6.x/server-kotlin/java/users/delete-target.md deleted file mode 100644 index 00f45b85d1..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/delete-target.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.deleteTarget( - "<USER_ID>", // userId - "<TARGET_ID>", // targetId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/delete.md b/docs/examples/1.6.x/server-kotlin/java/users/delete.md deleted file mode 100644 index 9846b8be85..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/delete.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.delete( - "<USER_ID>", // userId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/users/get-mfa-recovery-codes.md deleted file mode 100644 index 583287c623..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.getMfaRecoveryCodes( - "<USER_ID>", // userId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/get-prefs.md b/docs/examples/1.6.x/server-kotlin/java/users/get-prefs.md deleted file mode 100644 index 5bcf7aacdf..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/get-prefs.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.getPrefs( - "<USER_ID>", // userId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/get-target.md b/docs/examples/1.6.x/server-kotlin/java/users/get-target.md deleted file mode 100644 index 1b02057f84..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/get-target.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.getTarget( - "<USER_ID>", // userId - "<TARGET_ID>", // targetId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/get.md b/docs/examples/1.6.x/server-kotlin/java/users/get.md deleted file mode 100644 index c3cb953b52..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/get.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.get( - "<USER_ID>", // userId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-identities.md b/docs/examples/1.6.x/server-kotlin/java/users/list-identities.md deleted file mode 100644 index deac1c9931..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/list-identities.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.listIdentities( - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-logs.md b/docs/examples/1.6.x/server-kotlin/java/users/list-logs.md deleted file mode 100644 index d2e785dc63..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/list-logs.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.listLogs( - "<USER_ID>", // userId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-memberships.md b/docs/examples/1.6.x/server-kotlin/java/users/list-memberships.md deleted file mode 100644 index 2c11c5abcd..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/list-memberships.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.listMemberships( - "<USER_ID>", // userId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-mfa-factors.md b/docs/examples/1.6.x/server-kotlin/java/users/list-mfa-factors.md deleted file mode 100644 index 458b0a4679..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/list-mfa-factors.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.listMfaFactors( - "<USER_ID>", // userId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-sessions.md b/docs/examples/1.6.x/server-kotlin/java/users/list-sessions.md deleted file mode 100644 index d24f8ffdce..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/list-sessions.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.listSessions( - "<USER_ID>", // userId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list-targets.md b/docs/examples/1.6.x/server-kotlin/java/users/list-targets.md deleted file mode 100644 index 7e1938c015..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/list-targets.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.listTargets( - "<USER_ID>", // userId - listOf(), // queries (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/list.md b/docs/examples/1.6.x/server-kotlin/java/users/list.md deleted file mode 100644 index 6d289a657d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/list.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.list( - listOf(), // queries (optional) - "<SEARCH>", // search (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-email-verification.md b/docs/examples/1.6.x/server-kotlin/java/users/update-email-verification.md deleted file mode 100644 index 12f33a341a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-email-verification.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updateEmailVerification( - "<USER_ID>", // userId - false, // emailVerification - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-email.md b/docs/examples/1.6.x/server-kotlin/java/users/update-email.md deleted file mode 100644 index f3855d2441..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-email.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updateEmail( - "<USER_ID>", // userId - "email@example.com", // email - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-labels.md b/docs/examples/1.6.x/server-kotlin/java/users/update-labels.md deleted file mode 100644 index 26ef7152ef..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-labels.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updateLabels( - "<USER_ID>", // userId - listOf(), // labels - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/java/users/update-mfa-recovery-codes.md deleted file mode 100644 index 798626893e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updateMfaRecoveryCodes( - "<USER_ID>", // userId - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-mfa.md b/docs/examples/1.6.x/server-kotlin/java/users/update-mfa.md deleted file mode 100644 index 6cb8e60a3f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-mfa.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updateMfa( - "<USER_ID>", // userId - false, // mfa - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-name.md b/docs/examples/1.6.x/server-kotlin/java/users/update-name.md deleted file mode 100644 index cc3d905e7e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-name.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updateName( - "<USER_ID>", // userId - "<NAME>", // name - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-password.md b/docs/examples/1.6.x/server-kotlin/java/users/update-password.md deleted file mode 100644 index 3d98d9e1b9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-password.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updatePassword( - "<USER_ID>", // userId - "", // password - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-phone-verification.md b/docs/examples/1.6.x/server-kotlin/java/users/update-phone-verification.md deleted file mode 100644 index a2c5ffbdb0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-phone-verification.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updatePhoneVerification( - "<USER_ID>", // userId - false, // phoneVerification - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-phone.md b/docs/examples/1.6.x/server-kotlin/java/users/update-phone.md deleted file mode 100644 index 4f3cb65ac2..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-phone.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updatePhone( - "<USER_ID>", // userId - "+12065550100", // number - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-prefs.md b/docs/examples/1.6.x/server-kotlin/java/users/update-prefs.md deleted file mode 100644 index 25706b8e9f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-prefs.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updatePrefs( - "<USER_ID>", // userId - mapOf( "a" to "b" ), // prefs - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-status.md b/docs/examples/1.6.x/server-kotlin/java/users/update-status.md deleted file mode 100644 index 718b17509c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-status.md +++ /dev/null @@ -1,24 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updateStatus( - "<USER_ID>", // userId - false, // status - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/java/users/update-target.md b/docs/examples/1.6.x/server-kotlin/java/users/update-target.md deleted file mode 100644 index bed6d7287a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/java/users/update-target.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Users; - -Client client = new Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>"); // Your secret API key - -Users users = new Users(client); - -users.updateTarget( - "<USER_ID>", // userId - "<TARGET_ID>", // targetId - "<IDENTIFIER>", // identifier (optional) - "<PROVIDER_ID>", // providerId (optional) - "<NAME>", // name (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-anonymous-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-anonymous-session.md deleted file mode 100644 index 20e8b7b800..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-anonymous-session.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val response = account.createAnonymousSession() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-password-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-password-session.md deleted file mode 100644 index 47894a64b6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-password-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val response = account.createEmailPasswordSession( - email = "email@example.com", - password = "password" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-token.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-token.md deleted file mode 100644 index e73dff7cd4..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-email-token.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val response = account.createEmailToken( - userId = "<USER_ID>", - email = "email@example.com", - phrase = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-j-w-t.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-j-w-t.md deleted file mode 100644 index 95568ac8ba..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-j-w-t.md +++ /dev/null @@ -1,11 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val response = account.createJWT() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-magic-u-r-l-token.md deleted file mode 100644 index 5652b1ec42..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val response = account.createMagicURLToken( - userId = "<USER_ID>", - email = "email@example.com", - url = "https://example.com", // optional - phrase = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-authenticator.md deleted file mode 100644 index e2040cb470..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-authenticator.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account -import io.appwrite.enums.AuthenticatorType - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.createMfaAuthenticator( - type = AuthenticatorType.TOTP -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-challenge.md deleted file mode 100644 index 37f0badeff..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-challenge.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account -import io.appwrite.enums.AuthenticationFactor - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val response = account.createMfaChallenge( - factor = AuthenticationFactor.EMAIL -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-recovery-codes.md deleted file mode 100644 index f98ef042f9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.createMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-o-auth2token.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-o-auth2token.md deleted file mode 100644 index 5d1e78c5e7..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-o-auth2token.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account -import io.appwrite.enums.OAuthProvider - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -account.createOAuth2Token( - provider = OAuthProvider.AMAZON, - success = "https://example.com", // optional - failure = "https://example.com", // optional - scopes = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-token.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-token.md deleted file mode 100644 index 1ab4b1ae79..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val response = account.createPhoneToken( - userId = "<USER_ID>", - phone = "+12065550100" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-verification.md deleted file mode 100644 index 628700ba3d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-phone-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.createPhoneVerification() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-recovery.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-recovery.md deleted file mode 100644 index 98e1f6f9b8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-recovery.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.createRecovery( - email = "email@example.com", - url = "https://example.com" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-session.md deleted file mode 100644 index e9116c7f02..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val response = account.createSession( - userId = "<USER_ID>", - secret = "<SECRET>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create-verification.md deleted file mode 100644 index 3b0efad678..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.createVerification( - url = "https://example.com" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/create.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/create.md deleted file mode 100644 index a0abf68617..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/create.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val response = account.create( - userId = "<USER_ID>", - email = "email@example.com", - password = "", - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-identity.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-identity.md deleted file mode 100644 index 5a0ed383f8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-identity.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.deleteIdentity( - identityId = "<IDENTITY_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-mfa-authenticator.md deleted file mode 100644 index 7078efe87e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account -import io.appwrite.enums.AuthenticatorType - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.deleteMfaAuthenticator( - type = AuthenticatorType.TOTP -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-session.md deleted file mode 100644 index a56b7efd6d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.deleteSession( - sessionId = "<SESSION_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-sessions.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-sessions.md deleted file mode 100644 index 65fcebe192..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/delete-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.deleteSessions() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/get-mfa-recovery-codes.md deleted file mode 100644 index cda264861a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.getMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/get-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/get-prefs.md deleted file mode 100644 index 33d7ba2f4e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.getPrefs() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/get-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/get-session.md deleted file mode 100644 index d320018c89..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/get-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.getSession( - sessionId = "<SESSION_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/get.md deleted file mode 100644 index a1172e68f4..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.get() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-identities.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-identities.md deleted file mode 100644 index 9b002bcc7a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-identities.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.listIdentities( - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-logs.md deleted file mode 100644 index bb347565fa..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.listLogs( - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-mfa-factors.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-mfa-factors.md deleted file mode 100644 index 3824945b26..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-mfa-factors.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.listMfaFactors() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-sessions.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/list-sessions.md deleted file mode 100644 index fee2a07f18..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/list-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.listSessions() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-email.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-email.md deleted file mode 100644 index 840eb2d21e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-email.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updateEmail( - email = "email@example.com", - password = "password" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-m-f-a.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-m-f-a.md deleted file mode 100644 index 34959a529e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-m-f-a.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updateMFA( - mfa = false -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-magic-u-r-l-session.md deleted file mode 100644 index 3002bbfb2c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val response = account.updateMagicURLSession( - userId = "<USER_ID>", - secret = "<SECRET>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-authenticator.md deleted file mode 100644 index 030034ca0e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-authenticator.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account -import io.appwrite.enums.AuthenticatorType - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updateMfaAuthenticator( - type = AuthenticatorType.TOTP, - otp = "<OTP>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-challenge.md deleted file mode 100644 index 2de7dc696b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-challenge.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updateMfaChallenge( - challengeId = "<CHALLENGE_ID>", - otp = "<OTP>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-recovery-codes.md deleted file mode 100644 index cab29cdb75..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updateMfaRecoveryCodes() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-name.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-name.md deleted file mode 100644 index 31236e6d46..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-name.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updateName( - name = "<NAME>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-password.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-password.md deleted file mode 100644 index 796b550d76..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-password.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updatePassword( - password = "", - oldPassword = "password" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-session.md deleted file mode 100644 index 2d346b7cce..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -val account = Account(client) - -val response = account.updatePhoneSession( - userId = "<USER_ID>", - secret = "<SECRET>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-verification.md deleted file mode 100644 index 9b3d125d2b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updatePhoneVerification( - userId = "<USER_ID>", - secret = "<SECRET>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone.md deleted file mode 100644 index 64f83d7b1d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-phone.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updatePhone( - phone = "+12065550100", - password = "password" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-prefs.md deleted file mode 100644 index 2da90008ed..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updatePrefs( - prefs = mapOf( "a" to "b" ) -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-recovery.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-recovery.md deleted file mode 100644 index 3fb130d201..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-recovery.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updateRecovery( - userId = "<USER_ID>", - secret = "<SECRET>", - password = "" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-session.md deleted file mode 100644 index 9e6182c606..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updateSession( - sessionId = "<SESSION_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-status.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-status.md deleted file mode 100644 index 64e970453f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-status.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updateStatus() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/account/update-verification.md deleted file mode 100644 index e4a91fe720..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/account/update-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Account - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val account = Account(client) - -val response = account.updateVerification( - userId = "<USER_ID>", - secret = "<SECRET>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-browser.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-browser.md deleted file mode 100644 index f7b31a37aa..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-browser.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars -import io.appwrite.enums.Browser - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val avatars = Avatars(client) - -val result = avatars.getBrowser( - code = Browser.AVANT_BROWSER, - width = 0, // optional - height = 0, // optional - quality = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-credit-card.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-credit-card.md deleted file mode 100644 index 1bc1f5d9a4..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-credit-card.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars -import io.appwrite.enums.CreditCard - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val avatars = Avatars(client) - -val result = avatars.getCreditCard( - code = CreditCard.AMERICAN_EXPRESS, - width = 0, // optional - height = 0, // optional - quality = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-favicon.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-favicon.md deleted file mode 100644 index d11aa09ce5..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-favicon.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val avatars = Avatars(client) - -val result = avatars.getFavicon( - url = "https://example.com" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-flag.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-flag.md deleted file mode 100644 index 7d51019e18..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-flag.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars -import io.appwrite.enums.Flag - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val avatars = Avatars(client) - -val result = avatars.getFlag( - code = Flag.AFGHANISTAN, - width = 0, // optional - height = 0, // optional - quality = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-image.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-image.md deleted file mode 100644 index 758c503463..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-image.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val avatars = Avatars(client) - -val result = avatars.getImage( - url = "https://example.com", - width = 0, // optional - height = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-initials.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-initials.md deleted file mode 100644 index 92e9d36379..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-initials.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val avatars = Avatars(client) - -val result = avatars.getInitials( - name = "<NAME>", // optional - width = 0, // optional - height = 0, // optional - background = "" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-q-r.md b/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-q-r.md deleted file mode 100644 index 66e77c52ea..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/avatars/get-q-r.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Avatars - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val avatars = Avatars(client) - -val result = avatars.getQR( - text = "<TEXT>", - size = 1, // optional - margin = 0, // optional - download = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-boolean-attribute.md deleted file mode 100644 index e208d01cc7..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-boolean-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createBooleanAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - default = false, // optional - array = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-collection.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-collection.md deleted file mode 100644 index c1bb200028..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-collection.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createCollection( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - name = "<NAME>", - permissions = listOf("read("any")"), // optional - documentSecurity = false, // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-datetime-attribute.md deleted file mode 100644 index 25433c99aa..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-datetime-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createDatetimeAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - default = "", // optional - array = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-document.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-document.md deleted file mode 100644 index 6ce280699b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-document.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val databases = Databases(client) - -val response = databases.createDocument( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - documentId = "<DOCUMENT_ID>", - data = mapOf( "a" to "b" ), - permissions = listOf("read("any")") // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-email-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-email-attribute.md deleted file mode 100644 index b3321597fd..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-email-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createEmailAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - default = "email@example.com", // optional - array = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-enum-attribute.md deleted file mode 100644 index 24f5ca0d8d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-enum-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createEnumAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - elements = listOf(), - required = false, - default = "<DEFAULT>", // optional - array = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-float-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-float-attribute.md deleted file mode 100644 index 271aeb411f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-float-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createFloatAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - min = 0, // optional - max = 0, // optional - default = 0, // optional - array = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-index.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-index.md deleted file mode 100644 index aac7a23cde..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-index.md +++ /dev/null @@ -1,20 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases -import io.appwrite.enums.IndexType - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createIndex( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - type = IndexType.KEY, - attributes = listOf(), - orders = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-integer-attribute.md deleted file mode 100644 index c01bf14b18..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-integer-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createIntegerAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - min = 0, // optional - max = 0, // optional - default = 0, // optional - array = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-ip-attribute.md deleted file mode 100644 index 823b008ba9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-ip-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createIpAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - default = "", // optional - array = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-relationship-attribute.md deleted file mode 100644 index 0b15a4869e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-relationship-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases -import io.appwrite.enums.RelationshipType - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createRelationshipAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - relatedCollectionId = "<RELATED_COLLECTION_ID>", - type = RelationshipType.ONETOONE, - twoWay = false, // optional - key = "", // optional - twoWayKey = "", // optional - onDelete = "cascade" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-string-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-string-attribute.md deleted file mode 100644 index f532c2fcd7..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-string-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createStringAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - size = 1, - required = false, - default = "<DEFAULT>", // optional - array = false, // optional - encrypt = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-url-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-url-attribute.md deleted file mode 100644 index 995a609c2a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create-url-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.createUrlAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - default = "https://example.com", // optional - array = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/create.md deleted file mode 100644 index b4f4ac2cd1..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/create.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.create( - databaseId = "<DATABASE_ID>", - name = "<NAME>", - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-attribute.md deleted file mode 100644 index c47d9529d8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.deleteAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-collection.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-collection.md deleted file mode 100644 index d60857128c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-collection.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.deleteCollection( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-document.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-document.md deleted file mode 100644 index 309a268cc6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val databases = Databases(client) - -val response = databases.deleteDocument( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - documentId = "<DOCUMENT_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-index.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-index.md deleted file mode 100644 index 0ac1f63642..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete-index.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.deleteIndex( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete.md deleted file mode 100644 index 8219ac4148..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.delete( - databaseId = "<DATABASE_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-attribute.md deleted file mode 100644 index 3f4d9e8afa..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.getAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-collection.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-collection.md deleted file mode 100644 index 52ccd5e775..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-collection.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.getCollection( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-document.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-document.md deleted file mode 100644 index 3e116f6524..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-document.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val databases = Databases(client) - -val response = databases.getDocument( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - documentId = "<DOCUMENT_ID>", - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-index.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-index.md deleted file mode 100644 index dfde04d064..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get-index.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.getIndex( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/get.md deleted file mode 100644 index f7b465048c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/get.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.get( - databaseId = "<DATABASE_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-attributes.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-attributes.md deleted file mode 100644 index d33f24ac76..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-attributes.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.listAttributes( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-collections.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-collections.md deleted file mode 100644 index e09e8b3905..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-collections.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.listCollections( - databaseId = "<DATABASE_ID>", - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-documents.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-documents.md deleted file mode 100644 index a3e351d363..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-documents.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val databases = Databases(client) - -val response = databases.listDocuments( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-indexes.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-indexes.md deleted file mode 100644 index a4c0c3c02f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list-indexes.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.listIndexes( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/list.md deleted file mode 100644 index 0013f869db..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/list.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.list( - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-boolean-attribute.md deleted file mode 100644 index 2152df5163..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-boolean-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateBooleanAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - default = false -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-collection.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-collection.md deleted file mode 100644 index 99d1d3a07a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-collection.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateCollection( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - name = "<NAME>", - permissions = listOf("read("any")"), // optional - documentSecurity = false, // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-datetime-attribute.md deleted file mode 100644 index 2aeab56dc5..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-datetime-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateDatetimeAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - default = "" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-document.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-document.md deleted file mode 100644 index a55502ec3b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-document.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val databases = Databases(client) - -val response = databases.updateDocument( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - documentId = "<DOCUMENT_ID>", - data = mapOf( "a" to "b" ), // optional - permissions = listOf("read("any")") // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-email-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-email-attribute.md deleted file mode 100644 index a6439eb8b6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-email-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateEmailAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - default = "email@example.com" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-enum-attribute.md deleted file mode 100644 index 63375bf256..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-enum-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateEnumAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - elements = listOf(), - required = false, - default = "<DEFAULT>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-float-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-float-attribute.md deleted file mode 100644 index 10011cb740..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-float-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateFloatAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - min = 0, - max = 0, - default = 0 -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-integer-attribute.md deleted file mode 100644 index 2c1388d986..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-integer-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateIntegerAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - min = 0, - max = 0, - default = 0 -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-ip-attribute.md deleted file mode 100644 index 07fda267b6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-ip-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateIpAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - default = "" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-relationship-attribute.md deleted file mode 100644 index ee83dca539..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-relationship-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateRelationshipAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - onDelete = "cascade" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-string-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-string-attribute.md deleted file mode 100644 index e5c54e9a73..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-string-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateStringAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - default = "<DEFAULT>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-url-attribute.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-url-attribute.md deleted file mode 100644 index 3b4c538579..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update-url-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateUrlAttribute( - databaseId = "<DATABASE_ID>", - collectionId = "<COLLECTION_ID>", - key = "", - required = false, - default = "https://example.com" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update.md b/docs/examples/1.6.x/server-kotlin/kotlin/databases/update.md deleted file mode 100644 index 608c71fbb9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/databases/update.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val databases = Databases(client) - -val response = databases.update( - databaseId = "<DATABASE_ID>", - name = "<NAME>", - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-build.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-build.md deleted file mode 100644 index 4d6c1ced1c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-build.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.createBuild( - functionId = "<FUNCTION_ID>", - deploymentId = "<DEPLOYMENT_ID>", - buildId = "<BUILD_ID>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-deployment.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-deployment.md deleted file mode 100644 index 3999f99f98..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-deployment.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.models.InputFile -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.createDeployment( - functionId = "<FUNCTION_ID>", - code = InputFile.fromPath("file.png"), - activate = false, - entrypoint = "<ENTRYPOINT>", // optional - commands = "<COMMANDS>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-execution.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-execution.md deleted file mode 100644 index 43bc5eb96e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-execution.md +++ /dev/null @@ -1,20 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val functions = Functions(client) - -val response = functions.createExecution( - functionId = "<FUNCTION_ID>", - body = "<BODY>", // optional - async = false, // optional - path = "<PATH>", // optional - method = "GET", // optional - headers = mapOf( "a" to "b" ), // optional - scheduledAt = "" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-variable.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-variable.md deleted file mode 100644 index 3748a98dcc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create-variable.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.createVariable( - functionId = "<FUNCTION_ID>", - key = "<KEY>", - value = "<VALUE>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/create.md deleted file mode 100644 index b771633e55..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/create.md +++ /dev/null @@ -1,35 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions -import io.appwrite.enums.Runtime - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.create( - functionId = "<FUNCTION_ID>", - name = "<NAME>", - runtime = .NODE_14_5, - execute = listOf("any"), // optional - events = listOf(), // optional - schedule = "", // optional - timeout = 1, // optional - enabled = false, // optional - logging = false, // optional - entrypoint = "<ENTRYPOINT>", // optional - commands = "<COMMANDS>", // optional - scopes = listOf(), // optional - installationId = "<INSTALLATION_ID>", // optional - providerRepositoryId = "<PROVIDER_REPOSITORY_ID>", // optional - providerBranch = "<PROVIDER_BRANCH>", // optional - providerSilentMode = false, // optional - providerRootDirectory = "<PROVIDER_ROOT_DIRECTORY>", // optional - templateRepository = "<TEMPLATE_REPOSITORY>", // optional - templateOwner = "<TEMPLATE_OWNER>", // optional - templateRootDirectory = "<TEMPLATE_ROOT_DIRECTORY>", // optional - templateBranch = "<TEMPLATE_BRANCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-deployment.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-deployment.md deleted file mode 100644 index 6c68a27d3c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.deleteDeployment( - functionId = "<FUNCTION_ID>", - deploymentId = "<DEPLOYMENT_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-execution.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-execution.md deleted file mode 100644 index 182438ae89..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-execution.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.deleteExecution( - functionId = "<FUNCTION_ID>", - executionId = "<EXECUTION_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-variable.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-variable.md deleted file mode 100644 index e87652f774..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.deleteVariable( - functionId = "<FUNCTION_ID>", - variableId = "<VARIABLE_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete.md deleted file mode 100644 index 45f442b29b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.delete( - functionId = "<FUNCTION_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/download-deployment.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/download-deployment.md deleted file mode 100644 index 29f6a198ee..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/download-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val result = functions.downloadDeployment( - functionId = "<FUNCTION_ID>", - deploymentId = "<DEPLOYMENT_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-deployment.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-deployment.md deleted file mode 100644 index 81eb317e8f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.getDeployment( - functionId = "<FUNCTION_ID>", - deploymentId = "<DEPLOYMENT_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-execution.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-execution.md deleted file mode 100644 index f498daf4cc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-execution.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val functions = Functions(client) - -val response = functions.getExecution( - functionId = "<FUNCTION_ID>", - executionId = "<EXECUTION_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-variable.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-variable.md deleted file mode 100644 index 73f2c3a2fa..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.getVariable( - functionId = "<FUNCTION_ID>", - variableId = "<VARIABLE_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/get.md deleted file mode 100644 index 899a6c1bfc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/get.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.get( - functionId = "<FUNCTION_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-deployments.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-deployments.md deleted file mode 100644 index 48dc03e427..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-deployments.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.listDeployments( - functionId = "<FUNCTION_ID>", - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-executions.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-executions.md deleted file mode 100644 index 625a048d7f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-executions.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val functions = Functions(client) - -val response = functions.listExecutions( - functionId = "<FUNCTION_ID>", - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-runtimes.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-runtimes.md deleted file mode 100644 index 0f0d2962e3..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-runtimes.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.listRuntimes() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-variables.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-variables.md deleted file mode 100644 index e6b1742652..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list-variables.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.listVariables( - functionId = "<FUNCTION_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/list.md deleted file mode 100644 index df9cb7e00e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/list.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.list( - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment-build.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment-build.md deleted file mode 100644 index 8abb613992..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment-build.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.updateDeploymentBuild( - functionId = "<FUNCTION_ID>", - deploymentId = "<DEPLOYMENT_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment.md deleted file mode 100644 index d86934d440..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.updateDeployment( - functionId = "<FUNCTION_ID>", - deploymentId = "<DEPLOYMENT_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-variable.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-variable.md deleted file mode 100644 index 6890928a38..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update-variable.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.updateVariable( - functionId = "<FUNCTION_ID>", - variableId = "<VARIABLE_ID>", - key = "<KEY>", - value = "<VALUE>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update.md b/docs/examples/1.6.x/server-kotlin/kotlin/functions/update.md deleted file mode 100644 index 616f17259c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/functions/update.md +++ /dev/null @@ -1,30 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Functions - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val functions = Functions(client) - -val response = functions.update( - functionId = "<FUNCTION_ID>", - name = "<NAME>", - runtime = "node-14.5", // optional - execute = listOf("any"), // optional - events = listOf(), // optional - schedule = "", // optional - timeout = 1, // optional - enabled = false, // optional - logging = false, // optional - entrypoint = "<ENTRYPOINT>", // optional - commands = "<COMMANDS>", // optional - scopes = listOf(), // optional - installationId = "<INSTALLATION_ID>", // optional - providerRepositoryId = "<PROVIDER_REPOSITORY_ID>", // optional - providerBranch = "<PROVIDER_BRANCH>", // optional - providerSilentMode = false, // optional - providerRootDirectory = "<PROVIDER_ROOT_DIRECTORY>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/graphql/mutation.md b/docs/examples/1.6.x/server-kotlin/kotlin/graphql/mutation.md deleted file mode 100644 index fa0f9e3c0f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/graphql/mutation.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Graphql - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val graphql = Graphql(client) - -val response = graphql.mutation( - query = mapOf( "a" to "b" ) -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/graphql/query.md b/docs/examples/1.6.x/server-kotlin/kotlin/graphql/query.md deleted file mode 100644 index e6786fa116..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/graphql/query.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Graphql - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val graphql = Graphql(client) - -val response = graphql.query( - query = mapOf( "a" to "b" ) -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-antivirus.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-antivirus.md deleted file mode 100644 index 3f3773aa48..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-antivirus.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getAntivirus() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-cache.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-cache.md deleted file mode 100644 index 5c1fbe0389..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-cache.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getCache() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-certificate.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-certificate.md deleted file mode 100644 index 5324bcb0fa..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-certificate.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getCertificate( - domain = "" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-d-b.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-d-b.md deleted file mode 100644 index 0eeeb078c8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-d-b.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getDB() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-failed-jobs.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-failed-jobs.md deleted file mode 100644 index 397fbe668d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-failed-jobs.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health -import io.appwrite.enums.Name - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getFailedJobs( - name = .V1_DATABASE, - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-pub-sub.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-pub-sub.md deleted file mode 100644 index ae4bc40552..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-pub-sub.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getPubSub() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-builds.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-builds.md deleted file mode 100644 index 0014a7b561..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-builds.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueBuilds( - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-certificates.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-certificates.md deleted file mode 100644 index f69b1f956d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-certificates.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueCertificates( - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-databases.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-databases.md deleted file mode 100644 index 7871ba3a06..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-databases.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueDatabases( - name = "<NAME>", // optional - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-deletes.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-deletes.md deleted file mode 100644 index 280b7b8c3f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-deletes.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueDeletes( - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-functions.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-functions.md deleted file mode 100644 index 3cdfbd56d2..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-functions.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueFunctions( - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-logs.md deleted file mode 100644 index 2625fea201..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueLogs( - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-mails.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-mails.md deleted file mode 100644 index 9686737394..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-mails.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueMails( - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-messaging.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-messaging.md deleted file mode 100644 index 57ade69c00..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-messaging.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueMessaging( - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-migrations.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-migrations.md deleted file mode 100644 index 1aa093f84c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-migrations.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueMigrations( - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage-dump.md deleted file mode 100644 index a91d7100ca..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage-dump.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueUsageDump( - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage.md deleted file mode 100644 index 1ca045f352..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-usage.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueUsage( - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-webhooks.md deleted file mode 100644 index 078eb86fa9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue-webhooks.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueueWebhooks( - threshold = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue.md deleted file mode 100644 index 6832b3aabd..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-queue.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getQueue() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage-local.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage-local.md deleted file mode 100644 index 10e00e5424..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage-local.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getStorageLocal() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage.md deleted file mode 100644 index 3e4aa8cc43..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-storage.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getStorage() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-time.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get-time.md deleted file mode 100644 index 88bca6f873..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get-time.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.getTime() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/health/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/health/get.md deleted file mode 100644 index cb0f776d08..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/health/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Health - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val health = Health(client) - -val response = health.get() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/get.md deleted file mode 100644 index c514a06c53..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/locale/get.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val locale = Locale(client) - -val response = locale.get() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-codes.md deleted file mode 100644 index b4baa8d6e6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val locale = Locale(client) - -val response = locale.listCodes() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-continents.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-continents.md deleted file mode 100644 index e77f129770..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-continents.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val locale = Locale(client) - -val response = locale.listContinents() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-e-u.md deleted file mode 100644 index 71cd28e92b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-e-u.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val locale = Locale(client) - -val response = locale.listCountriesEU() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-phones.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-phones.md deleted file mode 100644 index b0222161ed..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries-phones.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val locale = Locale(client) - -val response = locale.listCountriesPhones() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries.md deleted file mode 100644 index 44c8ecaa4d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-countries.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val locale = Locale(client) - -val response = locale.listCountries() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-currencies.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-currencies.md deleted file mode 100644 index be9fc87888..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-currencies.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val locale = Locale(client) - -val response = locale.listCurrencies() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-languages.md b/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-languages.md deleted file mode 100644 index cfaa22afc0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/locale/list-languages.md +++ /dev/null @@ -1,12 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Locale - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val locale = Locale(client) - -val response = locale.listLanguages() diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-apns-provider.md deleted file mode 100644 index e4812bf421..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-apns-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createApnsProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", - authKey = "<AUTH_KEY>", // optional - authKeyId = "<AUTH_KEY_ID>", // optional - teamId = "<TEAM_ID>", // optional - bundleId = "<BUNDLE_ID>", // optional - sandbox = false, // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-email.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-email.md deleted file mode 100644 index bdac6c268a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-email.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createEmail( - messageId = "<MESSAGE_ID>", - subject = "<SUBJECT>", - content = "<CONTENT>", - topics = listOf(), // optional - users = listOf(), // optional - targets = listOf(), // optional - cc = listOf(), // optional - bcc = listOf(), // optional - attachments = listOf(), // optional - draft = false, // optional - html = false, // optional - scheduledAt = "" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-fcm-provider.md deleted file mode 100644 index a4fbeef049..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-fcm-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createFcmProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", - serviceAccountJSON = mapOf( "a" to "b" ), // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-mailgun-provider.md deleted file mode 100644 index 12aefde8ab..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createMailgunProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", - apiKey = "<API_KEY>", // optional - domain = "<DOMAIN>", // optional - isEuRegion = false, // optional - fromName = "<FROM_NAME>", // optional - fromEmail = "email@example.com", // optional - replyToName = "<REPLY_TO_NAME>", // optional - replyToEmail = "email@example.com", // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-msg91provider.md deleted file mode 100644 index e07f8473e5..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-msg91provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createMsg91Provider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", - templateId = "<TEMPLATE_ID>", // optional - senderId = "<SENDER_ID>", // optional - authKey = "<AUTH_KEY>", // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-push.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-push.md deleted file mode 100644 index ba5ef3ed7d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-push.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createPush( - messageId = "<MESSAGE_ID>", - title = "<TITLE>", - body = "<BODY>", - topics = listOf(), // optional - users = listOf(), // optional - targets = listOf(), // optional - data = mapOf( "a" to "b" ), // optional - action = "<ACTION>", // optional - image = "[ID1:ID2]", // optional - icon = "<ICON>", // optional - sound = "<SOUND>", // optional - color = "<COLOR>", // optional - tag = "<TAG>", // optional - badge = "<BADGE>", // optional - draft = false, // optional - scheduledAt = "" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sendgrid-provider.md deleted file mode 100644 index 984d9370c6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createSendgridProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", - apiKey = "<API_KEY>", // optional - fromName = "<FROM_NAME>", // optional - fromEmail = "email@example.com", // optional - replyToName = "<REPLY_TO_NAME>", // optional - replyToEmail = "email@example.com", // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sms.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sms.md deleted file mode 100644 index 7a6c14e554..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-sms.md +++ /dev/null @@ -1,20 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createSms( - messageId = "<MESSAGE_ID>", - content = "<CONTENT>", - topics = listOf(), // optional - users = listOf(), // optional - targets = listOf(), // optional - draft = false, // optional - scheduledAt = "" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-smtp-provider.md deleted file mode 100644 index abcdc67f5e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-smtp-provider.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createSmtpProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", - host = "<HOST>", - port = 1, // optional - username = "<USERNAME>", // optional - password = "<PASSWORD>", // optional - encryption = "none", // optional - autoTLS = false, // optional - mailer = "<MAILER>", // optional - fromName = "<FROM_NAME>", // optional - fromEmail = "email@example.com", // optional - replyToName = "<REPLY_TO_NAME>", // optional - replyToEmail = "email@example.com", // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-subscriber.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-subscriber.md deleted file mode 100644 index 81eca3168f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-subscriber.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setJWT("<YOUR_JWT>") // Your secret JSON Web Token - -val messaging = Messaging(client) - -val response = messaging.createSubscriber( - topicId = "<TOPIC_ID>", - subscriberId = "<SUBSCRIBER_ID>", - targetId = "<TARGET_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-telesign-provider.md deleted file mode 100644 index 017e502472..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-telesign-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createTelesignProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", - from = "+12065550100", // optional - customerId = "<CUSTOMER_ID>", // optional - apiKey = "<API_KEY>", // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-textmagic-provider.md deleted file mode 100644 index 4a2fe9a6c6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createTextmagicProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", - from = "+12065550100", // optional - username = "<USERNAME>", // optional - apiKey = "<API_KEY>", // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-topic.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-topic.md deleted file mode 100644 index 7ef9a4cb88..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-topic.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createTopic( - topicId = "<TOPIC_ID>", - name = "<NAME>", - subscribe = listOf("any") // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-twilio-provider.md deleted file mode 100644 index aa4b542d2c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-twilio-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createTwilioProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", - from = "+12065550100", // optional - accountSid = "<ACCOUNT_SID>", // optional - authToken = "<AUTH_TOKEN>", // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-vonage-provider.md deleted file mode 100644 index 00f995f0ba..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/create-vonage-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.createVonageProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", - from = "+12065550100", // optional - apiKey = "<API_KEY>", // optional - apiSecret = "<API_SECRET>", // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-provider.md deleted file mode 100644 index e46388d75b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-provider.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.deleteProvider( - providerId = "<PROVIDER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-subscriber.md deleted file mode 100644 index c9348cc8c0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-subscriber.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setJWT("<YOUR_JWT>") // Your secret JSON Web Token - -val messaging = Messaging(client) - -val response = messaging.deleteSubscriber( - topicId = "<TOPIC_ID>", - subscriberId = "<SUBSCRIBER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-topic.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-topic.md deleted file mode 100644 index 723e412c76..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.deleteTopic( - topicId = "<TOPIC_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete.md deleted file mode 100644 index 9bb8dfeca8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.delete( - messageId = "<MESSAGE_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-message.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-message.md deleted file mode 100644 index a283c833a9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-message.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.getMessage( - messageId = "<MESSAGE_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-provider.md deleted file mode 100644 index d921b1620d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-provider.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.getProvider( - providerId = "<PROVIDER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-subscriber.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-subscriber.md deleted file mode 100644 index 083a5368db..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-subscriber.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.getSubscriber( - topicId = "<TOPIC_ID>", - subscriberId = "<SUBSCRIBER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-topic.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-topic.md deleted file mode 100644 index 00da358a75..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/get-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.getTopic( - topicId = "<TOPIC_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-message-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-message-logs.md deleted file mode 100644 index 5205806667..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-message-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.listMessageLogs( - messageId = "<MESSAGE_ID>", - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-messages.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-messages.md deleted file mode 100644 index e73613dcdd..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-messages.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.listMessages( - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-provider-logs.md deleted file mode 100644 index 784c7cef1b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-provider-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.listProviderLogs( - providerId = "<PROVIDER_ID>", - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-providers.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-providers.md deleted file mode 100644 index 52f166a60c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-providers.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.listProviders( - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscriber-logs.md deleted file mode 100644 index 3a70e6c285..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.listSubscriberLogs( - subscriberId = "<SUBSCRIBER_ID>", - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscribers.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscribers.md deleted file mode 100644 index 6a123a9a53..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-subscribers.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.listSubscribers( - topicId = "<TOPIC_ID>", - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-targets.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-targets.md deleted file mode 100644 index 400e492ecc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-targets.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.listTargets( - messageId = "<MESSAGE_ID>", - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topic-logs.md deleted file mode 100644 index 07caf1e936..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topic-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.listTopicLogs( - topicId = "<TOPIC_ID>", - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topics.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topics.md deleted file mode 100644 index ce5b113b4e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/list-topics.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.listTopics( - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-apns-provider.md deleted file mode 100644 index fada594ec8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-apns-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateApnsProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", // optional - enabled = false, // optional - authKey = "<AUTH_KEY>", // optional - authKeyId = "<AUTH_KEY_ID>", // optional - teamId = "<TEAM_ID>", // optional - bundleId = "<BUNDLE_ID>", // optional - sandbox = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-email.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-email.md deleted file mode 100644 index c4e18d1862..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-email.md +++ /dev/null @@ -1,25 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateEmail( - messageId = "<MESSAGE_ID>", - topics = listOf(), // optional - users = listOf(), // optional - targets = listOf(), // optional - subject = "<SUBJECT>", // optional - content = "<CONTENT>", // optional - draft = false, // optional - html = false, // optional - cc = listOf(), // optional - bcc = listOf(), // optional - scheduledAt = "", // optional - attachments = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-fcm-provider.md deleted file mode 100644 index 6f3658a9d9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-fcm-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateFcmProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", // optional - enabled = false, // optional - serviceAccountJSON = mapOf( "a" to "b" ) // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-mailgun-provider.md deleted file mode 100644 index 82796ca5fc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateMailgunProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", // optional - apiKey = "<API_KEY>", // optional - domain = "<DOMAIN>", // optional - isEuRegion = false, // optional - enabled = false, // optional - fromName = "<FROM_NAME>", // optional - fromEmail = "email@example.com", // optional - replyToName = "<REPLY_TO_NAME>", // optional - replyToEmail = "<REPLY_TO_EMAIL>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-msg91provider.md deleted file mode 100644 index ee8255e6f6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-msg91provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateMsg91Provider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", // optional - enabled = false, // optional - templateId = "<TEMPLATE_ID>", // optional - senderId = "<SENDER_ID>", // optional - authKey = "<AUTH_KEY>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-push.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-push.md deleted file mode 100644 index 80e337a1ec..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-push.md +++ /dev/null @@ -1,29 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updatePush( - messageId = "<MESSAGE_ID>", - topics = listOf(), // optional - users = listOf(), // optional - targets = listOf(), // optional - title = "<TITLE>", // optional - body = "<BODY>", // optional - data = mapOf( "a" to "b" ), // optional - action = "<ACTION>", // optional - image = "[ID1:ID2]", // optional - icon = "<ICON>", // optional - sound = "<SOUND>", // optional - color = "<COLOR>", // optional - tag = "<TAG>", // optional - badge = 0, // optional - draft = false, // optional - scheduledAt = "" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sendgrid-provider.md deleted file mode 100644 index 29f7ad35e8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateSendgridProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", // optional - enabled = false, // optional - apiKey = "<API_KEY>", // optional - fromName = "<FROM_NAME>", // optional - fromEmail = "email@example.com", // optional - replyToName = "<REPLY_TO_NAME>", // optional - replyToEmail = "<REPLY_TO_EMAIL>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sms.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sms.md deleted file mode 100644 index 4b38ced83e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-sms.md +++ /dev/null @@ -1,20 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateSms( - messageId = "<MESSAGE_ID>", - topics = listOf(), // optional - users = listOf(), // optional - targets = listOf(), // optional - content = "<CONTENT>", // optional - draft = false, // optional - scheduledAt = "" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-smtp-provider.md deleted file mode 100644 index fb51b71018..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-smtp-provider.md +++ /dev/null @@ -1,27 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateSmtpProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", // optional - host = "<HOST>", // optional - port = 1, // optional - username = "<USERNAME>", // optional - password = "<PASSWORD>", // optional - encryption = "none", // optional - autoTLS = false, // optional - mailer = "<MAILER>", // optional - fromName = "<FROM_NAME>", // optional - fromEmail = "email@example.com", // optional - replyToName = "<REPLY_TO_NAME>", // optional - replyToEmail = "<REPLY_TO_EMAIL>", // optional - enabled = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-telesign-provider.md deleted file mode 100644 index 6fa9399ff8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-telesign-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateTelesignProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", // optional - enabled = false, // optional - customerId = "<CUSTOMER_ID>", // optional - apiKey = "<API_KEY>", // optional - from = "<FROM>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-textmagic-provider.md deleted file mode 100644 index a94c566bc7..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateTextmagicProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", // optional - enabled = false, // optional - username = "<USERNAME>", // optional - apiKey = "<API_KEY>", // optional - from = "<FROM>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-topic.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-topic.md deleted file mode 100644 index 36b294a153..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-topic.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateTopic( - topicId = "<TOPIC_ID>", - name = "<NAME>", // optional - subscribe = listOf("any") // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-twilio-provider.md deleted file mode 100644 index c02d364219..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-twilio-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateTwilioProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", // optional - enabled = false, // optional - accountSid = "<ACCOUNT_SID>", // optional - authToken = "<AUTH_TOKEN>", // optional - from = "<FROM>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-vonage-provider.md deleted file mode 100644 index 7ef04e7eb6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/messaging/update-vonage-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Messaging - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val messaging = Messaging(client) - -val response = messaging.updateVonageProvider( - providerId = "<PROVIDER_ID>", - name = "<NAME>", // optional - enabled = false, // optional - apiKey = "<API_KEY>", // optional - apiSecret = "<API_SECRET>", // optional - from = "<FROM>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-bucket.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-bucket.md deleted file mode 100644 index f2a58c80c5..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-bucket.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val storage = Storage(client) - -val response = storage.createBucket( - bucketId = "<BUCKET_ID>", - name = "<NAME>", - permissions = listOf("read("any")"), // optional - fileSecurity = false, // optional - enabled = false, // optional - maximumFileSize = 1, // optional - allowedFileExtensions = listOf(), // optional - compression = "none", // optional - encryption = false, // optional - antivirus = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-file.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-file.md deleted file mode 100644 index 4a9aceaa51..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/create-file.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.models.InputFile -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val storage = Storage(client) - -val response = storage.createFile( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>", - file = InputFile.fromPath("file.png"), - permissions = listOf("read("any")") // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-bucket.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-bucket.md deleted file mode 100644 index 0476b65067..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-bucket.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val storage = Storage(client) - -val response = storage.deleteBucket( - bucketId = "<BUCKET_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-file.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-file.md deleted file mode 100644 index 0ee4bd9e83..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/delete-file.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val storage = Storage(client) - -val response = storage.deleteFile( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-bucket.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-bucket.md deleted file mode 100644 index 048a5b8da4..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-bucket.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val storage = Storage(client) - -val response = storage.getBucket( - bucketId = "<BUCKET_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-download.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-download.md deleted file mode 100644 index 2ad38a15e5..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-download.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val storage = Storage(client) - -val result = storage.getFileDownload( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-preview.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-preview.md deleted file mode 100644 index 3a72c6e392..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-preview.md +++ /dev/null @@ -1,26 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val storage = Storage(client) - -val result = storage.getFilePreview( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>", - width = 0, // optional - height = 0, // optional - gravity = "center", // optional - quality = 0, // optional - borderWidth = 0, // optional - borderColor = "", // optional - borderRadius = 0, // optional - opacity = 0, // optional - rotation = -360, // optional - background = "", // optional - output = "jpg" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-view.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-view.md deleted file mode 100644 index f5ff5f72df..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file-view.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val storage = Storage(client) - -val result = storage.getFileView( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file.md deleted file mode 100644 index f2df8caf46..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/get-file.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val storage = Storage(client) - -val response = storage.getFile( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-buckets.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-buckets.md deleted file mode 100644 index 2d2b6ffdd6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-buckets.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val storage = Storage(client) - -val response = storage.listBuckets( - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-files.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-files.md deleted file mode 100644 index 125d057df0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/list-files.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val storage = Storage(client) - -val response = storage.listFiles( - bucketId = "<BUCKET_ID>", - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-bucket.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-bucket.md deleted file mode 100644 index fcdbb45ba3..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-bucket.md +++ /dev/null @@ -1,23 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val storage = Storage(client) - -val response = storage.updateBucket( - bucketId = "<BUCKET_ID>", - name = "<NAME>", - permissions = listOf("read("any")"), // optional - fileSecurity = false, // optional - enabled = false, // optional - maximumFileSize = 1, // optional - allowedFileExtensions = listOf(), // optional - compression = "none", // optional - encryption = false, // optional - antivirus = false // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-file.md b/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-file.md deleted file mode 100644 index 1bb8ea0578..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/storage/update-file.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Storage - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val storage = Storage(client) - -val response = storage.updateFile( - bucketId = "<BUCKET_ID>", - fileId = "<FILE_ID>", - name = "<NAME>", // optional - permissions = listOf("read("any")") // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/create-membership.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/create-membership.md deleted file mode 100644 index f91082bdca..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/create-membership.md +++ /dev/null @@ -1,20 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.createMembership( - teamId = "<TEAM_ID>", - roles = listOf(), - email = "email@example.com", // optional - userId = "<USER_ID>", // optional - phone = "+12065550100", // optional - url = "https://example.com", // optional - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/create.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/create.md deleted file mode 100644 index 8ecf098856..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/create.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.create( - teamId = "<TEAM_ID>", - name = "<NAME>", - roles = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete-membership.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete-membership.md deleted file mode 100644 index 02de6860b9..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete-membership.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.deleteMembership( - teamId = "<TEAM_ID>", - membershipId = "<MEMBERSHIP_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete.md deleted file mode 100644 index be0c611ac4..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.delete( - teamId = "<TEAM_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-membership.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-membership.md deleted file mode 100644 index 604dfc7f66..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-membership.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.getMembership( - teamId = "<TEAM_ID>", - membershipId = "<MEMBERSHIP_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-prefs.md deleted file mode 100644 index 67b0d4bb75..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/get-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.getPrefs( - teamId = "<TEAM_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/get.md deleted file mode 100644 index e2f86b784a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/get.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.get( - teamId = "<TEAM_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/list-memberships.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/list-memberships.md deleted file mode 100644 index d647b8046d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/list-memberships.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.listMemberships( - teamId = "<TEAM_ID>", - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/list.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/list.md deleted file mode 100644 index c71199b82c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/list.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.list( - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership-status.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership-status.md deleted file mode 100644 index 26a2a9029e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership-status.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.updateMembershipStatus( - teamId = "<TEAM_ID>", - membershipId = "<MEMBERSHIP_ID>", - userId = "<USER_ID>", - secret = "<SECRET>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership.md deleted file mode 100644 index bfdbafccbc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-membership.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.updateMembership( - teamId = "<TEAM_ID>", - membershipId = "<MEMBERSHIP_ID>", - roles = listOf() -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-name.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-name.md deleted file mode 100644 index a3b64bf4f3..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-name.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.updateName( - teamId = "<TEAM_ID>", - name = "<NAME>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-prefs.md deleted file mode 100644 index bc8358a86e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/teams/update-prefs.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Teams - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -val teams = Teams(client) - -val response = teams.updatePrefs( - teamId = "<TEAM_ID>", - prefs = mapOf( "a" to "b" ) -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-argon2user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-argon2user.md deleted file mode 100644 index fe396f3d40..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-argon2user.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createArgon2User( - userId = "<USER_ID>", - email = "email@example.com", - password = "password", - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-bcrypt-user.md deleted file mode 100644 index 97cb9fbb35..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-bcrypt-user.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createBcryptUser( - userId = "<USER_ID>", - email = "email@example.com", - password = "password", - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-j-w-t.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-j-w-t.md deleted file mode 100644 index 7a4a285449..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-j-w-t.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createJWT( - userId = "<USER_ID>", - sessionId = "<SESSION_ID>", // optional - duration = 0 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-m-d5user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-m-d5user.md deleted file mode 100644 index 9e841fe30a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-m-d5user.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createMD5User( - userId = "<USER_ID>", - email = "email@example.com", - password = "password", - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-mfa-recovery-codes.md deleted file mode 100644 index 6c40473842..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createMfaRecoveryCodes( - userId = "<USER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-p-h-pass-user.md deleted file mode 100644 index d750bbe613..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-p-h-pass-user.md +++ /dev/null @@ -1,17 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createPHPassUser( - userId = "<USER_ID>", - email = "email@example.com", - password = "password", - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-s-h-a-user.md deleted file mode 100644 index ca387cf846..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-s-h-a-user.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createSHAUser( - userId = "<USER_ID>", - email = "email@example.com", - password = "password", - passwordVersion = "sha1", // optional - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-modified-user.md deleted file mode 100644 index 51f0b6c430..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,20 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createScryptModifiedUser( - userId = "<USER_ID>", - email = "email@example.com", - password = "password", - passwordSalt = "<PASSWORD_SALT>", - passwordSaltSeparator = "<PASSWORD_SALT_SEPARATOR>", - passwordSignerKey = "<PASSWORD_SIGNER_KEY>", - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-user.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-user.md deleted file mode 100644 index 4081f625c3..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-scrypt-user.md +++ /dev/null @@ -1,22 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createScryptUser( - userId = "<USER_ID>", - email = "email@example.com", - password = "password", - passwordSalt = "<PASSWORD_SALT>", - passwordCpu = 0, - passwordMemory = 0, - passwordParallel = 0, - passwordLength = 0, - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-session.md deleted file mode 100644 index 41842441e0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createSession( - userId = "<USER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-target.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-target.md deleted file mode 100644 index 9fa3a74b72..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-target.md +++ /dev/null @@ -1,20 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users -import io.appwrite.enums.MessagingProviderType - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createTarget( - userId = "<USER_ID>", - targetId = "<TARGET_ID>", - providerType = MessagingProviderType.EMAIL, - identifier = "<IDENTIFIER>", - providerId = "<PROVIDER_ID>", // optional - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-token.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create-token.md deleted file mode 100644 index 0687d3a2a6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create-token.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.createToken( - userId = "<USER_ID>", - length = 4, // optional - expire = 60 // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/create.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/create.md deleted file mode 100644 index 21362593c6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/create.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.create( - userId = "<USER_ID>", - email = "email@example.com", // optional - phone = "+12065550100", // optional - password = "", // optional - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-identity.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-identity.md deleted file mode 100644 index 0574f4dbdd..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-identity.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.deleteIdentity( - identityId = "<IDENTITY_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-mfa-authenticator.md deleted file mode 100644 index 8ec1613314..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,16 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users -import io.appwrite.enums.AuthenticatorType - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.deleteMfaAuthenticator( - userId = "<USER_ID>", - type = AuthenticatorType.TOTP -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-session.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-session.md deleted file mode 100644 index 15abe3a13b..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-session.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.deleteSession( - userId = "<USER_ID>", - sessionId = "<SESSION_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-sessions.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-sessions.md deleted file mode 100644 index 1028c9e2e5..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-sessions.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.deleteSessions( - userId = "<USER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-target.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-target.md deleted file mode 100644 index ccde9049cc..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete-target.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.deleteTarget( - userId = "<USER_ID>", - targetId = "<TARGET_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/delete.md deleted file mode 100644 index 7273c67136..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.delete( - userId = "<USER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/get-mfa-recovery-codes.md deleted file mode 100644 index b748003d6f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.getMfaRecoveryCodes( - userId = "<USER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/get-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/get-prefs.md deleted file mode 100644 index 2282c8d00c..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/get-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.getPrefs( - userId = "<USER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/get-target.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/get-target.md deleted file mode 100644 index db016f3088..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/get-target.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.getTarget( - userId = "<USER_ID>", - targetId = "<TARGET_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/get.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/get.md deleted file mode 100644 index 7effbb9921..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/get.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.get( - userId = "<USER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-identities.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-identities.md deleted file mode 100644 index 0bc111e80a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-identities.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.listIdentities( - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-logs.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-logs.md deleted file mode 100644 index 8b140e57e7..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.listLogs( - userId = "<USER_ID>", - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-memberships.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-memberships.md deleted file mode 100644 index 6e2f1122a0..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-memberships.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.listMemberships( - userId = "<USER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-mfa-factors.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-mfa-factors.md deleted file mode 100644 index 7fb799183d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-mfa-factors.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.listMfaFactors( - userId = "<USER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-sessions.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-sessions.md deleted file mode 100644 index 4922d7364a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-sessions.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.listSessions( - userId = "<USER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-targets.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list-targets.md deleted file mode 100644 index 4ea9a09c88..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/list-targets.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.listTargets( - userId = "<USER_ID>", - queries = listOf() // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/list.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/list.md deleted file mode 100644 index 4360ae632e..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/list.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.list( - queries = listOf(), // optional - search = "<SEARCH>" // optional -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email-verification.md deleted file mode 100644 index 37a69dbee6..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updateEmailVerification( - userId = "<USER_ID>", - emailVerification = false -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email.md deleted file mode 100644 index 0a6a7c7e16..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-email.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updateEmail( - userId = "<USER_ID>", - email = "email@example.com" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-labels.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-labels.md deleted file mode 100644 index c54255392a..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-labels.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updateLabels( - userId = "<USER_ID>", - labels = listOf() -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa-recovery-codes.md deleted file mode 100644 index e251ce195f..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,14 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updateMfaRecoveryCodes( - userId = "<USER_ID>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa.md deleted file mode 100644 index c31642c6b8..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-mfa.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updateMfa( - userId = "<USER_ID>", - mfa = false -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-name.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-name.md deleted file mode 100644 index 21102d3ad2..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-name.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updateName( - userId = "<USER_ID>", - name = "<NAME>" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-password.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-password.md deleted file mode 100644 index 3104810f01..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-password.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updatePassword( - userId = "<USER_ID>", - password = "" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone-verification.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone-verification.md deleted file mode 100644 index 516484ccf3..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updatePhoneVerification( - userId = "<USER_ID>", - phoneVerification = false -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone.md deleted file mode 100644 index 47126c7c4d..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-phone.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updatePhone( - userId = "<USER_ID>", - number = "+12065550100" -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-prefs.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-prefs.md deleted file mode 100644 index 03abe5ad02..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-prefs.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updatePrefs( - userId = "<USER_ID>", - prefs = mapOf( "a" to "b" ) -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-status.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-status.md deleted file mode 100644 index fec039e599..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-status.md +++ /dev/null @@ -1,15 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updateStatus( - userId = "<USER_ID>", - status = false -) diff --git a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-target.md b/docs/examples/1.6.x/server-kotlin/kotlin/users/update-target.md deleted file mode 100644 index 26aaa793de..0000000000 --- a/docs/examples/1.6.x/server-kotlin/kotlin/users/update-target.md +++ /dev/null @@ -1,18 +0,0 @@ -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Users - -val client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -val users = Users(client) - -val response = users.updateTarget( - userId = "<USER_ID>", - targetId = "<TARGET_ID>", - identifier = "<IDENTIFIER>", // optional - providerId = "<PROVIDER_ID>", // optional - name = "<NAME>" // optional -) diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-anonymous-session.md deleted file mode 100644 index bf28589e24..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,9 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.createAnonymousSession(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-email-password-session.md deleted file mode 100644 index 9652c900a1..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-email-password-session.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.createEmailPasswordSession( - 'email@example.com', // email - 'password' // password -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-email-token.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-email-token.md deleted file mode 100644 index 92b614f400..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-email-token.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.createEmailToken( - '<USER_ID>', // userId - 'email@example.com', // email - false // phrase (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-j-w-t.md deleted file mode 100644 index e29b7c1f87..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-j-w-t.md +++ /dev/null @@ -1,9 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.createJWT(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index d73906d5b6..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.createMagicURLToken( - '<USER_ID>', // userId - 'email@example.com', // email - 'https://example.com', // url (optional) - false // phrase (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 3227834f64..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.createMfaAuthenticator( - sdk.AuthenticatorType.Totp // type -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-challenge.md deleted file mode 100644 index 223e8f3645..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,11 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.createMfaChallenge( - sdk.AuthenticationFactor.Email // factor -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index 7c311ba75c..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.createMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-o-auth2token.md deleted file mode 100644 index 133006b034..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.createOAuth2Token( - sdk.OAuthProvider.Amazon, // provider - 'https://example.com', // success (optional) - 'https://example.com', // failure (optional) - [] // scopes (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-token.md deleted file mode 100644 index 4c10068947..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-token.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.createPhoneToken( - '<USER_ID>', // userId - '+12065550100' // phone -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-verification.md deleted file mode 100644 index ec297d6c8d..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-phone-verification.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.createPhoneVerification(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-recovery.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-recovery.md deleted file mode 100644 index b347ef8b37..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-recovery.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.createRecovery( - 'email@example.com', // email - 'https://example.com' // url -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-session.md deleted file mode 100644 index 8ff9b399fd..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-session.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.createSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create-verification.md b/docs/examples/1.6.x/server-nodejs/examples/account/create-verification.md deleted file mode 100644 index 584eefb19e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.createVerification( - 'https://example.com' // url -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/create.md b/docs/examples/1.6.x/server-nodejs/examples/account/create.md deleted file mode 100644 index c3b80c0970..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/create.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.create( - '<USER_ID>', // userId - 'email@example.com', // email - '', // password - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/delete-identity.md b/docs/examples/1.6.x/server-nodejs/examples/account/delete-identity.md deleted file mode 100644 index 9413e9fe48..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/delete-identity.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.deleteIdentity( - '<IDENTITY_ID>' // identityId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-nodejs/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 173c663daa..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.deleteMfaAuthenticator( - sdk.AuthenticatorType.Totp // type -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/delete-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/delete-session.md deleted file mode 100644 index cd6b29498c..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/delete-session.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.deleteSession( - '<SESSION_ID>' // sessionId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-nodejs/examples/account/delete-sessions.md deleted file mode 100644 index a64365f5f4..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/delete-sessions.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.deleteSessions(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index 5a7942eb12..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.getMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/get-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/account/get-prefs.md deleted file mode 100644 index 5a2091f57e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/get-prefs.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.getPrefs(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/get-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/get-session.md deleted file mode 100644 index 622a209ea2..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/get-session.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.getSession( - '<SESSION_ID>' // sessionId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/get.md b/docs/examples/1.6.x/server-nodejs/examples/account/get.md deleted file mode 100644 index 2280d354d9..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/get.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.get(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/list-identities.md b/docs/examples/1.6.x/server-nodejs/examples/account/list-identities.md deleted file mode 100644 index f8fcf27f23..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/list-identities.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.listIdentities( - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/list-logs.md b/docs/examples/1.6.x/server-nodejs/examples/account/list-logs.md deleted file mode 100644 index 0df7bb8133..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/list-logs.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.listLogs( - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-nodejs/examples/account/list-mfa-factors.md deleted file mode 100644 index b70505dd19..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.listMfaFactors(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/list-sessions.md b/docs/examples/1.6.x/server-nodejs/examples/account/list-sessions.md deleted file mode 100644 index 209434905a..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/list-sessions.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.listSessions(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-email.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-email.md deleted file mode 100644 index d165475e27..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-email.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updateEmail( - 'email@example.com', // email - 'password' // password -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-m-f-a.md deleted file mode 100644 index fcfc9ff4c1..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-m-f-a.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updateMFA( - false // mfa -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 5cd0228f3e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.updateMagicURLSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-authenticator.md deleted file mode 100644 index 9ea19d19c4..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updateMfaAuthenticator( - sdk.AuthenticatorType.Totp, // type - '<OTP>' // otp -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-challenge.md deleted file mode 100644 index d66f7e6cf6..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updateMfaChallenge( - '<CHALLENGE_ID>', // challengeId - '<OTP>' // otp -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index c5f4fce70b..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-name.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-name.md deleted file mode 100644 index e57bd12562..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-name.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updateName( - '<NAME>' // name -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-password.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-password.md deleted file mode 100644 index 8ddbef43ee..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-password.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updatePassword( - '', // password - 'password' // oldPassword (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-session.md deleted file mode 100644 index 17fddbc1da..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-session.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>'); // Your project ID - -const account = new sdk.Account(client); - -const result = await account.updatePhoneSession( - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-verification.md deleted file mode 100644 index 5e7c0bdecc..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updatePhoneVerification( - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-phone.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-phone.md deleted file mode 100644 index 3f6a85361b..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-phone.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updatePhone( - '+12065550100', // phone - 'password' // password -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-prefs.md deleted file mode 100644 index f4889bc14d..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updatePrefs( - {} // prefs -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-recovery.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-recovery.md deleted file mode 100644 index bdc50fb5a7..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updateRecovery( - '<USER_ID>', // userId - '<SECRET>', // secret - '' // password -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-session.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-session.md deleted file mode 100644 index 40c572b388..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-session.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updateSession( - '<SESSION_ID>' // sessionId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-status.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-status.md deleted file mode 100644 index 769d6695df..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-status.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updateStatus(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/account/update-verification.md b/docs/examples/1.6.x/server-nodejs/examples/account/update-verification.md deleted file mode 100644 index 631d01a8ac..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/account/update-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const account = new sdk.Account(client); - -const result = await account.updateVerification( - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-browser.md deleted file mode 100644 index c9973c40f5..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-browser.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new sdk.Avatars(client); - -const result = await avatars.getBrowser( - sdk.Browser.AvantBrowser, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-credit-card.md deleted file mode 100644 index 51a20239ef..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new sdk.Avatars(client); - -const result = await avatars.getCreditCard( - sdk.CreditCard.AmericanExpress, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-favicon.md deleted file mode 100644 index af44e4e49e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-favicon.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new sdk.Avatars(client); - -const result = await avatars.getFavicon( - 'https://example.com' // url -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-flag.md deleted file mode 100644 index a755070e7b..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-flag.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new sdk.Avatars(client); - -const result = await avatars.getFlag( - sdk.Flag.Afghanistan, // code - 0, // width (optional) - 0, // height (optional) - 0 // quality (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-image.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-image.md deleted file mode 100644 index f9b820faf5..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-image.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new sdk.Avatars(client); - -const result = await avatars.getImage( - 'https://example.com', // url - 0, // width (optional) - 0 // height (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-initials.md deleted file mode 100644 index 4ad89bbf11..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-initials.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new sdk.Avatars(client); - -const result = await avatars.getInitials( - '<NAME>', // name (optional) - 0, // width (optional) - 0, // height (optional) - '' // background (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-nodejs/examples/avatars/get-q-r.md deleted file mode 100644 index 8ca6e1fec3..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/avatars/get-q-r.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const avatars = new sdk.Avatars(client); - -const result = await avatars.getQR( - '<TEXT>', // text - 1, // size (optional) - 0, // margin (optional) - false // download (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-boolean-attribute.md deleted file mode 100644 index e0d9c4e938..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createBooleanAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - false, // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-collection.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-collection.md deleted file mode 100644 index f2a7ee1b86..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-collection.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // documentSecurity (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-datetime-attribute.md deleted file mode 100644 index 4849649f9b..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createDatetimeAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '', // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-document.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-document.md deleted file mode 100644 index c5f44c0c14..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-document.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const databases = new sdk.Databases(client); - -const result = await databases.createDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - {}, // data - ["read("any")"] // permissions (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-email-attribute.md deleted file mode 100644 index f629ace193..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createEmailAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'email@example.com', // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-enum-attribute.md deleted file mode 100644 index 2aa0a03842..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createEnumAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - [], // elements - false, // required - '<DEFAULT>', // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-float-attribute.md deleted file mode 100644 index 7b0b4ddcc6..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createFloatAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min (optional) - null, // max (optional) - null, // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-index.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-index.md deleted file mode 100644 index 172b6231f4..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-index.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createIndex( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - sdk.IndexType.Key, // type - [], // attributes - [] // orders (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-integer-attribute.md deleted file mode 100644 index b9cb5d3d7f..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createIntegerAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min (optional) - null, // max (optional) - null, // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-ip-attribute.md deleted file mode 100644 index ac468c5b52..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createIpAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '', // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-relationship-attribute.md deleted file mode 100644 index 8b0d199e70..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createRelationshipAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<RELATED_COLLECTION_ID>', // relatedCollectionId - sdk.RelationshipType.OneToOne, // type - false, // twoWay (optional) - '', // key (optional) - '', // twoWayKey (optional) - sdk.RelationMutate.Cascade // onDelete (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-string-attribute.md deleted file mode 100644 index c9702e2df0..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createStringAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - 1, // size - false, // required - '<DEFAULT>', // default (optional) - false, // array (optional) - false // encrypt (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create-url-attribute.md deleted file mode 100644 index 0707dfa9ab..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createUrlAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'https://example.com', // default (optional) - false // array (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/create.md b/docs/examples/1.6.x/server-nodejs/examples/databases/create.md deleted file mode 100644 index 6427a45506..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/create.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.create( - '<DATABASE_ID>', // databaseId - '<NAME>', // name - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-attribute.md deleted file mode 100644 index e467b01a15..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.deleteAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-collection.md deleted file mode 100644 index 0735ea830c..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-collection.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.deleteCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>' // collectionId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-document.md b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-document.md deleted file mode 100644 index 94b52a13ca..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-document.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const databases = new sdk.Databases(client); - -const result = await databases.deleteDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>' // documentId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-index.md b/docs/examples/1.6.x/server-nodejs/examples/databases/delete-index.md deleted file mode 100644 index 0b62c30a17..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/delete-index.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.deleteIndex( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/delete.md b/docs/examples/1.6.x/server-nodejs/examples/databases/delete.md deleted file mode 100644 index 192649cbca..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.delete( - '<DATABASE_ID>' // databaseId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/get-attribute.md deleted file mode 100644 index 915f269b02..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/get-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.getAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/get-collection.md b/docs/examples/1.6.x/server-nodejs/examples/databases/get-collection.md deleted file mode 100644 index 51d6acbe84..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/get-collection.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.getCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>' // collectionId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/get-document.md b/docs/examples/1.6.x/server-nodejs/examples/databases/get-document.md deleted file mode 100644 index 16d91ce408..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/get-document.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const databases = new sdk.Databases(client); - -const result = await databases.getDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/get-index.md b/docs/examples/1.6.x/server-nodejs/examples/databases/get-index.md deleted file mode 100644 index 78e93f8889..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/get-index.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.getIndex( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '' // key -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/get.md b/docs/examples/1.6.x/server-nodejs/examples/databases/get.md deleted file mode 100644 index 04b28c9f78..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/get.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.get( - '<DATABASE_ID>' // databaseId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-nodejs/examples/databases/list-attributes.md deleted file mode 100644 index fb670ac2b8..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/list-attributes.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.listAttributes( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/list-collections.md b/docs/examples/1.6.x/server-nodejs/examples/databases/list-collections.md deleted file mode 100644 index d57396e0d7..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/list-collections.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.listCollections( - '<DATABASE_ID>', // databaseId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/list-documents.md b/docs/examples/1.6.x/server-nodejs/examples/databases/list-documents.md deleted file mode 100644 index 35bc853c93..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/list-documents.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const databases = new sdk.Databases(client); - -const result = await databases.listDocuments( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-nodejs/examples/databases/list-indexes.md deleted file mode 100644 index f600cef479..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/list-indexes.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.listIndexes( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/list.md b/docs/examples/1.6.x/server-nodejs/examples/databases/list.md deleted file mode 100644 index 6108fdb8a4..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/list.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-boolean-attribute.md deleted file mode 100644 index c036e185f4..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateBooleanAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - false // default -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-collection.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-collection.md deleted file mode 100644 index a8f0297a78..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-collection.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateCollection( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // documentSecurity (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-datetime-attribute.md deleted file mode 100644 index c82b0c4bf3..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateDatetimeAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '' // default -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-document.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-document.md deleted file mode 100644 index be1e7c3496..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-document.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const databases = new sdk.Databases(client); - -const result = await databases.updateDocument( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '<DOCUMENT_ID>', // documentId - {}, // data (optional) - ["read("any")"] // permissions (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-email-attribute.md deleted file mode 100644 index 60771fbc90..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateEmailAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'email@example.com' // default -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-enum-attribute.md deleted file mode 100644 index f7e06de814..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateEnumAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - [], // elements - false, // required - '<DEFAULT>' // default -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-float-attribute.md deleted file mode 100644 index 911bc832a4..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateFloatAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min - null, // max - null // default -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-integer-attribute.md deleted file mode 100644 index 17fd591c69..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateIntegerAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - null, // min - null, // max - null // default -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-ip-attribute.md deleted file mode 100644 index abbee0bbc8..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateIpAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '' // default -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-relationship-attribute.md deleted file mode 100644 index 122c4e9715..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateRelationshipAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - sdk.RelationMutate.Cascade // onDelete (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-string-attribute.md deleted file mode 100644 index 8f9d0a8ed5..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateStringAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - '<DEFAULT>' // default -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update-url-attribute.md deleted file mode 100644 index 851a082e57..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateUrlAttribute( - '<DATABASE_ID>', // databaseId - '<COLLECTION_ID>', // collectionId - '', // key - false, // required - 'https://example.com' // default -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/databases/update.md b/docs/examples/1.6.x/server-nodejs/examples/databases/update.md deleted file mode 100644 index cd3a479595..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/databases/update.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.update( - '<DATABASE_ID>', // databaseId - '<NAME>', // name - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/create-build.md b/docs/examples/1.6.x/server-nodejs/examples/functions/create-build.md deleted file mode 100644 index 447d4dc994..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/create-build.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.createBuild( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>', // deploymentId - '<BUILD_ID>' // buildId (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-nodejs/examples/functions/create-deployment.md deleted file mode 100644 index b897e27380..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/create-deployment.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); -const fs = require('fs'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.createDeployment( - '<FUNCTION_ID>', // functionId - InputFile.fromPath('/path/to/file', 'filename'), // code - false, // activate - '<ENTRYPOINT>', // entrypoint (optional) - '<COMMANDS>' // commands (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/create-execution.md b/docs/examples/1.6.x/server-nodejs/examples/functions/create-execution.md deleted file mode 100644 index 1b5e09b094..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/create-execution.md +++ /dev/null @@ -1,18 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const functions = new sdk.Functions(client); - -const result = await functions.createExecution( - '<FUNCTION_ID>', // functionId - '<BODY>', // body (optional) - false, // async (optional) - '<PATH>', // path (optional) - sdk.ExecutionMethod.GET, // method (optional) - {}, // headers (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/create-variable.md b/docs/examples/1.6.x/server-nodejs/examples/functions/create-variable.md deleted file mode 100644 index ae8b162800..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/create-variable.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.createVariable( - '<FUNCTION_ID>', // functionId - '<KEY>', // key - '<VALUE>' // value -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/create.md b/docs/examples/1.6.x/server-nodejs/examples/functions/create.md deleted file mode 100644 index 0ba39858b2..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/create.md +++ /dev/null @@ -1,32 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.create( - '<FUNCTION_ID>', // functionId - '<NAME>', // name - sdk..Node145, // runtime - ["any"], // execute (optional) - [], // events (optional) - '', // schedule (optional) - 1, // timeout (optional) - false, // enabled (optional) - false, // logging (optional) - '<ENTRYPOINT>', // entrypoint (optional) - '<COMMANDS>', // commands (optional) - [], // scopes (optional) - '<INSTALLATION_ID>', // installationId (optional) - '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) - '<PROVIDER_BRANCH>', // providerBranch (optional) - false, // providerSilentMode (optional) - '<PROVIDER_ROOT_DIRECTORY>', // providerRootDirectory (optional) - '<TEMPLATE_REPOSITORY>', // templateRepository (optional) - '<TEMPLATE_OWNER>', // templateOwner (optional) - '<TEMPLATE_ROOT_DIRECTORY>', // templateRootDirectory (optional) - '<TEMPLATE_BRANCH>' // templateBranch (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-nodejs/examples/functions/delete-deployment.md deleted file mode 100644 index d55121c59d..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/delete-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.deleteDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-nodejs/examples/functions/delete-execution.md deleted file mode 100644 index 36e6db1a20..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/delete-execution.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.deleteExecution( - '<FUNCTION_ID>', // functionId - '<EXECUTION_ID>' // executionId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-nodejs/examples/functions/delete-variable.md deleted file mode 100644 index a311b11ce4..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/delete-variable.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.deleteVariable( - '<FUNCTION_ID>', // functionId - '<VARIABLE_ID>' // variableId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/delete.md b/docs/examples/1.6.x/server-nodejs/examples/functions/delete.md deleted file mode 100644 index 52bdecc8df..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.delete( - '<FUNCTION_ID>' // functionId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-nodejs/examples/functions/download-deployment.md deleted file mode 100644 index cae51c976e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/download-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.downloadDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-nodejs/examples/functions/get-deployment.md deleted file mode 100644 index 315b4925bc..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/get-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.getDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/get-execution.md b/docs/examples/1.6.x/server-nodejs/examples/functions/get-execution.md deleted file mode 100644 index 2945cd351a..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/get-execution.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const functions = new sdk.Functions(client); - -const result = await functions.getExecution( - '<FUNCTION_ID>', // functionId - '<EXECUTION_ID>' // executionId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/get-variable.md b/docs/examples/1.6.x/server-nodejs/examples/functions/get-variable.md deleted file mode 100644 index 8917a88c85..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/get-variable.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.getVariable( - '<FUNCTION_ID>', // functionId - '<VARIABLE_ID>' // variableId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/get.md b/docs/examples/1.6.x/server-nodejs/examples/functions/get.md deleted file mode 100644 index 2df1739c5e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/get.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.get( - '<FUNCTION_ID>' // functionId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-nodejs/examples/functions/list-deployments.md deleted file mode 100644 index f8642fa0fa..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/list-deployments.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.listDeployments( - '<FUNCTION_ID>', // functionId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/list-executions.md b/docs/examples/1.6.x/server-nodejs/examples/functions/list-executions.md deleted file mode 100644 index 53f2833c3e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/list-executions.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const functions = new sdk.Functions(client); - -const result = await functions.listExecutions( - '<FUNCTION_ID>', // functionId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-nodejs/examples/functions/list-runtimes.md deleted file mode 100644 index 0b4442b948..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/list-runtimes.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.listRuntimes(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/list-variables.md b/docs/examples/1.6.x/server-nodejs/examples/functions/list-variables.md deleted file mode 100644 index 2aa6124133..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/list-variables.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.listVariables( - '<FUNCTION_ID>' // functionId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/list.md b/docs/examples/1.6.x/server-nodejs/examples/functions/list.md deleted file mode 100644 index 32a8316a3a..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/list.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment-build.md deleted file mode 100644 index 897a76a6b1..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.updateDeploymentBuild( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment.md deleted file mode 100644 index 4e7cc30bfc..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/update-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.updateDeployment( - '<FUNCTION_ID>', // functionId - '<DEPLOYMENT_ID>' // deploymentId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/update-variable.md b/docs/examples/1.6.x/server-nodejs/examples/functions/update-variable.md deleted file mode 100644 index e59bc005f4..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/update-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.updateVariable( - '<FUNCTION_ID>', // functionId - '<VARIABLE_ID>', // variableId - '<KEY>', // key - '<VALUE>' // value (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/functions/update.md b/docs/examples/1.6.x/server-nodejs/examples/functions/update.md deleted file mode 100644 index c437704516..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/functions/update.md +++ /dev/null @@ -1,28 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const functions = new sdk.Functions(client); - -const result = await functions.update( - '<FUNCTION_ID>', // functionId - '<NAME>', // name - sdk..Node145, // runtime (optional) - ["any"], // execute (optional) - [], // events (optional) - '', // schedule (optional) - 1, // timeout (optional) - false, // enabled (optional) - false, // logging (optional) - '<ENTRYPOINT>', // entrypoint (optional) - '<COMMANDS>', // commands (optional) - [], // scopes (optional) - '<INSTALLATION_ID>', // installationId (optional) - '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId (optional) - '<PROVIDER_BRANCH>', // providerBranch (optional) - false, // providerSilentMode (optional) - '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/graphql/mutation.md b/docs/examples/1.6.x/server-nodejs/examples/graphql/mutation.md deleted file mode 100644 index 26db8d424a..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/graphql/mutation.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const graphql = new sdk.Graphql(client); - -const result = await graphql.mutation( - {} // query -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/graphql/query.md b/docs/examples/1.6.x/server-nodejs/examples/graphql/query.md deleted file mode 100644 index dadf2ea059..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/graphql/query.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const graphql = new sdk.Graphql(client); - -const result = await graphql.query( - {} // query -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-antivirus.md deleted file mode 100644 index 998d5ba640..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-antivirus.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getAntivirus(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-cache.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-cache.md deleted file mode 100644 index 82b5417d18..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-cache.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getCache(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-certificate.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-certificate.md deleted file mode 100644 index 8e4b0cd221..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-certificate.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getCertificate( - '' // domain (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-d-b.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-d-b.md deleted file mode 100644 index 767b489c7d..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-d-b.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getDB(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-failed-jobs.md deleted file mode 100644 index 3494a1e863..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getFailedJobs( - sdk..V1Database, // name - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-pub-sub.md deleted file mode 100644 index ca4d073e46..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-pub-sub.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getPubSub(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-builds.md deleted file mode 100644 index 4f20de3087..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-builds.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueBuilds( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-certificates.md deleted file mode 100644 index 4cffb81043..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueCertificates( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-databases.md deleted file mode 100644 index 2bbc9d0f1e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-databases.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueDatabases( - '<NAME>', // name (optional) - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-deletes.md deleted file mode 100644 index abe5bd3967..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueDeletes( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-functions.md deleted file mode 100644 index e27619c956..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-functions.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueFunctions( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-logs.md deleted file mode 100644 index 862f40bc70..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-logs.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueLogs( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-mails.md deleted file mode 100644 index 125f5884cd..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-mails.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueMails( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-messaging.md deleted file mode 100644 index 22a2e4ea70..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueMessaging( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-migrations.md deleted file mode 100644 index 643b9bf3fc..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueMigrations( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage-dump.md deleted file mode 100644 index 7d3b36f697..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueUsageDump( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage.md deleted file mode 100644 index 3b3939475b..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-usage.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueUsage( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-webhooks.md deleted file mode 100644 index a42cbb6eb2..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueueWebhooks( - null // threshold (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-queue.md deleted file mode 100644 index 8dbd8a8b58..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-queue.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getQueue(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-storage-local.md deleted file mode 100644 index c5a1f2d10a..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-storage-local.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getStorageLocal(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-storage.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-storage.md deleted file mode 100644 index d2f8ce1215..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-storage.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getStorage(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get-time.md b/docs/examples/1.6.x/server-nodejs/examples/health/get-time.md deleted file mode 100644 index 6f03f315c1..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get-time.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.getTime(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/health/get.md b/docs/examples/1.6.x/server-nodejs/examples/health/get.md deleted file mode 100644 index d6c27f7870..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/health/get.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const health = new sdk.Health(client); - -const result = await health.get(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/get.md b/docs/examples/1.6.x/server-nodejs/examples/locale/get.md deleted file mode 100644 index eebf0690de..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/locale/get.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new sdk.Locale(client); - -const result = await locale.get(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-codes.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-codes.md deleted file mode 100644 index 32e3869ce9..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/locale/list-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new sdk.Locale(client); - -const result = await locale.listCodes(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-continents.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-continents.md deleted file mode 100644 index 964297480a..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/locale/list-continents.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new sdk.Locale(client); - -const result = await locale.listContinents(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-e-u.md deleted file mode 100644 index c7191127d9..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new sdk.Locale(client); - -const result = await locale.listCountriesEU(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-phones.md deleted file mode 100644 index 9a05844b4a..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new sdk.Locale(client); - -const result = await locale.listCountriesPhones(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries.md deleted file mode 100644 index 8fcca76562..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/locale/list-countries.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new sdk.Locale(client); - -const result = await locale.listCountries(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-currencies.md deleted file mode 100644 index 4bcbd33619..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/locale/list-currencies.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new sdk.Locale(client); - -const result = await locale.listCurrencies(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/locale/list-languages.md b/docs/examples/1.6.x/server-nodejs/examples/locale/list-languages.md deleted file mode 100644 index d1ce2c2199..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/locale/list-languages.md +++ /dev/null @@ -1,10 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const locale = new sdk.Locale(client); - -const result = await locale.listLanguages(); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-apns-provider.md deleted file mode 100644 index 9f5e9f97aa..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createApnsProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<AUTH_KEY>', // authKey (optional) - '<AUTH_KEY_ID>', // authKeyId (optional) - '<TEAM_ID>', // teamId (optional) - '<BUNDLE_ID>', // bundleId (optional) - false, // sandbox (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-email.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-email.md deleted file mode 100644 index 5df81b0a5d..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-email.md +++ /dev/null @@ -1,23 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createEmail( - '<MESSAGE_ID>', // messageId - '<SUBJECT>', // subject - '<CONTENT>', // content - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - [], // cc (optional) - [], // bcc (optional) - [], // attachments (optional) - false, // draft (optional) - false, // html (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-fcm-provider.md deleted file mode 100644 index e6f0e27534..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createFcmProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - {}, // serviceAccountJSON (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index 726c0b5dab..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createMailgunProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<API_KEY>', // apiKey (optional) - '<DOMAIN>', // domain (optional) - false, // isEuRegion (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - 'email@example.com', // replyToEmail (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-msg91provider.md deleted file mode 100644 index 591f56b696..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createMsg91Provider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<TEMPLATE_ID>', // templateId (optional) - '<SENDER_ID>', // senderId (optional) - '<AUTH_KEY>', // authKey (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-push.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-push.md deleted file mode 100644 index bdf14f2c3a..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-push.md +++ /dev/null @@ -1,27 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createPush( - '<MESSAGE_ID>', // messageId - '<TITLE>', // title - '<BODY>', // body - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - {}, // data (optional) - '<ACTION>', // action (optional) - '[ID1:ID2]', // image (optional) - '<ICON>', // icon (optional) - '<SOUND>', // sound (optional) - '<COLOR>', // color (optional) - '<TAG>', // tag (optional) - '<BADGE>', // badge (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index 48b8a0a686..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createSendgridProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<API_KEY>', // apiKey (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - 'email@example.com', // replyToEmail (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sms.md deleted file mode 100644 index 8116a3400a..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-sms.md +++ /dev/null @@ -1,18 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createSms( - '<MESSAGE_ID>', // messageId - '<CONTENT>', // content - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-smtp-provider.md deleted file mode 100644 index 2569fe72dd..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,25 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createSmtpProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '<HOST>', // host - 1, // port (optional) - '<USERNAME>', // username (optional) - '<PASSWORD>', // password (optional) - sdk.SmtpEncryption.None, // encryption (optional) - false, // autoTLS (optional) - '<MAILER>', // mailer (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - 'email@example.com', // replyToEmail (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-subscriber.md deleted file mode 100644 index 81d30a043c..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>', // subscriberId - '<TARGET_ID>' // targetId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-telesign-provider.md deleted file mode 100644 index 65df58803e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createTelesignProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<CUSTOMER_ID>', // customerId (optional) - '<API_KEY>', // apiKey (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index 0ebc6913bc..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createTextmagicProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<USERNAME>', // username (optional) - '<API_KEY>', // apiKey (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-topic.md deleted file mode 100644 index 875b14b583..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createTopic( - '<TOPIC_ID>', // topicId - '<NAME>', // name - ["any"] // subscribe (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-twilio-provider.md deleted file mode 100644 index dc65042ee9..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createTwilioProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<ACCOUNT_SID>', // accountSid (optional) - '<AUTH_TOKEN>', // authToken (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/create-vonage-provider.md deleted file mode 100644 index 7376e42143..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.createVonageProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name - '+12065550100', // from (optional) - '<API_KEY>', // apiKey (optional) - '<API_SECRET>', // apiSecret (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-provider.md deleted file mode 100644 index 907320670d..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-provider.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.deleteProvider( - '<PROVIDER_ID>' // providerId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-subscriber.md deleted file mode 100644 index ba59c6856c..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setJWT('<YOUR_JWT>'); // Your secret JSON Web Token - -const messaging = new sdk.Messaging(client); - -const result = await messaging.deleteSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>' // subscriberId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-topic.md deleted file mode 100644 index 32c387f170..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete-topic.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.deleteTopic( - '<TOPIC_ID>' // topicId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/delete.md deleted file mode 100644 index b2de2d4bbb..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.delete( - '<MESSAGE_ID>' // messageId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-message.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-message.md deleted file mode 100644 index 54a2f6edc5..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-message.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.getMessage( - '<MESSAGE_ID>' // messageId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-provider.md deleted file mode 100644 index 687c500fa6..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-provider.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.getProvider( - '<PROVIDER_ID>' // providerId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-subscriber.md deleted file mode 100644 index daa147f5f4..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.getSubscriber( - '<TOPIC_ID>', // topicId - '<SUBSCRIBER_ID>' // subscriberId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/get-topic.md deleted file mode 100644 index 539591c357..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/get-topic.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.getTopic( - '<TOPIC_ID>' // topicId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-message-logs.md deleted file mode 100644 index 86b03fbac6..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.listMessageLogs( - '<MESSAGE_ID>', // messageId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-messages.md deleted file mode 100644 index ec5928665f..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-messages.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.listMessages( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-provider-logs.md deleted file mode 100644 index 8523a9d34b..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.listProviderLogs( - '<PROVIDER_ID>', // providerId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-providers.md deleted file mode 100644 index bfd5c0375e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-providers.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.listProviders( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index 0e9e311eb5..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.listSubscriberLogs( - '<SUBSCRIBER_ID>', // subscriberId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscribers.md deleted file mode 100644 index f01917de61..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.listSubscribers( - '<TOPIC_ID>', // topicId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-targets.md deleted file mode 100644 index 15e405285d..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-targets.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.listTargets( - '<MESSAGE_ID>', // messageId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topic-logs.md deleted file mode 100644 index 7c4260b4de..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.listTopicLogs( - '<TOPIC_ID>', // topicId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topics.md deleted file mode 100644 index c535502aa5..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/list-topics.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.listTopics( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-apns-provider.md deleted file mode 100644 index 85bf310392..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateApnsProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<AUTH_KEY>', // authKey (optional) - '<AUTH_KEY_ID>', // authKeyId (optional) - '<TEAM_ID>', // teamId (optional) - '<BUNDLE_ID>', // bundleId (optional) - false // sandbox (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-email.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-email.md deleted file mode 100644 index 490f827686..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-email.md +++ /dev/null @@ -1,23 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateEmail( - '<MESSAGE_ID>', // messageId - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - '<SUBJECT>', // subject (optional) - '<CONTENT>', // content (optional) - false, // draft (optional) - false, // html (optional) - [], // cc (optional) - [], // bcc (optional) - '', // scheduledAt (optional) - [] // attachments (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-fcm-provider.md deleted file mode 100644 index ecbedda40e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateFcmProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - {} // serviceAccountJSON (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index cabd5a1525..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateMailgunProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - '<API_KEY>', // apiKey (optional) - '<DOMAIN>', // domain (optional) - false, // isEuRegion (optional) - false, // enabled (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - '<REPLY_TO_EMAIL>' // replyToEmail (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-msg91provider.md deleted file mode 100644 index 76b4410494..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateMsg91Provider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<TEMPLATE_ID>', // templateId (optional) - '<SENDER_ID>', // senderId (optional) - '<AUTH_KEY>' // authKey (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-push.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-push.md deleted file mode 100644 index 6a0dde5a98..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-push.md +++ /dev/null @@ -1,27 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updatePush( - '<MESSAGE_ID>', // messageId - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - '<TITLE>', // title (optional) - '<BODY>', // body (optional) - {}, // data (optional) - '<ACTION>', // action (optional) - '[ID1:ID2]', // image (optional) - '<ICON>', // icon (optional) - '<SOUND>', // sound (optional) - '<COLOR>', // color (optional) - '<TAG>', // tag (optional) - null, // badge (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index 7aefbbbd15..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateSendgridProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<API_KEY>', // apiKey (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - '<REPLY_TO_EMAIL>' // replyToEmail (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sms.md deleted file mode 100644 index 90e2709a7e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-sms.md +++ /dev/null @@ -1,18 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateSms( - '<MESSAGE_ID>', // messageId - [], // topics (optional) - [], // users (optional) - [], // targets (optional) - '<CONTENT>', // content (optional) - false, // draft (optional) - '' // scheduledAt (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-smtp-provider.md deleted file mode 100644 index 7b4286dd15..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,25 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateSmtpProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - '<HOST>', // host (optional) - 1, // port (optional) - '<USERNAME>', // username (optional) - '<PASSWORD>', // password (optional) - sdk.SmtpEncryption.None, // encryption (optional) - false, // autoTLS (optional) - '<MAILER>', // mailer (optional) - '<FROM_NAME>', // fromName (optional) - 'email@example.com', // fromEmail (optional) - '<REPLY_TO_NAME>', // replyToName (optional) - '<REPLY_TO_EMAIL>', // replyToEmail (optional) - false // enabled (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-telesign-provider.md deleted file mode 100644 index 3cfc777033..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateTelesignProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<CUSTOMER_ID>', // customerId (optional) - '<API_KEY>', // apiKey (optional) - '<FROM>' // from (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index 603b6251a9..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateTextmagicProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<USERNAME>', // username (optional) - '<API_KEY>', // apiKey (optional) - '<FROM>' // from (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-topic.md deleted file mode 100644 index be2b54b1b0..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateTopic( - '<TOPIC_ID>', // topicId - '<NAME>', // name (optional) - ["any"] // subscribe (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-twilio-provider.md deleted file mode 100644 index 6ae2d1005c..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateTwilioProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<ACCOUNT_SID>', // accountSid (optional) - '<AUTH_TOKEN>', // authToken (optional) - '<FROM>' // from (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-nodejs/examples/messaging/update-vonage-provider.md deleted file mode 100644 index f3b2ec514c..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const messaging = new sdk.Messaging(client); - -const result = await messaging.updateVonageProvider( - '<PROVIDER_ID>', // providerId - '<NAME>', // name (optional) - false, // enabled (optional) - '<API_KEY>', // apiKey (optional) - '<API_SECRET>', // apiSecret (optional) - '<FROM>' // from (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-nodejs/examples/storage/create-bucket.md deleted file mode 100644 index fac4246cfc..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/create-bucket.md +++ /dev/null @@ -1,21 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const storage = new sdk.Storage(client); - -const result = await storage.createBucket( - '<BUCKET_ID>', // bucketId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // fileSecurity (optional) - false, // enabled (optional) - 1, // maximumFileSize (optional) - [], // allowedFileExtensions (optional) - sdk..None, // compression (optional) - false, // encryption (optional) - false // antivirus (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/create-file.md b/docs/examples/1.6.x/server-nodejs/examples/storage/create-file.md deleted file mode 100644 index 216ec061eb..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/create-file.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); -const fs = require('fs'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new sdk.Storage(client); - -const result = await storage.createFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - InputFile.fromPath('/path/to/file', 'filename'), // file - ["read("any")"] // permissions (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-nodejs/examples/storage/delete-bucket.md deleted file mode 100644 index 8205316902..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/delete-bucket.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const storage = new sdk.Storage(client); - -const result = await storage.deleteBucket( - '<BUCKET_ID>' // bucketId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/delete-file.md b/docs/examples/1.6.x/server-nodejs/examples/storage/delete-file.md deleted file mode 100644 index 72528cc2ef..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/delete-file.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new sdk.Storage(client); - -const result = await storage.deleteFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-nodejs/examples/storage/get-bucket.md deleted file mode 100644 index ee518bd223..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/get-bucket.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const storage = new sdk.Storage(client); - -const result = await storage.getBucket( - '<BUCKET_ID>' // bucketId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-download.md deleted file mode 100644 index d485cbcddc..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-download.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new sdk.Storage(client); - -const result = await storage.getFileDownload( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-preview.md deleted file mode 100644 index d74fa17fc3..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-preview.md +++ /dev/null @@ -1,24 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new sdk.Storage(client); - -const result = await storage.getFilePreview( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - 0, // width (optional) - 0, // height (optional) - sdk.ImageGravity.Center, // gravity (optional) - 0, // quality (optional) - 0, // borderWidth (optional) - '', // borderColor (optional) - 0, // borderRadius (optional) - 0, // opacity (optional) - -360, // rotation (optional) - '', // background (optional) - sdk.ImageFormat.Jpg // output (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-view.md deleted file mode 100644 index e9544c9d56..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file-view.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new sdk.Storage(client); - -const result = await storage.getFileView( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file.md b/docs/examples/1.6.x/server-nodejs/examples/storage/get-file.md deleted file mode 100644 index 4f6829a854..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/get-file.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new sdk.Storage(client); - -const result = await storage.getFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>' // fileId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-nodejs/examples/storage/list-buckets.md deleted file mode 100644 index 0ae449ae8d..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/list-buckets.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const storage = new sdk.Storage(client); - -const result = await storage.listBuckets( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/list-files.md b/docs/examples/1.6.x/server-nodejs/examples/storage/list-files.md deleted file mode 100644 index 5bcaaa1b86..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/list-files.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new sdk.Storage(client); - -const result = await storage.listFiles( - '<BUCKET_ID>', // bucketId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-nodejs/examples/storage/update-bucket.md deleted file mode 100644 index 20c13f57b6..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/update-bucket.md +++ /dev/null @@ -1,21 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const storage = new sdk.Storage(client); - -const result = await storage.updateBucket( - '<BUCKET_ID>', // bucketId - '<NAME>', // name - ["read("any")"], // permissions (optional) - false, // fileSecurity (optional) - false, // enabled (optional) - 1, // maximumFileSize (optional) - [], // allowedFileExtensions (optional) - sdk..None, // compression (optional) - false, // encryption (optional) - false // antivirus (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/storage/update-file.md b/docs/examples/1.6.x/server-nodejs/examples/storage/update-file.md deleted file mode 100644 index d7cffd0ce6..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/storage/update-file.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const storage = new sdk.Storage(client); - -const result = await storage.updateFile( - '<BUCKET_ID>', // bucketId - '<FILE_ID>', // fileId - '<NAME>', // name (optional) - ["read("any")"] // permissions (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/create-membership.md b/docs/examples/1.6.x/server-nodejs/examples/teams/create-membership.md deleted file mode 100644 index 727dfed068..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/create-membership.md +++ /dev/null @@ -1,18 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.createMembership( - '<TEAM_ID>', // teamId - [], // roles - 'email@example.com', // email (optional) - '<USER_ID>', // userId (optional) - '+12065550100', // phone (optional) - 'https://example.com', // url (optional) - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/create.md b/docs/examples/1.6.x/server-nodejs/examples/teams/create.md deleted file mode 100644 index 0ebc5b88ed..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/create.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.create( - '<TEAM_ID>', // teamId - '<NAME>', // name - [] // roles (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-nodejs/examples/teams/delete-membership.md deleted file mode 100644 index 45eeb6f62c..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/delete-membership.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.deleteMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>' // membershipId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/delete.md b/docs/examples/1.6.x/server-nodejs/examples/teams/delete.md deleted file mode 100644 index 955d9db9e7..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.delete( - '<TEAM_ID>' // teamId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/get-membership.md b/docs/examples/1.6.x/server-nodejs/examples/teams/get-membership.md deleted file mode 100644 index b3926ff6c1..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/get-membership.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.getMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>' // membershipId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/teams/get-prefs.md deleted file mode 100644 index 3ba7de08d1..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.getPrefs( - '<TEAM_ID>' // teamId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/get.md b/docs/examples/1.6.x/server-nodejs/examples/teams/get.md deleted file mode 100644 index eb37554f73..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/get.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.get( - '<TEAM_ID>' // teamId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-nodejs/examples/teams/list-memberships.md deleted file mode 100644 index adb72ea318..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/list-memberships.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.listMemberships( - '<TEAM_ID>', // teamId - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/list.md b/docs/examples/1.6.x/server-nodejs/examples/teams/list.md deleted file mode 100644 index 61d59eb517..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/list.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership-status.md deleted file mode 100644 index dbcd2a1b6d..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership-status.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.updateMembershipStatus( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>', // membershipId - '<USER_ID>', // userId - '<SECRET>' // secret -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership.md b/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership.md deleted file mode 100644 index 37b87d2c0e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/update-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.updateMembership( - '<TEAM_ID>', // teamId - '<MEMBERSHIP_ID>', // membershipId - [] // roles -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/update-name.md b/docs/examples/1.6.x/server-nodejs/examples/teams/update-name.md deleted file mode 100644 index 215953b077..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.updateName( - '<TEAM_ID>', // teamId - '<NAME>' // name -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/teams/update-prefs.md deleted file mode 100644 index a226c64d16..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/teams/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setSession(''); // The user session to authenticate with - -const teams = new sdk.Teams(client); - -const result = await teams.updatePrefs( - '<TEAM_ID>', // teamId - {} // prefs -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-argon2user.md deleted file mode 100644 index 19ca547d1b..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-argon2user.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createArgon2User( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-bcrypt-user.md deleted file mode 100644 index b09f120572..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createBcryptUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-j-w-t.md deleted file mode 100644 index e8176955f0..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-j-w-t.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createJWT( - '<USER_ID>', // userId - '<SESSION_ID>', // sessionId (optional) - 0 // duration (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-m-d5user.md deleted file mode 100644 index 6bc48cb6c1..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-m-d5user.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createMD5User( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index 27e70f77fe..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createMfaRecoveryCodes( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-p-h-pass-user.md deleted file mode 100644 index 722257c809..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,15 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createPHPassUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-s-h-a-user.md deleted file mode 100644 index e401a4eba5..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createSHAUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - sdk.PasswordHash.Sha1, // passwordVersion (optional) - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index bfae622ec6..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,18 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createScryptModifiedUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<PASSWORD_SALT>', // passwordSalt - '<PASSWORD_SALT_SEPARATOR>', // passwordSaltSeparator - '<PASSWORD_SIGNER_KEY>', // passwordSignerKey - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-user.md deleted file mode 100644 index 6536d6a7c6..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,20 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createScryptUser( - '<USER_ID>', // userId - 'email@example.com', // email - 'password', // password - '<PASSWORD_SALT>', // passwordSalt - null, // passwordCpu - null, // passwordMemory - null, // passwordParallel - null, // passwordLength - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-session.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-session.md deleted file mode 100644 index a419c2ec81..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-session.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createSession( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-target.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-target.md deleted file mode 100644 index a76c90670a..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-target.md +++ /dev/null @@ -1,17 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createTarget( - '<USER_ID>', // userId - '<TARGET_ID>', // targetId - sdk.MessagingProviderType.Email, // providerType - '<IDENTIFIER>', // identifier - '<PROVIDER_ID>', // providerId (optional) - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create-token.md b/docs/examples/1.6.x/server-nodejs/examples/users/create-token.md deleted file mode 100644 index f635f9846d..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create-token.md +++ /dev/null @@ -1,14 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.createToken( - '<USER_ID>', // userId - 4, // length (optional) - 60 // expire (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/create.md b/docs/examples/1.6.x/server-nodejs/examples/users/create.md deleted file mode 100644 index f28fa456b2..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/create.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.create( - '<USER_ID>', // userId - 'email@example.com', // email (optional) - '+12065550100', // phone (optional) - '', // password (optional) - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete-identity.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete-identity.md deleted file mode 100644 index 5199ab5e2c..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/delete-identity.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.deleteIdentity( - '<IDENTITY_ID>' // identityId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index bcec77c201..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.deleteMfaAuthenticator( - '<USER_ID>', // userId - sdk.AuthenticatorType.Totp // type -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete-session.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete-session.md deleted file mode 100644 index 8554c97895..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/delete-session.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.deleteSession( - '<USER_ID>', // userId - '<SESSION_ID>' // sessionId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete-sessions.md deleted file mode 100644 index cea3805b6c..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/delete-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.deleteSessions( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete-target.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete-target.md deleted file mode 100644 index 48db925575..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/delete-target.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.deleteTarget( - '<USER_ID>', // userId - '<TARGET_ID>' // targetId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/delete.md b/docs/examples/1.6.x/server-nodejs/examples/users/delete.md deleted file mode 100644 index d1ed4165a4..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.delete( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index a528e6c4b3..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.getMfaRecoveryCodes( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/get-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/users/get-prefs.md deleted file mode 100644 index 7f51853c1c..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.getPrefs( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/get-target.md b/docs/examples/1.6.x/server-nodejs/examples/users/get-target.md deleted file mode 100644 index 8a3d0378a3..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/get-target.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.getTarget( - '<USER_ID>', // userId - '<TARGET_ID>' // targetId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/get.md b/docs/examples/1.6.x/server-nodejs/examples/users/get.md deleted file mode 100644 index 90581eff68..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/get.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.get( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-identities.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-identities.md deleted file mode 100644 index b5b2b92418..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/list-identities.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.listIdentities( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-logs.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-logs.md deleted file mode 100644 index 914c4a58e1..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/list-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.listLogs( - '<USER_ID>', // userId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-memberships.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-memberships.md deleted file mode 100644 index c73eeff2a4..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/list-memberships.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.listMemberships( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-mfa-factors.md deleted file mode 100644 index 7f4a6c13fb..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.listMfaFactors( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-sessions.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-sessions.md deleted file mode 100644 index 0de659f24b..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/list-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.listSessions( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list-targets.md b/docs/examples/1.6.x/server-nodejs/examples/users/list-targets.md deleted file mode 100644 index 8858d25d15..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/list-targets.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.listTargets( - '<USER_ID>', // userId - [] // queries (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/list.md b/docs/examples/1.6.x/server-nodejs/examples/users/list.md deleted file mode 100644 index 00f823dedc..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/list.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.list( - [], // queries (optional) - '<SEARCH>' // search (optional) -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-email-verification.md deleted file mode 100644 index e5e275bcfc..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-email-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updateEmailVerification( - '<USER_ID>', // userId - false // emailVerification -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-email.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-email.md deleted file mode 100644 index 7908c6fdae..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-email.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updateEmail( - '<USER_ID>', // userId - 'email@example.com' // email -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-labels.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-labels.md deleted file mode 100644 index 7aea5e87a1..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-labels.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updateLabels( - '<USER_ID>', // userId - [] // labels -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index d2c4bf962a..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updateMfaRecoveryCodes( - '<USER_ID>' // userId -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa.md deleted file mode 100644 index ed27b8d95f..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-mfa.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updateMfa( - '<USER_ID>', // userId - false // mfa -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-name.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-name.md deleted file mode 100644 index 105e498f4e..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updateName( - '<USER_ID>', // userId - '<NAME>' // name -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-password.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-password.md deleted file mode 100644 index c9a569f8e3..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-password.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updatePassword( - '<USER_ID>', // userId - '' // password -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-phone-verification.md deleted file mode 100644 index 9551246057..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updatePhoneVerification( - '<USER_ID>', // userId - false // phoneVerification -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-phone.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-phone.md deleted file mode 100644 index 486cf6894d..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-phone.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updatePhone( - '<USER_ID>', // userId - '+12065550100' // number -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-prefs.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-prefs.md deleted file mode 100644 index ad1a283bde..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updatePrefs( - '<USER_ID>', // userId - {} // prefs -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-status.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-status.md deleted file mode 100644 index a56bcab437..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-status.md +++ /dev/null @@ -1,13 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updateStatus( - '<USER_ID>', // userId - false // status -); diff --git a/docs/examples/1.6.x/server-nodejs/examples/users/update-target.md b/docs/examples/1.6.x/server-nodejs/examples/users/update-target.md deleted file mode 100644 index d4a9c861bf..0000000000 --- a/docs/examples/1.6.x/server-nodejs/examples/users/update-target.md +++ /dev/null @@ -1,16 +0,0 @@ -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('<YOUR_PROJECT_ID>') // Your project ID - .setKey('<YOUR_API_KEY>'); // Your secret API key - -const users = new sdk.Users(client); - -const result = await users.updateTarget( - '<USER_ID>', // userId - '<TARGET_ID>', // targetId - '<IDENTIFIER>', // identifier (optional) - '<PROVIDER_ID>', // providerId (optional) - '<NAME>' // name (optional) -); diff --git a/docs/examples/1.6.x/server-php/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-php/examples/account/create-anonymous-session.md deleted file mode 100644 index c43c60e4a6..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,12 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->createAnonymousSession(); diff --git a/docs/examples/1.6.x/server-php/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-php/examples/account/create-email-password-session.md deleted file mode 100644 index faefc338dc..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-email-password-session.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->createEmailPasswordSession( - email: 'email@example.com', - password: 'password' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-email-token.md b/docs/examples/1.6.x/server-php/examples/account/create-email-token.md deleted file mode 100644 index 68dd7f4df8..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-email-token.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->createEmailToken( - userId: '<USER_ID>', - email: 'email@example.com', - phrase: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-php/examples/account/create-j-w-t.md deleted file mode 100644 index 33479c46ee..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-j-w-t.md +++ /dev/null @@ -1,12 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->createJWT(); diff --git a/docs/examples/1.6.x/server-php/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-php/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index f75991c381..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->createMagicURLToken( - userId: '<USER_ID>', - email: 'email@example.com', - url: 'https://example.com', // optional - phrase: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-php/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 95fca4654c..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; -use Appwrite\Enums\AuthenticatorType; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->createMfaAuthenticator( - type: AuthenticatorType::TOTP() -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-php/examples/account/create-mfa-challenge.md deleted file mode 100644 index 34bd0634eb..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; -use Appwrite\Enums\AuthenticationFactor; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->createMfaChallenge( - factor: AuthenticationFactor::EMAIL() -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index c47496728e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->createMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-php/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-php/examples/account/create-o-auth2token.md deleted file mode 100644 index 0411d6fa10..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; -use Appwrite\Enums\OAuthProvider; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->createOAuth2Token( - provider: OAuthProvider::AMAZON(), - success: 'https://example.com', // optional - failure: 'https://example.com', // optional - scopes: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-php/examples/account/create-phone-token.md deleted file mode 100644 index e5724d3716..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-phone-token.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->createPhoneToken( - userId: '<USER_ID>', - phone: '+12065550100' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-php/examples/account/create-phone-verification.md deleted file mode 100644 index e681607730..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->createPhoneVerification(); diff --git a/docs/examples/1.6.x/server-php/examples/account/create-recovery.md b/docs/examples/1.6.x/server-php/examples/account/create-recovery.md deleted file mode 100644 index 86cc2d9007..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-recovery.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->createRecovery( - email: 'email@example.com', - url: 'https://example.com' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-session.md b/docs/examples/1.6.x/server-php/examples/account/create-session.md deleted file mode 100644 index e714d11a7f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-session.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->createSession( - userId: '<USER_ID>', - secret: '<SECRET>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create-verification.md b/docs/examples/1.6.x/server-php/examples/account/create-verification.md deleted file mode 100644 index 9541956bd9..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->createVerification( - url: 'https://example.com' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/create.md b/docs/examples/1.6.x/server-php/examples/account/create.md deleted file mode 100644 index b4bc9df78f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/create.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->create( - userId: '<USER_ID>', - email: 'email@example.com', - password: '', - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/delete-identity.md b/docs/examples/1.6.x/server-php/examples/account/delete-identity.md deleted file mode 100644 index dc7f751410..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/delete-identity.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->deleteIdentity( - identityId: '<IDENTITY_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-php/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index a0574c554f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; -use Appwrite\Enums\AuthenticatorType; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->deleteMfaAuthenticator( - type: AuthenticatorType::TOTP() -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/delete-session.md b/docs/examples/1.6.x/server-php/examples/account/delete-session.md deleted file mode 100644 index e52d95e57f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/delete-session.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->deleteSession( - sessionId: '<SESSION_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-php/examples/account/delete-sessions.md deleted file mode 100644 index a49331776e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/delete-sessions.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->deleteSessions(); diff --git a/docs/examples/1.6.x/server-php/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index f640e9ecae..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->getMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-php/examples/account/get-prefs.md b/docs/examples/1.6.x/server-php/examples/account/get-prefs.md deleted file mode 100644 index f6489fcfec..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/get-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->getPrefs(); diff --git a/docs/examples/1.6.x/server-php/examples/account/get-session.md b/docs/examples/1.6.x/server-php/examples/account/get-session.md deleted file mode 100644 index 17bf7f7e0e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/get-session.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->getSession( - sessionId: '<SESSION_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/get.md b/docs/examples/1.6.x/server-php/examples/account/get.md deleted file mode 100644 index 8a362749b6..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/get.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->get(); diff --git a/docs/examples/1.6.x/server-php/examples/account/list-identities.md b/docs/examples/1.6.x/server-php/examples/account/list-identities.md deleted file mode 100644 index 78c6dd3659..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/list-identities.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->listIdentities( - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/list-logs.md b/docs/examples/1.6.x/server-php/examples/account/list-logs.md deleted file mode 100644 index 0dcdb3b2d6..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/list-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->listLogs( - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-php/examples/account/list-mfa-factors.md deleted file mode 100644 index e029574ae6..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->listMfaFactors(); diff --git a/docs/examples/1.6.x/server-php/examples/account/list-sessions.md b/docs/examples/1.6.x/server-php/examples/account/list-sessions.md deleted file mode 100644 index 28f2823a24..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/list-sessions.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->listSessions(); diff --git a/docs/examples/1.6.x/server-php/examples/account/update-email.md b/docs/examples/1.6.x/server-php/examples/account/update-email.md deleted file mode 100644 index 60cb7cc4c9..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-email.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updateEmail( - email: 'email@example.com', - password: 'password' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-php/examples/account/update-m-f-a.md deleted file mode 100644 index 1869f7e0d6..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-m-f-a.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updateMFA( - mfa: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-php/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index d5e1a9f7a2..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->updateMagicURLSession( - userId: '<USER_ID>', - secret: '<SECRET>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-php/examples/account/update-mfa-authenticator.md deleted file mode 100644 index f998c23eed..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; -use Appwrite\Enums\AuthenticatorType; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updateMfaAuthenticator( - type: AuthenticatorType::TOTP(), - otp: '<OTP>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-php/examples/account/update-mfa-challenge.md deleted file mode 100644 index 62124c5673..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updateMfaChallenge( - challengeId: '<CHALLENGE_ID>', - otp: '<OTP>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index 7babcac9c5..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updateMfaRecoveryCodes(); diff --git a/docs/examples/1.6.x/server-php/examples/account/update-name.md b/docs/examples/1.6.x/server-php/examples/account/update-name.md deleted file mode 100644 index 4e0f1cb20d..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-name.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updateName( - name: '<NAME>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-password.md b/docs/examples/1.6.x/server-php/examples/account/update-password.md deleted file mode 100644 index e438d2b290..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-password.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updatePassword( - password: '', - oldPassword: 'password' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-php/examples/account/update-phone-session.md deleted file mode 100644 index 29518153b3..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-phone-session.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>'); // Your project ID - -$account = new Account($client); - -$result = $account->updatePhoneSession( - userId: '<USER_ID>', - secret: '<SECRET>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-php/examples/account/update-phone-verification.md deleted file mode 100644 index 6b95838dda..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-phone-verification.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updatePhoneVerification( - userId: '<USER_ID>', - secret: '<SECRET>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-phone.md b/docs/examples/1.6.x/server-php/examples/account/update-phone.md deleted file mode 100644 index 85cff81cc4..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-phone.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updatePhone( - phone: '+12065550100', - password: 'password' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-prefs.md b/docs/examples/1.6.x/server-php/examples/account/update-prefs.md deleted file mode 100644 index c47859b9fe..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-prefs.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updatePrefs( - prefs: [] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-recovery.md b/docs/examples/1.6.x/server-php/examples/account/update-recovery.md deleted file mode 100644 index 5400fb5a69..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-recovery.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updateRecovery( - userId: '<USER_ID>', - secret: '<SECRET>', - password: '' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-session.md b/docs/examples/1.6.x/server-php/examples/account/update-session.md deleted file mode 100644 index 1a4611cb5f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-session.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updateSession( - sessionId: '<SESSION_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/account/update-status.md b/docs/examples/1.6.x/server-php/examples/account/update-status.md deleted file mode 100644 index 8511b2f08c..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-status.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updateStatus(); diff --git a/docs/examples/1.6.x/server-php/examples/account/update-verification.md b/docs/examples/1.6.x/server-php/examples/account/update-verification.md deleted file mode 100644 index 253693e9a3..0000000000 --- a/docs/examples/1.6.x/server-php/examples/account/update-verification.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Account; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$account = new Account($client); - -$result = $account->updateVerification( - userId: '<USER_ID>', - secret: '<SECRET>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-php/examples/avatars/get-browser.md deleted file mode 100644 index 47a6c857ea..0000000000 --- a/docs/examples/1.6.x/server-php/examples/avatars/get-browser.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Avatars; -use Appwrite\Enums\Browser; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$avatars = new Avatars($client); - -$result = $avatars->getBrowser( - code: Browser::AVANTBROWSER(), - width: 0, // optional - height: 0, // optional - quality: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-php/examples/avatars/get-credit-card.md deleted file mode 100644 index c1b6b15f6d..0000000000 --- a/docs/examples/1.6.x/server-php/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Avatars; -use Appwrite\Enums\CreditCard; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$avatars = new Avatars($client); - -$result = $avatars->getCreditCard( - code: CreditCard::AMERICANEXPRESS(), - width: 0, // optional - height: 0, // optional - quality: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-php/examples/avatars/get-favicon.md deleted file mode 100644 index 50bb5c4ae6..0000000000 --- a/docs/examples/1.6.x/server-php/examples/avatars/get-favicon.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Avatars; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$avatars = new Avatars($client); - -$result = $avatars->getFavicon( - url: 'https://example.com' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-php/examples/avatars/get-flag.md deleted file mode 100644 index c163deaa69..0000000000 --- a/docs/examples/1.6.x/server-php/examples/avatars/get-flag.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Avatars; -use Appwrite\Enums\Flag; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$avatars = new Avatars($client); - -$result = $avatars->getFlag( - code: Flag::AFGHANISTAN(), - width: 0, // optional - height: 0, // optional - quality: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-image.md b/docs/examples/1.6.x/server-php/examples/avatars/get-image.md deleted file mode 100644 index 31d2bbfceb..0000000000 --- a/docs/examples/1.6.x/server-php/examples/avatars/get-image.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Avatars; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$avatars = new Avatars($client); - -$result = $avatars->getImage( - url: 'https://example.com', - width: 0, // optional - height: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-php/examples/avatars/get-initials.md deleted file mode 100644 index 6a94e056a0..0000000000 --- a/docs/examples/1.6.x/server-php/examples/avatars/get-initials.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Avatars; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$avatars = new Avatars($client); - -$result = $avatars->getInitials( - name: '<NAME>', // optional - width: 0, // optional - height: 0, // optional - background: '' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-php/examples/avatars/get-q-r.md deleted file mode 100644 index 48f0008e5f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/avatars/get-q-r.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Avatars; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$avatars = new Avatars($client); - -$result = $avatars->getQR( - text: '<TEXT>', - size: 1, // optional - margin: 0, // optional - download: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-boolean-attribute.md deleted file mode 100644 index 27eba02779..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createBooleanAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - default: false, // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-collection.md b/docs/examples/1.6.x/server-php/examples/databases/create-collection.md deleted file mode 100644 index 72d36d2f07..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-collection.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createCollection( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - name: '<NAME>', - permissions: ["read("any")"], // optional - documentSecurity: false, // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-datetime-attribute.md deleted file mode 100644 index a959381c49..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createDatetimeAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - default: '', // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-document.md b/docs/examples/1.6.x/server-php/examples/databases/create-document.md deleted file mode 100644 index 612b114b0e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-document.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$databases = new Databases($client); - -$result = $databases->createDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>', - data: [], - permissions: ["read("any")"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-email-attribute.md deleted file mode 100644 index a72a42fa11..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createEmailAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - default: 'email@example.com', // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-enum-attribute.md deleted file mode 100644 index 2d6e3fb911..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createEnumAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - elements: [], - required: false, - default: '<DEFAULT>', // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-float-attribute.md deleted file mode 100644 index 83f42ead77..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createFloatAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - min: null, // optional - max: null, // optional - default: null, // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-index.md b/docs/examples/1.6.x/server-php/examples/databases/create-index.md deleted file mode 100644 index e79527160a..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-index.md +++ /dev/null @@ -1,21 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; -use Appwrite\Enums\IndexType; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createIndex( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - type: IndexType::KEY(), - attributes: [], - orders: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-integer-attribute.md deleted file mode 100644 index 5abc89ceaf..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createIntegerAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - min: null, // optional - max: null, // optional - default: null, // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-ip-attribute.md deleted file mode 100644 index 04c70f9025..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createIpAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - default: '', // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-relationship-attribute.md deleted file mode 100644 index 2e0ba6426d..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,23 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; -use Appwrite\Enums\RelationshipType; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createRelationshipAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - relatedCollectionId: '<RELATED_COLLECTION_ID>', - type: RelationshipType::ONETOONE(), - twoWay: false, // optional - key: '', // optional - twoWayKey: '', // optional - onDelete: RelationMutate::CASCADE() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-string-attribute.md deleted file mode 100644 index 450c9bc7a6..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createStringAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - size: 1, - required: false, - default: '<DEFAULT>', // optional - array: false, // optional - encrypt: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/create-url-attribute.md deleted file mode 100644 index e7a40b768d..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createUrlAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - default: 'https://example.com', // optional - array: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/create.md b/docs/examples/1.6.x/server-php/examples/databases/create.md deleted file mode 100644 index da4a650623..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/create.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->create( - databaseId: '<DATABASE_ID>', - name: '<NAME>', - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/delete-attribute.md deleted file mode 100644 index e60d39fa47..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/delete-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->deleteAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-php/examples/databases/delete-collection.md deleted file mode 100644 index ce821e71bb..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/delete-collection.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->deleteCollection( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/delete-document.md b/docs/examples/1.6.x/server-php/examples/databases/delete-document.md deleted file mode 100644 index 536cdcd9b9..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/delete-document.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$databases = new Databases($client); - -$result = $databases->deleteDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/delete-index.md b/docs/examples/1.6.x/server-php/examples/databases/delete-index.md deleted file mode 100644 index cb9ddf97e1..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/delete-index.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->deleteIndex( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/delete.md b/docs/examples/1.6.x/server-php/examples/databases/delete.md deleted file mode 100644 index 5b1a3229b0..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/delete.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->delete( - databaseId: '<DATABASE_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/get-attribute.md deleted file mode 100644 index 671f9ac757..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/get-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->getAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/get-collection.md b/docs/examples/1.6.x/server-php/examples/databases/get-collection.md deleted file mode 100644 index 23df77b4ba..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/get-collection.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->getCollection( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/get-document.md b/docs/examples/1.6.x/server-php/examples/databases/get-document.md deleted file mode 100644 index bee705fd8e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/get-document.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$databases = new Databases($client); - -$result = $databases->getDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>', - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/get-index.md b/docs/examples/1.6.x/server-php/examples/databases/get-index.md deleted file mode 100644 index b5878dd8b3..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/get-index.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->getIndex( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/get.md b/docs/examples/1.6.x/server-php/examples/databases/get.md deleted file mode 100644 index 4838b0b496..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/get.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->get( - databaseId: '<DATABASE_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-php/examples/databases/list-attributes.md deleted file mode 100644 index 6b1834f804..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/list-attributes.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->listAttributes( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/list-collections.md b/docs/examples/1.6.x/server-php/examples/databases/list-collections.md deleted file mode 100644 index 045aece5e2..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/list-collections.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->listCollections( - databaseId: '<DATABASE_ID>', - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/list-documents.md b/docs/examples/1.6.x/server-php/examples/databases/list-documents.md deleted file mode 100644 index c865f3294e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/list-documents.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$databases = new Databases($client); - -$result = $databases->listDocuments( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-php/examples/databases/list-indexes.md deleted file mode 100644 index fee8e8fd66..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/list-indexes.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->listIndexes( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/list.md b/docs/examples/1.6.x/server-php/examples/databases/list.md deleted file mode 100644 index ea89f25338..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/list.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->list( - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-boolean-attribute.md deleted file mode 100644 index a599d60fda..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateBooleanAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - default: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-collection.md b/docs/examples/1.6.x/server-php/examples/databases/update-collection.md deleted file mode 100644 index 70b052d583..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-collection.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateCollection( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - name: '<NAME>', - permissions: ["read("any")"], // optional - documentSecurity: false, // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-datetime-attribute.md deleted file mode 100644 index f0e92cf6e1..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateDatetimeAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - default: '' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-document.md b/docs/examples/1.6.x/server-php/examples/databases/update-document.md deleted file mode 100644 index 5af2f55ec9..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-document.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$databases = new Databases($client); - -$result = $databases->updateDocument( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - documentId: '<DOCUMENT_ID>', - data: [], // optional - permissions: ["read("any")"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-email-attribute.md deleted file mode 100644 index 8398758f5e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateEmailAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - default: 'email@example.com' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-enum-attribute.md deleted file mode 100644 index 0bd7db5810..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateEnumAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - elements: [], - required: false, - default: '<DEFAULT>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-float-attribute.md deleted file mode 100644 index 32c3ba484f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateFloatAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - min: null, - max: null, - default: null -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-integer-attribute.md deleted file mode 100644 index 2233cc02b5..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateIntegerAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - min: null, - max: null, - default: null -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-ip-attribute.md deleted file mode 100644 index a953ae15c8..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateIpAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - default: '' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-relationship-attribute.md deleted file mode 100644 index e4e16dfdac..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateRelationshipAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - onDelete: RelationMutate::CASCADE() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-string-attribute.md deleted file mode 100644 index b1a7ae4bb2..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateStringAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - default: '<DEFAULT>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-php/examples/databases/update-url-attribute.md deleted file mode 100644 index 383d721b7f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateUrlAttribute( - databaseId: '<DATABASE_ID>', - collectionId: '<COLLECTION_ID>', - key: '', - required: false, - default: 'https://example.com' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/databases/update.md b/docs/examples/1.6.x/server-php/examples/databases/update.md deleted file mode 100644 index 68cb21435d..0000000000 --- a/docs/examples/1.6.x/server-php/examples/databases/update.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Databases; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->update( - databaseId: '<DATABASE_ID>', - name: '<NAME>', - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/create-build.md b/docs/examples/1.6.x/server-php/examples/functions/create-build.md deleted file mode 100644 index 43c781fa18..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/create-build.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->createBuild( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>', - buildId: '<BUILD_ID>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-php/examples/functions/create-deployment.md deleted file mode 100644 index c35b88631a..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/create-deployment.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\InputFile; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->createDeployment( - functionId: '<FUNCTION_ID>', - code: InputFile::withPath('file.png'), - activate: false, - entrypoint: '<ENTRYPOINT>', // optional - commands: '<COMMANDS>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/create-execution.md b/docs/examples/1.6.x/server-php/examples/functions/create-execution.md deleted file mode 100644 index ff531d5423..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/create-execution.md +++ /dev/null @@ -1,21 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$functions = new Functions($client); - -$result = $functions->createExecution( - functionId: '<FUNCTION_ID>', - body: '<BODY>', // optional - async: false, // optional - path: '<PATH>', // optional - method: ExecutionMethod::GET(), // optional - headers: [], // optional - scheduledAt: '' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/create-variable.md b/docs/examples/1.6.x/server-php/examples/functions/create-variable.md deleted file mode 100644 index 441aa9de89..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/create-variable.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->createVariable( - functionId: '<FUNCTION_ID>', - key: '<KEY>', - value: '<VALUE>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/create.md b/docs/examples/1.6.x/server-php/examples/functions/create.md deleted file mode 100644 index f6dc1830f3..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/create.md +++ /dev/null @@ -1,36 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; -use Appwrite\Enums\; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->create( - functionId: '<FUNCTION_ID>', - name: '<NAME>', - runtime: ::NODE145(), - execute: ["any"], // optional - events: [], // optional - schedule: '', // optional - timeout: 1, // optional - enabled: false, // optional - logging: false, // optional - entrypoint: '<ENTRYPOINT>', // optional - commands: '<COMMANDS>', // optional - scopes: [], // optional - installationId: '<INSTALLATION_ID>', // optional - providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional - providerBranch: '<PROVIDER_BRANCH>', // optional - providerSilentMode: false, // optional - providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // optional - templateRepository: '<TEMPLATE_REPOSITORY>', // optional - templateOwner: '<TEMPLATE_OWNER>', // optional - templateRootDirectory: '<TEMPLATE_ROOT_DIRECTORY>', // optional - templateBranch: '<TEMPLATE_BRANCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-php/examples/functions/delete-deployment.md deleted file mode 100644 index 3f00e9d610..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/delete-deployment.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->deleteDeployment( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-php/examples/functions/delete-execution.md deleted file mode 100644 index 3733583614..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/delete-execution.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->deleteExecution( - functionId: '<FUNCTION_ID>', - executionId: '<EXECUTION_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-php/examples/functions/delete-variable.md deleted file mode 100644 index 5046e1f306..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/delete-variable.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->deleteVariable( - functionId: '<FUNCTION_ID>', - variableId: '<VARIABLE_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/delete.md b/docs/examples/1.6.x/server-php/examples/functions/delete.md deleted file mode 100644 index 3d4da02a89..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/delete.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->delete( - functionId: '<FUNCTION_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-php/examples/functions/download-deployment.md deleted file mode 100644 index 2841d86986..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/download-deployment.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->downloadDeployment( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-php/examples/functions/get-deployment.md deleted file mode 100644 index d5758dd10e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/get-deployment.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->getDeployment( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/get-execution.md b/docs/examples/1.6.x/server-php/examples/functions/get-execution.md deleted file mode 100644 index d0c7ec4168..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/get-execution.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$functions = new Functions($client); - -$result = $functions->getExecution( - functionId: '<FUNCTION_ID>', - executionId: '<EXECUTION_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/get-variable.md b/docs/examples/1.6.x/server-php/examples/functions/get-variable.md deleted file mode 100644 index 2bd901bd00..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/get-variable.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->getVariable( - functionId: '<FUNCTION_ID>', - variableId: '<VARIABLE_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/get.md b/docs/examples/1.6.x/server-php/examples/functions/get.md deleted file mode 100644 index b2c6d7ba06..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/get.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->get( - functionId: '<FUNCTION_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-php/examples/functions/list-deployments.md deleted file mode 100644 index d8bad27022..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/list-deployments.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->listDeployments( - functionId: '<FUNCTION_ID>', - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/list-executions.md b/docs/examples/1.6.x/server-php/examples/functions/list-executions.md deleted file mode 100644 index fda330aa44..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/list-executions.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$functions = new Functions($client); - -$result = $functions->listExecutions( - functionId: '<FUNCTION_ID>', - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-php/examples/functions/list-runtimes.md deleted file mode 100644 index 18d3c053ce..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/list-runtimes.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->listRuntimes(); diff --git a/docs/examples/1.6.x/server-php/examples/functions/list-variables.md b/docs/examples/1.6.x/server-php/examples/functions/list-variables.md deleted file mode 100644 index 137a4da032..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/list-variables.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->listVariables( - functionId: '<FUNCTION_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/list.md b/docs/examples/1.6.x/server-php/examples/functions/list.md deleted file mode 100644 index 7b4d3623db..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/list.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->list( - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-php/examples/functions/update-deployment-build.md deleted file mode 100644 index 653914ebb4..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->updateDeploymentBuild( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-php/examples/functions/update-deployment.md deleted file mode 100644 index 095b253f17..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/update-deployment.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->updateDeployment( - functionId: '<FUNCTION_ID>', - deploymentId: '<DEPLOYMENT_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/update-variable.md b/docs/examples/1.6.x/server-php/examples/functions/update-variable.md deleted file mode 100644 index 77a28f12dc..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/update-variable.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->updateVariable( - functionId: '<FUNCTION_ID>', - variableId: '<VARIABLE_ID>', - key: '<KEY>', - value: '<VALUE>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/functions/update.md b/docs/examples/1.6.x/server-php/examples/functions/update.md deleted file mode 100644 index db0d50a4ba..0000000000 --- a/docs/examples/1.6.x/server-php/examples/functions/update.md +++ /dev/null @@ -1,31 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Functions; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$functions = new Functions($client); - -$result = $functions->update( - functionId: '<FUNCTION_ID>', - name: '<NAME>', - runtime: ::NODE145(), // optional - execute: ["any"], // optional - events: [], // optional - schedule: '', // optional - timeout: 1, // optional - enabled: false, // optional - logging: false, // optional - entrypoint: '<ENTRYPOINT>', // optional - commands: '<COMMANDS>', // optional - scopes: [], // optional - installationId: '<INSTALLATION_ID>', // optional - providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional - providerBranch: '<PROVIDER_BRANCH>', // optional - providerSilentMode: false, // optional - providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/graphql/mutation.md b/docs/examples/1.6.x/server-php/examples/graphql/mutation.md deleted file mode 100644 index e074e0c2b3..0000000000 --- a/docs/examples/1.6.x/server-php/examples/graphql/mutation.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Graphql; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$graphql = new Graphql($client); - -$result = $graphql->mutation( - query: [] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/graphql/query.md b/docs/examples/1.6.x/server-php/examples/graphql/query.md deleted file mode 100644 index b871063631..0000000000 --- a/docs/examples/1.6.x/server-php/examples/graphql/query.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Graphql; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$graphql = new Graphql($client); - -$result = $graphql->query( - query: [] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-php/examples/health/get-antivirus.md deleted file mode 100644 index 64e83e0975..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-antivirus.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getAntivirus(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-cache.md b/docs/examples/1.6.x/server-php/examples/health/get-cache.md deleted file mode 100644 index 6096207d9c..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-cache.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getCache(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-certificate.md b/docs/examples/1.6.x/server-php/examples/health/get-certificate.md deleted file mode 100644 index d5d325e9d3..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-certificate.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getCertificate( - domain: '' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-d-b.md b/docs/examples/1.6.x/server-php/examples/health/get-d-b.md deleted file mode 100644 index 434fcad66e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-d-b.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getDB(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-php/examples/health/get-failed-jobs.md deleted file mode 100644 index 14705879cb..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; -use Appwrite\Enums\; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getFailedJobs( - name: ::V1DATABASE(), - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-php/examples/health/get-pub-sub.md deleted file mode 100644 index d2d3a5d665..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-pub-sub.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getPubSub(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-builds.md deleted file mode 100644 index 2911465d93..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-builds.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueBuilds( - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-certificates.md deleted file mode 100644 index 9323b41da7..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueCertificates( - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-databases.md deleted file mode 100644 index 54a9814db9..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-databases.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueDatabases( - name: '<NAME>', // optional - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-deletes.md deleted file mode 100644 index aee4deb26c..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueDeletes( - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-functions.md deleted file mode 100644 index f675b750f3..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-functions.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueFunctions( - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-logs.md deleted file mode 100644 index 05c463b2b7..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueLogs( - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-mails.md deleted file mode 100644 index 74d4959cd7..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-mails.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueMails( - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-messaging.md deleted file mode 100644 index 3fd96c66ea..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueMessaging( - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-migrations.md deleted file mode 100644 index 9f1a8be1cc..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueMigrations( - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-usage-dump.md deleted file mode 100644 index b856b730e3..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueUsageDump( - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-usage.md deleted file mode 100644 index 9b5baeb86e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-usage.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueUsage( - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-php/examples/health/get-queue-webhooks.md deleted file mode 100644 index e42b65b8fa..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueueWebhooks( - threshold: null // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/health/get-queue.md b/docs/examples/1.6.x/server-php/examples/health/get-queue.md deleted file mode 100644 index 81b22184ec..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-queue.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getQueue(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-php/examples/health/get-storage-local.md deleted file mode 100644 index 75999cebc6..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-storage-local.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getStorageLocal(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-storage.md b/docs/examples/1.6.x/server-php/examples/health/get-storage.md deleted file mode 100644 index a3b56b9765..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-storage.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getStorage(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get-time.md b/docs/examples/1.6.x/server-php/examples/health/get-time.md deleted file mode 100644 index 5deb2382c2..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get-time.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->getTime(); diff --git a/docs/examples/1.6.x/server-php/examples/health/get.md b/docs/examples/1.6.x/server-php/examples/health/get.md deleted file mode 100644 index 5001c4832e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/health/get.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Health; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$health = new Health($client); - -$result = $health->get(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/get.md b/docs/examples/1.6.x/server-php/examples/locale/get.md deleted file mode 100644 index b9f48b4c77..0000000000 --- a/docs/examples/1.6.x/server-php/examples/locale/get.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Locale; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$locale = new Locale($client); - -$result = $locale->get(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-codes.md b/docs/examples/1.6.x/server-php/examples/locale/list-codes.md deleted file mode 100644 index b35683c590..0000000000 --- a/docs/examples/1.6.x/server-php/examples/locale/list-codes.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Locale; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$locale = new Locale($client); - -$result = $locale->listCodes(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-continents.md b/docs/examples/1.6.x/server-php/examples/locale/list-continents.md deleted file mode 100644 index 1076f9998a..0000000000 --- a/docs/examples/1.6.x/server-php/examples/locale/list-continents.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Locale; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$locale = new Locale($client); - -$result = $locale->listContinents(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-php/examples/locale/list-countries-e-u.md deleted file mode 100644 index 93a4cadafc..0000000000 --- a/docs/examples/1.6.x/server-php/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Locale; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$locale = new Locale($client); - -$result = $locale->listCountriesEU(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-php/examples/locale/list-countries-phones.md deleted file mode 100644 index 1d99f674d6..0000000000 --- a/docs/examples/1.6.x/server-php/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Locale; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$locale = new Locale($client); - -$result = $locale->listCountriesPhones(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-countries.md b/docs/examples/1.6.x/server-php/examples/locale/list-countries.md deleted file mode 100644 index 665dd097c6..0000000000 --- a/docs/examples/1.6.x/server-php/examples/locale/list-countries.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Locale; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$locale = new Locale($client); - -$result = $locale->listCountries(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-php/examples/locale/list-currencies.md deleted file mode 100644 index 5cd91dea81..0000000000 --- a/docs/examples/1.6.x/server-php/examples/locale/list-currencies.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Locale; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$locale = new Locale($client); - -$result = $locale->listCurrencies(); diff --git a/docs/examples/1.6.x/server-php/examples/locale/list-languages.md b/docs/examples/1.6.x/server-php/examples/locale/list-languages.md deleted file mode 100644 index c615a3d1dc..0000000000 --- a/docs/examples/1.6.x/server-php/examples/locale/list-languages.md +++ /dev/null @@ -1,13 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Locale; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$locale = new Locale($client); - -$result = $locale->listLanguages(); diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-apns-provider.md deleted file mode 100644 index ebe69e9516..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createApnsProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - authKey: '<AUTH_KEY>', // optional - authKeyId: '<AUTH_KEY_ID>', // optional - teamId: '<TEAM_ID>', // optional - bundleId: '<BUNDLE_ID>', // optional - sandbox: false, // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-email.md b/docs/examples/1.6.x/server-php/examples/messaging/create-email.md deleted file mode 100644 index b24e4f29fe..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-email.md +++ /dev/null @@ -1,26 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createEmail( - messageId: '<MESSAGE_ID>', - subject: '<SUBJECT>', - content: '<CONTENT>', - topics: [], // optional - users: [], // optional - targets: [], // optional - cc: [], // optional - bcc: [], // optional - attachments: [], // optional - draft: false, // optional - html: false, // optional - scheduledAt: '' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-fcm-provider.md deleted file mode 100644 index b0cfec494f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createFcmProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - serviceAccountJSON: [], // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index bd3bcf8576..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,24 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createMailgunProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - apiKey: '<API_KEY>', // optional - domain: '<DOMAIN>', // optional - isEuRegion: false, // optional - fromName: '<FROM_NAME>', // optional - fromEmail: 'email@example.com', // optional - replyToName: '<REPLY_TO_NAME>', // optional - replyToEmail: 'email@example.com', // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-msg91provider.md deleted file mode 100644 index da377168fa..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createMsg91Provider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - templateId: '<TEMPLATE_ID>', // optional - senderId: '<SENDER_ID>', // optional - authKey: '<AUTH_KEY>', // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-push.md b/docs/examples/1.6.x/server-php/examples/messaging/create-push.md deleted file mode 100644 index 7273f0300b..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-push.md +++ /dev/null @@ -1,30 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createPush( - messageId: '<MESSAGE_ID>', - title: '<TITLE>', - body: '<BODY>', - topics: [], // optional - users: [], // optional - targets: [], // optional - data: [], // optional - action: '<ACTION>', // optional - image: '[ID1:ID2]', // optional - icon: '<ICON>', // optional - sound: '<SOUND>', // optional - color: '<COLOR>', // optional - tag: '<TAG>', // optional - badge: '<BADGE>', // optional - draft: false, // optional - scheduledAt: '' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index 42764a913e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createSendgridProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - apiKey: '<API_KEY>', // optional - fromName: '<FROM_NAME>', // optional - fromEmail: 'email@example.com', // optional - replyToName: '<REPLY_TO_NAME>', // optional - replyToEmail: 'email@example.com', // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-php/examples/messaging/create-sms.md deleted file mode 100644 index 36fce84b10..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-sms.md +++ /dev/null @@ -1,21 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createSms( - messageId: '<MESSAGE_ID>', - content: '<CONTENT>', - topics: [], // optional - users: [], // optional - targets: [], // optional - draft: false, // optional - scheduledAt: '' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-smtp-provider.md deleted file mode 100644 index ff8cfe0a68..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createSmtpProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - host: '<HOST>', - port: 1, // optional - username: '<USERNAME>', // optional - password: '<PASSWORD>', // optional - encryption: SmtpEncryption::NONE(), // optional - autoTLS: false, // optional - mailer: '<MAILER>', // optional - fromName: '<FROM_NAME>', // optional - fromEmail: 'email@example.com', // optional - replyToName: '<REPLY_TO_NAME>', // optional - replyToEmail: 'email@example.com', // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-php/examples/messaging/create-subscriber.md deleted file mode 100644 index bfba263472..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setJWT('<YOUR_JWT>'); // Your secret JSON Web Token - -$messaging = new Messaging($client); - -$result = $messaging->createSubscriber( - topicId: '<TOPIC_ID>', - subscriberId: '<SUBSCRIBER_ID>', - targetId: '<TARGET_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-telesign-provider.md deleted file mode 100644 index ec3ede7b15..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createTelesignProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', // optional - customerId: '<CUSTOMER_ID>', // optional - apiKey: '<API_KEY>', // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index 5dc00f8acc..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createTextmagicProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', // optional - username: '<USERNAME>', // optional - apiKey: '<API_KEY>', // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-php/examples/messaging/create-topic.md deleted file mode 100644 index dd0daf12c6..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-topic.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createTopic( - topicId: '<TOPIC_ID>', - name: '<NAME>', - subscribe: ["any"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-twilio-provider.md deleted file mode 100644 index 70a1d38ae5..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createTwilioProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', // optional - accountSid: '<ACCOUNT_SID>', // optional - authToken: '<AUTH_TOKEN>', // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/create-vonage-provider.md deleted file mode 100644 index d6a4e11e90..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->createVonageProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', // optional - apiKey: '<API_KEY>', // optional - apiSecret: '<API_SECRET>', // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/delete-provider.md deleted file mode 100644 index 4f267fefcb..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/delete-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->deleteProvider( - providerId: '<PROVIDER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-php/examples/messaging/delete-subscriber.md deleted file mode 100644 index 2f91487c2d..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setJWT('<YOUR_JWT>'); // Your secret JSON Web Token - -$messaging = new Messaging($client); - -$result = $messaging->deleteSubscriber( - topicId: '<TOPIC_ID>', - subscriberId: '<SUBSCRIBER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-php/examples/messaging/delete-topic.md deleted file mode 100644 index 79dca2c6ed..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/delete-topic.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->deleteTopic( - topicId: '<TOPIC_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/delete.md b/docs/examples/1.6.x/server-php/examples/messaging/delete.md deleted file mode 100644 index b0676ec269..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/delete.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->delete( - messageId: '<MESSAGE_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/get-message.md b/docs/examples/1.6.x/server-php/examples/messaging/get-message.md deleted file mode 100644 index 9ec7a0ed83..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/get-message.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->getMessage( - messageId: '<MESSAGE_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/get-provider.md deleted file mode 100644 index 378fc6db6e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/get-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->getProvider( - providerId: '<PROVIDER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-php/examples/messaging/get-subscriber.md deleted file mode 100644 index a10974a6d1..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->getSubscriber( - topicId: '<TOPIC_ID>', - subscriberId: '<SUBSCRIBER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-php/examples/messaging/get-topic.md deleted file mode 100644 index cb42254f04..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/get-topic.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->getTopic( - topicId: '<TOPIC_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-php/examples/messaging/list-message-logs.md deleted file mode 100644 index d66d5466fb..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->listMessageLogs( - messageId: '<MESSAGE_ID>', - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-php/examples/messaging/list-messages.md deleted file mode 100644 index c0f54a635e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/list-messages.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->listMessages( - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-php/examples/messaging/list-provider-logs.md deleted file mode 100644 index 865daf9eb1..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->listProviderLogs( - providerId: '<PROVIDER_ID>', - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-php/examples/messaging/list-providers.md deleted file mode 100644 index fd30837406..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/list-providers.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->listProviders( - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-php/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index b69c057491..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->listSubscriberLogs( - subscriberId: '<SUBSCRIBER_ID>', - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-php/examples/messaging/list-subscribers.md deleted file mode 100644 index 2fd274704c..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->listSubscribers( - topicId: '<TOPIC_ID>', - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-php/examples/messaging/list-targets.md deleted file mode 100644 index 3abb9ef70a..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/list-targets.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->listTargets( - messageId: '<MESSAGE_ID>', - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-php/examples/messaging/list-topic-logs.md deleted file mode 100644 index 0d23c828ae..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->listTopicLogs( - topicId: '<TOPIC_ID>', - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-php/examples/messaging/list-topics.md deleted file mode 100644 index 008767e5b1..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/list-topics.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->listTopics( - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-apns-provider.md deleted file mode 100644 index a368ce5312..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateApnsProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // optional - enabled: false, // optional - authKey: '<AUTH_KEY>', // optional - authKeyId: '<AUTH_KEY_ID>', // optional - teamId: '<TEAM_ID>', // optional - bundleId: '<BUNDLE_ID>', // optional - sandbox: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-email.md b/docs/examples/1.6.x/server-php/examples/messaging/update-email.md deleted file mode 100644 index 537ca82e42..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-email.md +++ /dev/null @@ -1,26 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateEmail( - messageId: '<MESSAGE_ID>', - topics: [], // optional - users: [], // optional - targets: [], // optional - subject: '<SUBJECT>', // optional - content: '<CONTENT>', // optional - draft: false, // optional - html: false, // optional - cc: [], // optional - bcc: [], // optional - scheduledAt: '', // optional - attachments: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-fcm-provider.md deleted file mode 100644 index d8b2a0e487..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateFcmProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // optional - enabled: false, // optional - serviceAccountJSON: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index d838adb7c8..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,24 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateMailgunProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // optional - apiKey: '<API_KEY>', // optional - domain: '<DOMAIN>', // optional - isEuRegion: false, // optional - enabled: false, // optional - fromName: '<FROM_NAME>', // optional - fromEmail: 'email@example.com', // optional - replyToName: '<REPLY_TO_NAME>', // optional - replyToEmail: '<REPLY_TO_EMAIL>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-msg91provider.md deleted file mode 100644 index eb681023ca..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateMsg91Provider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // optional - enabled: false, // optional - templateId: '<TEMPLATE_ID>', // optional - senderId: '<SENDER_ID>', // optional - authKey: '<AUTH_KEY>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-push.md b/docs/examples/1.6.x/server-php/examples/messaging/update-push.md deleted file mode 100644 index b332ec194f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-push.md +++ /dev/null @@ -1,30 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updatePush( - messageId: '<MESSAGE_ID>', - topics: [], // optional - users: [], // optional - targets: [], // optional - title: '<TITLE>', // optional - body: '<BODY>', // optional - data: [], // optional - action: '<ACTION>', // optional - image: '[ID1:ID2]', // optional - icon: '<ICON>', // optional - sound: '<SOUND>', // optional - color: '<COLOR>', // optional - tag: '<TAG>', // optional - badge: null, // optional - draft: false, // optional - scheduledAt: '' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index 7909fef6ac..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateSendgridProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // optional - enabled: false, // optional - apiKey: '<API_KEY>', // optional - fromName: '<FROM_NAME>', // optional - fromEmail: 'email@example.com', // optional - replyToName: '<REPLY_TO_NAME>', // optional - replyToEmail: '<REPLY_TO_EMAIL>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-php/examples/messaging/update-sms.md deleted file mode 100644 index a4b4c23f2b..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-sms.md +++ /dev/null @@ -1,21 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateSms( - messageId: '<MESSAGE_ID>', - topics: [], // optional - users: [], // optional - targets: [], // optional - content: '<CONTENT>', // optional - draft: false, // optional - scheduledAt: '' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-smtp-provider.md deleted file mode 100644 index 997914f06e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,28 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateSmtpProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // optional - host: '<HOST>', // optional - port: 1, // optional - username: '<USERNAME>', // optional - password: '<PASSWORD>', // optional - encryption: SmtpEncryption::NONE(), // optional - autoTLS: false, // optional - mailer: '<MAILER>', // optional - fromName: '<FROM_NAME>', // optional - fromEmail: 'email@example.com', // optional - replyToName: '<REPLY_TO_NAME>', // optional - replyToEmail: '<REPLY_TO_EMAIL>', // optional - enabled: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-telesign-provider.md deleted file mode 100644 index 981df0cedd..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateTelesignProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // optional - enabled: false, // optional - customerId: '<CUSTOMER_ID>', // optional - apiKey: '<API_KEY>', // optional - from: '<FROM>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index b7f9bab582..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateTextmagicProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // optional - enabled: false, // optional - username: '<USERNAME>', // optional - apiKey: '<API_KEY>', // optional - from: '<FROM>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-php/examples/messaging/update-topic.md deleted file mode 100644 index e705c1b727..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-topic.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateTopic( - topicId: '<TOPIC_ID>', - name: '<NAME>', // optional - subscribe: ["any"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-twilio-provider.md deleted file mode 100644 index 05c2072a43..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateTwilioProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // optional - enabled: false, // optional - accountSid: '<ACCOUNT_SID>', // optional - authToken: '<AUTH_TOKEN>', // optional - from: '<FROM>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-php/examples/messaging/update-vonage-provider.md deleted file mode 100644 index 3c421af9d0..0000000000 --- a/docs/examples/1.6.x/server-php/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Messaging; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$messaging = new Messaging($client); - -$result = $messaging->updateVonageProvider( - providerId: '<PROVIDER_ID>', - name: '<NAME>', // optional - enabled: false, // optional - apiKey: '<API_KEY>', // optional - apiSecret: '<API_SECRET>', // optional - from: '<FROM>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-php/examples/storage/create-bucket.md deleted file mode 100644 index ca369fbdc5..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/create-bucket.md +++ /dev/null @@ -1,24 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$storage = new Storage($client); - -$result = $storage->createBucket( - bucketId: '<BUCKET_ID>', - name: '<NAME>', - permissions: ["read("any")"], // optional - fileSecurity: false, // optional - enabled: false, // optional - maximumFileSize: 1, // optional - allowedFileExtensions: [], // optional - compression: ::NONE(), // optional - encryption: false, // optional - antivirus: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/create-file.md b/docs/examples/1.6.x/server-php/examples/storage/create-file.md deleted file mode 100644 index 20a25e7641..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/create-file.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\InputFile; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$storage = new Storage($client); - -$result = $storage->createFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', - file: InputFile::withPath('file.png'), - permissions: ["read("any")"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-php/examples/storage/delete-bucket.md deleted file mode 100644 index a9207f4e4c..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/delete-bucket.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$storage = new Storage($client); - -$result = $storage->deleteBucket( - bucketId: '<BUCKET_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/delete-file.md b/docs/examples/1.6.x/server-php/examples/storage/delete-file.md deleted file mode 100644 index 47f9938b66..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/delete-file.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$storage = new Storage($client); - -$result = $storage->deleteFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-php/examples/storage/get-bucket.md deleted file mode 100644 index 5faf6a6c74..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/get-bucket.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$storage = new Storage($client); - -$result = $storage->getBucket( - bucketId: '<BUCKET_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-php/examples/storage/get-file-download.md deleted file mode 100644 index 48ee5ada02..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/get-file-download.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$storage = new Storage($client); - -$result = $storage->getFileDownload( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-php/examples/storage/get-file-preview.md deleted file mode 100644 index 4f37f386a8..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/get-file-preview.md +++ /dev/null @@ -1,27 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$storage = new Storage($client); - -$result = $storage->getFilePreview( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', - width: 0, // optional - height: 0, // optional - gravity: ImageGravity::CENTER(), // optional - quality: 0, // optional - borderWidth: 0, // optional - borderColor: '', // optional - borderRadius: 0, // optional - opacity: 0, // optional - rotation: -360, // optional - background: '', // optional - output: ImageFormat::JPG() // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-php/examples/storage/get-file-view.md deleted file mode 100644 index 5637fa88bd..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/get-file-view.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$storage = new Storage($client); - -$result = $storage->getFileView( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/get-file.md b/docs/examples/1.6.x/server-php/examples/storage/get-file.md deleted file mode 100644 index 41fdc91c55..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/get-file.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$storage = new Storage($client); - -$result = $storage->getFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-php/examples/storage/list-buckets.md deleted file mode 100644 index 7a988c2b4f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/list-buckets.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$storage = new Storage($client); - -$result = $storage->listBuckets( - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/list-files.md b/docs/examples/1.6.x/server-php/examples/storage/list-files.md deleted file mode 100644 index 038b2cd556..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/list-files.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$storage = new Storage($client); - -$result = $storage->listFiles( - bucketId: '<BUCKET_ID>', - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-php/examples/storage/update-bucket.md deleted file mode 100644 index 96bf127bdf..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/update-bucket.md +++ /dev/null @@ -1,24 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$storage = new Storage($client); - -$result = $storage->updateBucket( - bucketId: '<BUCKET_ID>', - name: '<NAME>', - permissions: ["read("any")"], // optional - fileSecurity: false, // optional - enabled: false, // optional - maximumFileSize: 1, // optional - allowedFileExtensions: [], // optional - compression: ::NONE(), // optional - encryption: false, // optional - antivirus: false // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/storage/update-file.md b/docs/examples/1.6.x/server-php/examples/storage/update-file.md deleted file mode 100644 index 0ddc6d5546..0000000000 --- a/docs/examples/1.6.x/server-php/examples/storage/update-file.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Storage; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$storage = new Storage($client); - -$result = $storage->updateFile( - bucketId: '<BUCKET_ID>', - fileId: '<FILE_ID>', - name: '<NAME>', // optional - permissions: ["read("any")"] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/create-membership.md b/docs/examples/1.6.x/server-php/examples/teams/create-membership.md deleted file mode 100644 index 061b906bc8..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/create-membership.md +++ /dev/null @@ -1,21 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->createMembership( - teamId: '<TEAM_ID>', - roles: [], - email: 'email@example.com', // optional - userId: '<USER_ID>', // optional - phone: '+12065550100', // optional - url: 'https://example.com', // optional - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/create.md b/docs/examples/1.6.x/server-php/examples/teams/create.md deleted file mode 100644 index 5475bdf384..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/create.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->create( - teamId: '<TEAM_ID>', - name: '<NAME>', - roles: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-php/examples/teams/delete-membership.md deleted file mode 100644 index 15ced8944e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/delete-membership.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->deleteMembership( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/delete.md b/docs/examples/1.6.x/server-php/examples/teams/delete.md deleted file mode 100644 index 98224f7a5f..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/delete.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->delete( - teamId: '<TEAM_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/get-membership.md b/docs/examples/1.6.x/server-php/examples/teams/get-membership.md deleted file mode 100644 index f27ee3af5a..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/get-membership.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->getMembership( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-php/examples/teams/get-prefs.md deleted file mode 100644 index 932777a563..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/get-prefs.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->getPrefs( - teamId: '<TEAM_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/get.md b/docs/examples/1.6.x/server-php/examples/teams/get.md deleted file mode 100644 index 21320eeb8d..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/get.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->get( - teamId: '<TEAM_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-php/examples/teams/list-memberships.md deleted file mode 100644 index 440553c2e0..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/list-memberships.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->listMemberships( - teamId: '<TEAM_ID>', - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/list.md b/docs/examples/1.6.x/server-php/examples/teams/list.md deleted file mode 100644 index 761b6c216c..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/list.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->list( - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-php/examples/teams/update-membership-status.md deleted file mode 100644 index 3c7924581a..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/update-membership-status.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->updateMembershipStatus( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>', - userId: '<USER_ID>', - secret: '<SECRET>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/update-membership.md b/docs/examples/1.6.x/server-php/examples/teams/update-membership.md deleted file mode 100644 index 438f3540b8..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/update-membership.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->updateMembership( - teamId: '<TEAM_ID>', - membershipId: '<MEMBERSHIP_ID>', - roles: [] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/update-name.md b/docs/examples/1.6.x/server-php/examples/teams/update-name.md deleted file mode 100644 index cd1f38fd7d..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/update-name.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->updateName( - teamId: '<TEAM_ID>', - name: '<NAME>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-php/examples/teams/update-prefs.md deleted file mode 100644 index 0dadd2c39e..0000000000 --- a/docs/examples/1.6.x/server-php/examples/teams/update-prefs.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Teams; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setSession(''); // The user session to authenticate with - -$teams = new Teams($client); - -$result = $teams->updatePrefs( - teamId: '<TEAM_ID>', - prefs: [] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-php/examples/users/create-argon2user.md deleted file mode 100644 index 7bee3bc6cb..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-argon2user.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createArgon2User( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-php/examples/users/create-bcrypt-user.md deleted file mode 100644 index 631e4ccdd3..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createBcryptUser( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-php/examples/users/create-j-w-t.md deleted file mode 100644 index 2f0bc3775b..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-j-w-t.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createJWT( - userId: '<USER_ID>', - sessionId: '<SESSION_ID>', // optional - duration: 0 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-php/examples/users/create-m-d5user.md deleted file mode 100644 index 0605f6f927..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-m-d5user.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createMD5User( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index f499b22d36..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createMfaRecoveryCodes( - userId: '<USER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-php/examples/users/create-p-h-pass-user.md deleted file mode 100644 index f6dc863452..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,18 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createPHPassUser( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-php/examples/users/create-s-h-a-user.md deleted file mode 100644 index 777096d822..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createSHAUser( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - passwordVersion: PasswordHash::SHA1(), // optional - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-php/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index 4f8423ff76..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,21 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createScryptModifiedUser( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - passwordSalt: '<PASSWORD_SALT>', - passwordSaltSeparator: '<PASSWORD_SALT_SEPARATOR>', - passwordSignerKey: '<PASSWORD_SIGNER_KEY>', - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-php/examples/users/create-scrypt-user.md deleted file mode 100644 index 2ccc5d7329..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,23 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createScryptUser( - userId: '<USER_ID>', - email: 'email@example.com', - password: 'password', - passwordSalt: '<PASSWORD_SALT>', - passwordCpu: null, - passwordMemory: null, - passwordParallel: null, - passwordLength: null, - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-session.md b/docs/examples/1.6.x/server-php/examples/users/create-session.md deleted file mode 100644 index 97d8c8aa89..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-session.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createSession( - userId: '<USER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-target.md b/docs/examples/1.6.x/server-php/examples/users/create-target.md deleted file mode 100644 index 03104bc83a..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-target.md +++ /dev/null @@ -1,21 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; -use Appwrite\Enums\MessagingProviderType; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createTarget( - userId: '<USER_ID>', - targetId: '<TARGET_ID>', - providerType: MessagingProviderType::EMAIL(), - identifier: '<IDENTIFIER>', - providerId: '<PROVIDER_ID>', // optional - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create-token.md b/docs/examples/1.6.x/server-php/examples/users/create-token.md deleted file mode 100644 index b08faacd14..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create-token.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->createToken( - userId: '<USER_ID>', - length: 4, // optional - expire: 60 // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/create.md b/docs/examples/1.6.x/server-php/examples/users/create.md deleted file mode 100644 index a50e10e6c9..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/create.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->create( - userId: '<USER_ID>', - email: 'email@example.com', // optional - phone: '+12065550100', // optional - password: '', // optional - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete-identity.md b/docs/examples/1.6.x/server-php/examples/users/delete-identity.md deleted file mode 100644 index 138b89f97d..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/delete-identity.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->deleteIdentity( - identityId: '<IDENTITY_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-php/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index d25c2b72b9..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,17 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; -use Appwrite\Enums\AuthenticatorType; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->deleteMfaAuthenticator( - userId: '<USER_ID>', - type: AuthenticatorType::TOTP() -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete-session.md b/docs/examples/1.6.x/server-php/examples/users/delete-session.md deleted file mode 100644 index bf673b22ca..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/delete-session.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->deleteSession( - userId: '<USER_ID>', - sessionId: '<SESSION_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-php/examples/users/delete-sessions.md deleted file mode 100644 index f2a3f21d43..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/delete-sessions.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->deleteSessions( - userId: '<USER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete-target.md b/docs/examples/1.6.x/server-php/examples/users/delete-target.md deleted file mode 100644 index 20e676a983..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/delete-target.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->deleteTarget( - userId: '<USER_ID>', - targetId: '<TARGET_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/delete.md b/docs/examples/1.6.x/server-php/examples/users/delete.md deleted file mode 100644 index 225708c2b2..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/delete.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->delete( - userId: '<USER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index 055ef04564..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->getMfaRecoveryCodes( - userId: '<USER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/get-prefs.md b/docs/examples/1.6.x/server-php/examples/users/get-prefs.md deleted file mode 100644 index 392dc14937..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/get-prefs.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->getPrefs( - userId: '<USER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/get-target.md b/docs/examples/1.6.x/server-php/examples/users/get-target.md deleted file mode 100644 index 7ca05d3547..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/get-target.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->getTarget( - userId: '<USER_ID>', - targetId: '<TARGET_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/get.md b/docs/examples/1.6.x/server-php/examples/users/get.md deleted file mode 100644 index 1cc351adf3..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/get.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->get( - userId: '<USER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-identities.md b/docs/examples/1.6.x/server-php/examples/users/list-identities.md deleted file mode 100644 index 040e309b18..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/list-identities.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->listIdentities( - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-logs.md b/docs/examples/1.6.x/server-php/examples/users/list-logs.md deleted file mode 100644 index e717bdf9cd..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/list-logs.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->listLogs( - userId: '<USER_ID>', - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-memberships.md b/docs/examples/1.6.x/server-php/examples/users/list-memberships.md deleted file mode 100644 index da760e0736..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/list-memberships.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->listMemberships( - userId: '<USER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-php/examples/users/list-mfa-factors.md deleted file mode 100644 index 16964c5c0c..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->listMfaFactors( - userId: '<USER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-sessions.md b/docs/examples/1.6.x/server-php/examples/users/list-sessions.md deleted file mode 100644 index 0bfa2420fc..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/list-sessions.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->listSessions( - userId: '<USER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list-targets.md b/docs/examples/1.6.x/server-php/examples/users/list-targets.md deleted file mode 100644 index c4815be792..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/list-targets.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->listTargets( - userId: '<USER_ID>', - queries: [] // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/list.md b/docs/examples/1.6.x/server-php/examples/users/list.md deleted file mode 100644 index 678e97fc6b..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/list.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->list( - queries: [], // optional - search: '<SEARCH>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-php/examples/users/update-email-verification.md deleted file mode 100644 index d2d6584f84..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-email-verification.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updateEmailVerification( - userId: '<USER_ID>', - emailVerification: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-email.md b/docs/examples/1.6.x/server-php/examples/users/update-email.md deleted file mode 100644 index a73100c18d..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-email.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updateEmail( - userId: '<USER_ID>', - email: 'email@example.com' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-labels.md b/docs/examples/1.6.x/server-php/examples/users/update-labels.md deleted file mode 100644 index 965183060b..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-labels.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updateLabels( - userId: '<USER_ID>', - labels: [] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-php/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index d09ccd7dde..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,15 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updateMfaRecoveryCodes( - userId: '<USER_ID>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-mfa.md b/docs/examples/1.6.x/server-php/examples/users/update-mfa.md deleted file mode 100644 index 5ab48c5308..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-mfa.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updateMfa( - userId: '<USER_ID>', - mfa: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-name.md b/docs/examples/1.6.x/server-php/examples/users/update-name.md deleted file mode 100644 index 96e8afcecb..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-name.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updateName( - userId: '<USER_ID>', - name: '<NAME>' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-password.md b/docs/examples/1.6.x/server-php/examples/users/update-password.md deleted file mode 100644 index ffcb81725d..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-password.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updatePassword( - userId: '<USER_ID>', - password: '' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-php/examples/users/update-phone-verification.md deleted file mode 100644 index 80545314a1..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-phone-verification.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updatePhoneVerification( - userId: '<USER_ID>', - phoneVerification: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-phone.md b/docs/examples/1.6.x/server-php/examples/users/update-phone.md deleted file mode 100644 index 5828633919..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-phone.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updatePhone( - userId: '<USER_ID>', - number: '+12065550100' -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-prefs.md b/docs/examples/1.6.x/server-php/examples/users/update-prefs.md deleted file mode 100644 index 6d0ecade88..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-prefs.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updatePrefs( - userId: '<USER_ID>', - prefs: [] -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-status.md b/docs/examples/1.6.x/server-php/examples/users/update-status.md deleted file mode 100644 index 7ffbfc2be8..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-status.md +++ /dev/null @@ -1,16 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updateStatus( - userId: '<USER_ID>', - status: false -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-php/examples/users/update-target.md b/docs/examples/1.6.x/server-php/examples/users/update-target.md deleted file mode 100644 index 5c476db0e3..0000000000 --- a/docs/examples/1.6.x/server-php/examples/users/update-target.md +++ /dev/null @@ -1,19 +0,0 @@ -<?php - -use Appwrite\Client; -use Appwrite\Services\Users; - -$client = (new Client()) - ->setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('<YOUR_PROJECT_ID>') // Your project ID - ->setKey('<YOUR_API_KEY>'); // Your secret API key - -$users = new Users($client); - -$result = $users->updateTarget( - userId: '<USER_ID>', - targetId: '<TARGET_ID>', - identifier: '<IDENTIFIER>', // optional - providerId: '<PROVIDER_ID>', // optional - name: '<NAME>' // optional -); \ No newline at end of file diff --git a/docs/examples/1.6.x/server-python/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-python/examples/account/create-anonymous-session.md deleted file mode 100644 index a8d0cd5f40..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,9 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.create_anonymous_session() diff --git a/docs/examples/1.6.x/server-python/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-python/examples/account/create-email-password-session.md deleted file mode 100644 index 1e9233c65f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-email-password-session.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.create_email_password_session( - email = 'email@example.com', - password = 'password' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-email-token.md b/docs/examples/1.6.x/server-python/examples/account/create-email-token.md deleted file mode 100644 index 6700b12e17..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-email-token.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.create_email_token( - user_id = '<USER_ID>', - email = 'email@example.com', - phrase = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-python/examples/account/create-j-w-t.md deleted file mode 100644 index 182c49d2a4..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-j-w-t.md +++ /dev/null @@ -1,9 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.create_jwt() diff --git a/docs/examples/1.6.x/server-python/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-python/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 8380de3df0..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.create_magic_url_token( - user_id = '<USER_ID>', - email = 'email@example.com', - url = 'https://example.com', # optional - phrase = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-python/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 14b16de009..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import AuthenticatorType - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.create_mfa_authenticator( - type = AuthenticatorType.TOTP -) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-python/examples/account/create-mfa-challenge.md deleted file mode 100644 index 1edb1edccf..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import AuthenticationFactor - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.create_mfa_challenge( - factor = AuthenticationFactor.EMAIL -) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index f6bf7eda1f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.create_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-python/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-python/examples/account/create-o-auth2token.md deleted file mode 100644 index 84438a39c6..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import OAuthProvider - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.create_o_auth2_token( - provider = OAuthProvider.AMAZON, - success = 'https://example.com', # optional - failure = 'https://example.com', # optional - scopes = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-python/examples/account/create-phone-token.md deleted file mode 100644 index 8542457a8b..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-phone-token.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.create_phone_token( - user_id = '<USER_ID>', - phone = '+12065550100' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-python/examples/account/create-phone-verification.md deleted file mode 100644 index dd28e346aa..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-phone-verification.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.create_phone_verification() diff --git a/docs/examples/1.6.x/server-python/examples/account/create-recovery.md b/docs/examples/1.6.x/server-python/examples/account/create-recovery.md deleted file mode 100644 index e2822a44e0..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-recovery.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.create_recovery( - email = 'email@example.com', - url = 'https://example.com' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-session.md b/docs/examples/1.6.x/server-python/examples/account/create-session.md deleted file mode 100644 index d4e31c13c6..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-session.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.create_session( - user_id = '<USER_ID>', - secret = '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/create-verification.md b/docs/examples/1.6.x/server-python/examples/account/create-verification.md deleted file mode 100644 index a671d9deeb..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.create_verification( - url = 'https://example.com' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/create.md b/docs/examples/1.6.x/server-python/examples/account/create.md deleted file mode 100644 index 226c5c757b..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/create.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.create( - user_id = '<USER_ID>', - email = 'email@example.com', - password = '', - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/account/delete-identity.md b/docs/examples/1.6.x/server-python/examples/account/delete-identity.md deleted file mode 100644 index 7029c3543d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/delete-identity.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.delete_identity( - identity_id = '<IDENTITY_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-python/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 138e36df99..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import AuthenticatorType - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.delete_mfa_authenticator( - type = AuthenticatorType.TOTP -) diff --git a/docs/examples/1.6.x/server-python/examples/account/delete-session.md b/docs/examples/1.6.x/server-python/examples/account/delete-session.md deleted file mode 100644 index 091eca84d5..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/delete-session.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.delete_session( - session_id = '<SESSION_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-python/examples/account/delete-sessions.md deleted file mode 100644 index 7c64d6666e..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/delete-sessions.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.delete_sessions() diff --git a/docs/examples/1.6.x/server-python/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index 39137c7874..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.get_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-python/examples/account/get-prefs.md b/docs/examples/1.6.x/server-python/examples/account/get-prefs.md deleted file mode 100644 index 67db03a8f6..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/get-prefs.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.get_prefs() diff --git a/docs/examples/1.6.x/server-python/examples/account/get-session.md b/docs/examples/1.6.x/server-python/examples/account/get-session.md deleted file mode 100644 index 926279941d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/get-session.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.get_session( - session_id = '<SESSION_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/get.md b/docs/examples/1.6.x/server-python/examples/account/get.md deleted file mode 100644 index 1b4c8febca..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/get.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.get() diff --git a/docs/examples/1.6.x/server-python/examples/account/list-identities.md b/docs/examples/1.6.x/server-python/examples/account/list-identities.md deleted file mode 100644 index ed163b38cf..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/list-identities.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.list_identities( - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/account/list-logs.md b/docs/examples/1.6.x/server-python/examples/account/list-logs.md deleted file mode 100644 index ca2fcfadce..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/list-logs.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.list_logs( - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-python/examples/account/list-mfa-factors.md deleted file mode 100644 index 1d09d979eb..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.list_mfa_factors() diff --git a/docs/examples/1.6.x/server-python/examples/account/list-sessions.md b/docs/examples/1.6.x/server-python/examples/account/list-sessions.md deleted file mode 100644 index 936b11b27d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/list-sessions.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.list_sessions() diff --git a/docs/examples/1.6.x/server-python/examples/account/update-email.md b/docs/examples/1.6.x/server-python/examples/account/update-email.md deleted file mode 100644 index 5cec58c15a..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-email.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_email( - email = 'email@example.com', - password = 'password' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-python/examples/account/update-m-f-a.md deleted file mode 100644 index 821a549cd1..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-m-f-a.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_mfa( - mfa = False -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-python/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 0cd8fc626a..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.update_magic_url_session( - user_id = '<USER_ID>', - secret = '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-python/examples/account/update-mfa-authenticator.md deleted file mode 100644 index e980538053..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import AuthenticatorType - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_mfa_authenticator( - type = AuthenticatorType.TOTP, - otp = '<OTP>' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-python/examples/account/update-mfa-challenge.md deleted file mode 100644 index 3bce7f3604..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_mfa_challenge( - challenge_id = '<CHALLENGE_ID>', - otp = '<OTP>' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index fd9863367c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-python/examples/account/update-name.md b/docs/examples/1.6.x/server-python/examples/account/update-name.md deleted file mode 100644 index 2ff8454dc5..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-name.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_name( - name = '<NAME>' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-password.md b/docs/examples/1.6.x/server-python/examples/account/update-password.md deleted file mode 100644 index e6c9554bd4..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-password.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_password( - password = '', - old_password = 'password' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-python/examples/account/update-phone-session.md deleted file mode 100644 index d4a35d8d3d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-phone-session.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account(client) - -result = account.update_phone_session( - user_id = '<USER_ID>', - secret = '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-python/examples/account/update-phone-verification.md deleted file mode 100644 index 0f9db88f45..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_phone_verification( - user_id = '<USER_ID>', - secret = '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-phone.md b/docs/examples/1.6.x/server-python/examples/account/update-phone.md deleted file mode 100644 index 540b09a7c3..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-phone.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_phone( - phone = '+12065550100', - password = 'password' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-prefs.md b/docs/examples/1.6.x/server-python/examples/account/update-prefs.md deleted file mode 100644 index 04e4a8f587..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_prefs( - prefs = {} -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-recovery.md b/docs/examples/1.6.x/server-python/examples/account/update-recovery.md deleted file mode 100644 index 4ff91d4ee5..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_recovery( - user_id = '<USER_ID>', - secret = '<SECRET>', - password = '' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-session.md b/docs/examples/1.6.x/server-python/examples/account/update-session.md deleted file mode 100644 index 289cb65725..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-session.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_session( - session_id = '<SESSION_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/account/update-status.md b/docs/examples/1.6.x/server-python/examples/account/update-status.md deleted file mode 100644 index 8bf6914835..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-status.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_status() diff --git a/docs/examples/1.6.x/server-python/examples/account/update-verification.md b/docs/examples/1.6.x/server-python/examples/account/update-verification.md deleted file mode 100644 index ed2d77ab5b..0000000000 --- a/docs/examples/1.6.x/server-python/examples/account/update-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -account = Account(client) - -result = account.update_verification( - user_id = '<USER_ID>', - secret = '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-python/examples/avatars/get-browser.md deleted file mode 100644 index 3301776672..0000000000 --- a/docs/examples/1.6.x/server-python/examples/avatars/get-browser.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import Browser - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -avatars = Avatars(client) - -result = avatars.get_browser( - code = Browser.AVANT_BROWSER, - width = 0, # optional - height = 0, # optional - quality = 0 # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-python/examples/avatars/get-credit-card.md deleted file mode 100644 index da81afc4a7..0000000000 --- a/docs/examples/1.6.x/server-python/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import CreditCard - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -avatars = Avatars(client) - -result = avatars.get_credit_card( - code = CreditCard.AMERICAN_EXPRESS, - width = 0, # optional - height = 0, # optional - quality = 0 # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-python/examples/avatars/get-favicon.md deleted file mode 100644 index edffdef219..0000000000 --- a/docs/examples/1.6.x/server-python/examples/avatars/get-favicon.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -avatars = Avatars(client) - -result = avatars.get_favicon( - url = 'https://example.com' -) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-python/examples/avatars/get-flag.md deleted file mode 100644 index a1c07e247c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/avatars/get-flag.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import Flag - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -avatars = Avatars(client) - -result = avatars.get_flag( - code = Flag.AFGHANISTAN, - width = 0, # optional - height = 0, # optional - quality = 0 # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-image.md b/docs/examples/1.6.x/server-python/examples/avatars/get-image.md deleted file mode 100644 index 1a4a4c9f0d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/avatars/get-image.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -avatars = Avatars(client) - -result = avatars.get_image( - url = 'https://example.com', - width = 0, # optional - height = 0 # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-python/examples/avatars/get-initials.md deleted file mode 100644 index b443aa4f01..0000000000 --- a/docs/examples/1.6.x/server-python/examples/avatars/get-initials.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -avatars = Avatars(client) - -result = avatars.get_initials( - name = '<NAME>', # optional - width = 0, # optional - height = 0, # optional - background = '' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-python/examples/avatars/get-q-r.md deleted file mode 100644 index 3cb9dcca9f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/avatars/get-q-r.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -avatars = Avatars(client) - -result = avatars.get_qr( - text = '<TEXT>', - size = 1, # optional - margin = 0, # optional - download = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-boolean-attribute.md deleted file mode 100644 index 2611488b95..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_boolean_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - default = False, # optional - array = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-collection.md b/docs/examples/1.6.x/server-python/examples/databases/create-collection.md deleted file mode 100644 index 4950d88b41..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-collection.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_collection( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - name = '<NAME>', - permissions = ["read("any")"], # optional - document_security = False, # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-datetime-attribute.md deleted file mode 100644 index 020d7b6e03..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_datetime_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - default = '', # optional - array = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-document.md b/docs/examples/1.6.x/server-python/examples/databases/create-document.md deleted file mode 100644 index 3b54babaef..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-document.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -databases = Databases(client) - -result = databases.create_document( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - document_id = '<DOCUMENT_ID>', - data = {}, - permissions = ["read("any")"] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-email-attribute.md deleted file mode 100644 index d6cd87db99..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_email_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - default = 'email@example.com', # optional - array = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-enum-attribute.md deleted file mode 100644 index ee2c96e41c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_enum_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - elements = [], - required = False, - default = '<DEFAULT>', # optional - array = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-float-attribute.md deleted file mode 100644 index cce0e70bbc..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_float_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - min = None, # optional - max = None, # optional - default = None, # optional - array = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-index.md b/docs/examples/1.6.x/server-python/examples/databases/create-index.md deleted file mode 100644 index 9e6d16f053..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-index.md +++ /dev/null @@ -1,18 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import IndexType - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_index( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - type = IndexType.KEY, - attributes = [], - orders = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-integer-attribute.md deleted file mode 100644 index 984800f0e6..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_integer_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - min = None, # optional - max = None, # optional - default = None, # optional - array = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-ip-attribute.md deleted file mode 100644 index a27c7d71a1..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_ip_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - default = '', # optional - array = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-relationship-attribute.md deleted file mode 100644 index c62d5cb5c6..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import RelationshipType - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_relationship_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - related_collection_id = '<RELATED_COLLECTION_ID>', - type = RelationshipType.ONETOONE, - two_way = False, # optional - key = '', # optional - two_way_key = '', # optional - on_delete = RelationMutate.CASCADE # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-string-attribute.md deleted file mode 100644 index 06f86f66fe..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_string_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - size = 1, - required = False, - default = '<DEFAULT>', # optional - array = False, # optional - encrypt = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/create-url-attribute.md deleted file mode 100644 index 3b882c58f9..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create_url_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - default = 'https://example.com', # optional - array = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/create.md b/docs/examples/1.6.x/server-python/examples/databases/create.md deleted file mode 100644 index 33e8770cc9..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/create.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.create( - database_id = '<DATABASE_ID>', - name = '<NAME>', - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/delete-attribute.md deleted file mode 100644 index ce454ba867..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/delete-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.delete_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-python/examples/databases/delete-collection.md deleted file mode 100644 index c63bedf105..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/delete-collection.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.delete_collection( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/delete-document.md b/docs/examples/1.6.x/server-python/examples/databases/delete-document.md deleted file mode 100644 index 94afc57839..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/delete-document.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -databases = Databases(client) - -result = databases.delete_document( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - document_id = '<DOCUMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/delete-index.md b/docs/examples/1.6.x/server-python/examples/databases/delete-index.md deleted file mode 100644 index 6890a5590c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/delete-index.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.delete_index( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/delete.md b/docs/examples/1.6.x/server-python/examples/databases/delete.md deleted file mode 100644 index f7506ffa25..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.delete( - database_id = '<DATABASE_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/get-attribute.md deleted file mode 100644 index 3e1d7866a8..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/get-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.get_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/get-collection.md b/docs/examples/1.6.x/server-python/examples/databases/get-collection.md deleted file mode 100644 index 2e2d408e19..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/get-collection.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.get_collection( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/get-document.md b/docs/examples/1.6.x/server-python/examples/databases/get-document.md deleted file mode 100644 index 9c3dfd47bd..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/get-document.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -databases = Databases(client) - -result = databases.get_document( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - document_id = '<DOCUMENT_ID>', - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/get-index.md b/docs/examples/1.6.x/server-python/examples/databases/get-index.md deleted file mode 100644 index 4a9da1da47..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/get-index.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.get_index( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/get.md b/docs/examples/1.6.x/server-python/examples/databases/get.md deleted file mode 100644 index 214e59b4ad..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/get.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.get( - database_id = '<DATABASE_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-python/examples/databases/list-attributes.md deleted file mode 100644 index dfb1463f32..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/list-attributes.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.list_attributes( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/list-collections.md b/docs/examples/1.6.x/server-python/examples/databases/list-collections.md deleted file mode 100644 index b6ea0ae0cc..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/list-collections.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.list_collections( - database_id = '<DATABASE_ID>', - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/list-documents.md b/docs/examples/1.6.x/server-python/examples/databases/list-documents.md deleted file mode 100644 index d167d89d99..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/list-documents.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -databases = Databases(client) - -result = databases.list_documents( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-python/examples/databases/list-indexes.md deleted file mode 100644 index 4699aaef9e..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/list-indexes.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.list_indexes( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/list.md b/docs/examples/1.6.x/server-python/examples/databases/list.md deleted file mode 100644 index 6e8f8ac884..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/list.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.list( - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-boolean-attribute.md deleted file mode 100644 index d28a93a41c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update_boolean_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - default = False -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-collection.md b/docs/examples/1.6.x/server-python/examples/databases/update-collection.md deleted file mode 100644 index 1710df8433..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-collection.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update_collection( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - name = '<NAME>', - permissions = ["read("any")"], # optional - document_security = False, # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-datetime-attribute.md deleted file mode 100644 index 0c3ae96f58..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update_datetime_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - default = '' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-document.md b/docs/examples/1.6.x/server-python/examples/databases/update-document.md deleted file mode 100644 index 6675a6c139..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-document.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -databases = Databases(client) - -result = databases.update_document( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - document_id = '<DOCUMENT_ID>', - data = {}, # optional - permissions = ["read("any")"] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-email-attribute.md deleted file mode 100644 index fddd79ec48..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update_email_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - default = 'email@example.com' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-enum-attribute.md deleted file mode 100644 index 6b53a08f9f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update_enum_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - elements = [], - required = False, - default = '<DEFAULT>' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-float-attribute.md deleted file mode 100644 index 325a3cabf4..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update_float_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - min = None, - max = None, - default = None -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-integer-attribute.md deleted file mode 100644 index e5105db0f9..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update_integer_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - min = None, - max = None, - default = None -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-ip-attribute.md deleted file mode 100644 index 4473eb1950..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update_ip_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - default = '' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-relationship-attribute.md deleted file mode 100644 index 5db57e7ad3..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update_relationship_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - on_delete = RelationMutate.CASCADE # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-string-attribute.md deleted file mode 100644 index c8a5de8466..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update_string_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - default = '<DEFAULT>' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-python/examples/databases/update-url-attribute.md deleted file mode 100644 index 857d6bee29..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update_url_attribute( - database_id = '<DATABASE_ID>', - collection_id = '<COLLECTION_ID>', - key = '', - required = False, - default = 'https://example.com' -) diff --git a/docs/examples/1.6.x/server-python/examples/databases/update.md b/docs/examples/1.6.x/server-python/examples/databases/update.md deleted file mode 100644 index ca8d5ea78f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/databases/update.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases(client) - -result = databases.update( - database_id = '<DATABASE_ID>', - name = '<NAME>', - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/create-build.md b/docs/examples/1.6.x/server-python/examples/functions/create-build.md deleted file mode 100644 index 152d330b25..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/create-build.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.create_build( - function_id = '<FUNCTION_ID>', - deployment_id = '<DEPLOYMENT_ID>', - build_id = '<BUILD_ID>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-python/examples/functions/create-deployment.md deleted file mode 100644 index 665651afad..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/create-deployment.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client -from appwrite.input_file import InputFile - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.create_deployment( - function_id = '<FUNCTION_ID>', - code = InputFile.from_path('file.png'), - activate = False, - entrypoint = '<ENTRYPOINT>', # optional - commands = '<COMMANDS>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/create-execution.md b/docs/examples/1.6.x/server-python/examples/functions/create-execution.md deleted file mode 100644 index a4ff68bd04..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/create-execution.md +++ /dev/null @@ -1,18 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -functions = Functions(client) - -result = functions.create_execution( - function_id = '<FUNCTION_ID>', - body = '<BODY>', # optional - async = False, # optional - path = '<PATH>', # optional - method = ExecutionMethod.GET, # optional - headers = {}, # optional - scheduled_at = '' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/create-variable.md b/docs/examples/1.6.x/server-python/examples/functions/create-variable.md deleted file mode 100644 index 621a04a631..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/create-variable.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.create_variable( - function_id = '<FUNCTION_ID>', - key = '<KEY>', - value = '<VALUE>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/create.md b/docs/examples/1.6.x/server-python/examples/functions/create.md deleted file mode 100644 index 6bc91c17ee..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/create.md +++ /dev/null @@ -1,33 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.create( - function_id = '<FUNCTION_ID>', - name = '<NAME>', - runtime = .NODE_14_5, - execute = ["any"], # optional - events = [], # optional - schedule = '', # optional - timeout = 1, # optional - enabled = False, # optional - logging = False, # optional - entrypoint = '<ENTRYPOINT>', # optional - commands = '<COMMANDS>', # optional - scopes = [], # optional - installation_id = '<INSTALLATION_ID>', # optional - provider_repository_id = '<PROVIDER_REPOSITORY_ID>', # optional - provider_branch = '<PROVIDER_BRANCH>', # optional - provider_silent_mode = False, # optional - provider_root_directory = '<PROVIDER_ROOT_DIRECTORY>', # optional - template_repository = '<TEMPLATE_REPOSITORY>', # optional - template_owner = '<TEMPLATE_OWNER>', # optional - template_root_directory = '<TEMPLATE_ROOT_DIRECTORY>', # optional - template_branch = '<TEMPLATE_BRANCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-python/examples/functions/delete-deployment.md deleted file mode 100644 index 59fa72908d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/delete-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.delete_deployment( - function_id = '<FUNCTION_ID>', - deployment_id = '<DEPLOYMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-python/examples/functions/delete-execution.md deleted file mode 100644 index 61919caefe..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/delete-execution.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.delete_execution( - function_id = '<FUNCTION_ID>', - execution_id = '<EXECUTION_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-python/examples/functions/delete-variable.md deleted file mode 100644 index 15c82dc28e..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/delete-variable.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.delete_variable( - function_id = '<FUNCTION_ID>', - variable_id = '<VARIABLE_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/delete.md b/docs/examples/1.6.x/server-python/examples/functions/delete.md deleted file mode 100644 index 660d70b006..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.delete( - function_id = '<FUNCTION_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-python/examples/functions/download-deployment.md deleted file mode 100644 index 2d0289bf98..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/download-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.download_deployment( - function_id = '<FUNCTION_ID>', - deployment_id = '<DEPLOYMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-python/examples/functions/get-deployment.md deleted file mode 100644 index 9475ae0e19..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/get-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.get_deployment( - function_id = '<FUNCTION_ID>', - deployment_id = '<DEPLOYMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/get-execution.md b/docs/examples/1.6.x/server-python/examples/functions/get-execution.md deleted file mode 100644 index ccca0860bb..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/get-execution.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -functions = Functions(client) - -result = functions.get_execution( - function_id = '<FUNCTION_ID>', - execution_id = '<EXECUTION_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/get-variable.md b/docs/examples/1.6.x/server-python/examples/functions/get-variable.md deleted file mode 100644 index 1164f2801a..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/get-variable.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.get_variable( - function_id = '<FUNCTION_ID>', - variable_id = '<VARIABLE_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/get.md b/docs/examples/1.6.x/server-python/examples/functions/get.md deleted file mode 100644 index 82d834cd42..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/get.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.get( - function_id = '<FUNCTION_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-python/examples/functions/list-deployments.md deleted file mode 100644 index 1d5dc72b2f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/list-deployments.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.list_deployments( - function_id = '<FUNCTION_ID>', - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/list-executions.md b/docs/examples/1.6.x/server-python/examples/functions/list-executions.md deleted file mode 100644 index 9862222922..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/list-executions.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -functions = Functions(client) - -result = functions.list_executions( - function_id = '<FUNCTION_ID>', - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-python/examples/functions/list-runtimes.md deleted file mode 100644 index 4efe60a18b..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/list-runtimes.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.list_runtimes() diff --git a/docs/examples/1.6.x/server-python/examples/functions/list-variables.md b/docs/examples/1.6.x/server-python/examples/functions/list-variables.md deleted file mode 100644 index 29d6bf0538..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/list-variables.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.list_variables( - function_id = '<FUNCTION_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/list.md b/docs/examples/1.6.x/server-python/examples/functions/list.md deleted file mode 100644 index 0ef5ebaca6..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/list.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.list( - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-python/examples/functions/update-deployment-build.md deleted file mode 100644 index d5e9c54da9..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.update_deployment_build( - function_id = '<FUNCTION_ID>', - deployment_id = '<DEPLOYMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-python/examples/functions/update-deployment.md deleted file mode 100644 index 3bc5ac08dd..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/update-deployment.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.update_deployment( - function_id = '<FUNCTION_ID>', - deployment_id = '<DEPLOYMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/update-variable.md b/docs/examples/1.6.x/server-python/examples/functions/update-variable.md deleted file mode 100644 index 2fdd4a04f8..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/update-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.update_variable( - function_id = '<FUNCTION_ID>', - variable_id = '<VARIABLE_ID>', - key = '<KEY>', - value = '<VALUE>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/functions/update.md b/docs/examples/1.6.x/server-python/examples/functions/update.md deleted file mode 100644 index 7c64a8702f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/functions/update.md +++ /dev/null @@ -1,28 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions(client) - -result = functions.update( - function_id = '<FUNCTION_ID>', - name = '<NAME>', - runtime = .NODE_14_5, # optional - execute = ["any"], # optional - events = [], # optional - schedule = '', # optional - timeout = 1, # optional - enabled = False, # optional - logging = False, # optional - entrypoint = '<ENTRYPOINT>', # optional - commands = '<COMMANDS>', # optional - scopes = [], # optional - installation_id = '<INSTALLATION_ID>', # optional - provider_repository_id = '<PROVIDER_REPOSITORY_ID>', # optional - provider_branch = '<PROVIDER_BRANCH>', # optional - provider_silent_mode = False, # optional - provider_root_directory = '<PROVIDER_ROOT_DIRECTORY>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/graphql/mutation.md b/docs/examples/1.6.x/server-python/examples/graphql/mutation.md deleted file mode 100644 index d9e0ba63c2..0000000000 --- a/docs/examples/1.6.x/server-python/examples/graphql/mutation.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -graphql = Graphql(client) - -result = graphql.mutation( - query = {} -) diff --git a/docs/examples/1.6.x/server-python/examples/graphql/query.md b/docs/examples/1.6.x/server-python/examples/graphql/query.md deleted file mode 100644 index 55b526ce7e..0000000000 --- a/docs/examples/1.6.x/server-python/examples/graphql/query.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -graphql = Graphql(client) - -result = graphql.query( - query = {} -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-python/examples/health/get-antivirus.md deleted file mode 100644 index 2cbf4dc8e2..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-antivirus.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_antivirus() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-cache.md b/docs/examples/1.6.x/server-python/examples/health/get-cache.md deleted file mode 100644 index 12d70604fe..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-cache.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_cache() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-certificate.md b/docs/examples/1.6.x/server-python/examples/health/get-certificate.md deleted file mode 100644 index fdf5583f07..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-certificate.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_certificate( - domain = '' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-d-b.md b/docs/examples/1.6.x/server-python/examples/health/get-d-b.md deleted file mode 100644 index 2f47125142..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-d-b.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_db() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-python/examples/health/get-failed-jobs.md deleted file mode 100644 index 402fde9cec..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_failed_jobs( - name = .V1_DATABASE, - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-python/examples/health/get-pub-sub.md deleted file mode 100644 index 27d1f22f87..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-pub-sub.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_pub_sub() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-builds.md deleted file mode 100644 index a811b10530..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-builds.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_builds( - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-certificates.md deleted file mode 100644 index 6e3e18b06f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_certificates( - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-databases.md deleted file mode 100644 index 502294c5d2..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-databases.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_databases( - name = '<NAME>', # optional - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-deletes.md deleted file mode 100644 index bbae3eb5eb..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_deletes( - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-functions.md deleted file mode 100644 index deffbb9038..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-functions.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_functions( - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-logs.md deleted file mode 100644 index 081bdfcb01..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-logs.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_logs( - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-mails.md deleted file mode 100644 index f1dafb6acd..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-mails.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_mails( - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-messaging.md deleted file mode 100644 index 6b5c2fea47..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_messaging( - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-migrations.md deleted file mode 100644 index 58ba3ebd0d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_migrations( - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-usage-dump.md deleted file mode 100644 index 33f66075fb..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_usage_dump( - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-usage.md deleted file mode 100644 index e01272cdbb..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-usage.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_usage( - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-python/examples/health/get-queue-webhooks.md deleted file mode 100644 index b194541614..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue_webhooks( - threshold = None # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/health/get-queue.md b/docs/examples/1.6.x/server-python/examples/health/get-queue.md deleted file mode 100644 index 6bc0fd2953..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-queue.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_queue() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-python/examples/health/get-storage-local.md deleted file mode 100644 index d5a8c367ce..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-storage-local.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_storage_local() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-storage.md b/docs/examples/1.6.x/server-python/examples/health/get-storage.md deleted file mode 100644 index d1d225b076..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-storage.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_storage() diff --git a/docs/examples/1.6.x/server-python/examples/health/get-time.md b/docs/examples/1.6.x/server-python/examples/health/get-time.md deleted file mode 100644 index 2205c1397c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get-time.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get_time() diff --git a/docs/examples/1.6.x/server-python/examples/health/get.md b/docs/examples/1.6.x/server-python/examples/health/get.md deleted file mode 100644 index 5a5b80c5d4..0000000000 --- a/docs/examples/1.6.x/server-python/examples/health/get.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health(client) - -result = health.get() diff --git a/docs/examples/1.6.x/server-python/examples/locale/get.md b/docs/examples/1.6.x/server-python/examples/locale/get.md deleted file mode 100644 index b47f365c4d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/locale/get.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -locale = Locale(client) - -result = locale.get() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-codes.md b/docs/examples/1.6.x/server-python/examples/locale/list-codes.md deleted file mode 100644 index 700455a86f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/locale/list-codes.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -locale = Locale(client) - -result = locale.list_codes() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-continents.md b/docs/examples/1.6.x/server-python/examples/locale/list-continents.md deleted file mode 100644 index 0db5650b1f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/locale/list-continents.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -locale = Locale(client) - -result = locale.list_continents() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-python/examples/locale/list-countries-e-u.md deleted file mode 100644 index 1b74f1b7a9..0000000000 --- a/docs/examples/1.6.x/server-python/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -locale = Locale(client) - -result = locale.list_countries_eu() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-python/examples/locale/list-countries-phones.md deleted file mode 100644 index d3432f1467..0000000000 --- a/docs/examples/1.6.x/server-python/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -locale = Locale(client) - -result = locale.list_countries_phones() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-countries.md b/docs/examples/1.6.x/server-python/examples/locale/list-countries.md deleted file mode 100644 index 76db17e353..0000000000 --- a/docs/examples/1.6.x/server-python/examples/locale/list-countries.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -locale = Locale(client) - -result = locale.list_countries() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-python/examples/locale/list-currencies.md deleted file mode 100644 index 45993bb23f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/locale/list-currencies.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -locale = Locale(client) - -result = locale.list_currencies() diff --git a/docs/examples/1.6.x/server-python/examples/locale/list-languages.md b/docs/examples/1.6.x/server-python/examples/locale/list-languages.md deleted file mode 100644 index 9b255ae01b..0000000000 --- a/docs/examples/1.6.x/server-python/examples/locale/list-languages.md +++ /dev/null @@ -1,10 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -locale = Locale(client) - -result = locale.list_languages() diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-apns-provider.md deleted file mode 100644 index c74886c075..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_apns_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', - auth_key = '<AUTH_KEY>', # optional - auth_key_id = '<AUTH_KEY_ID>', # optional - team_id = '<TEAM_ID>', # optional - bundle_id = '<BUNDLE_ID>', # optional - sandbox = False, # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-email.md b/docs/examples/1.6.x/server-python/examples/messaging/create-email.md deleted file mode 100644 index 2c9f7a505d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-email.md +++ /dev/null @@ -1,23 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_email( - message_id = '<MESSAGE_ID>', - subject = '<SUBJECT>', - content = '<CONTENT>', - topics = [], # optional - users = [], # optional - targets = [], # optional - cc = [], # optional - bcc = [], # optional - attachments = [], # optional - draft = False, # optional - html = False, # optional - scheduled_at = '' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-fcm-provider.md deleted file mode 100644 index 1f19316bb2..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_fcm_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', - service_account_json = {}, # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index 5e90d42d36..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_mailgun_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', - api_key = '<API_KEY>', # optional - domain = '<DOMAIN>', # optional - is_eu_region = False, # optional - from_name = '<FROM_NAME>', # optional - from_email = 'email@example.com', # optional - reply_to_name = '<REPLY_TO_NAME>', # optional - reply_to_email = 'email@example.com', # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-msg91provider.md deleted file mode 100644 index 16e1075328..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_msg91_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', - template_id = '<TEMPLATE_ID>', # optional - sender_id = '<SENDER_ID>', # optional - auth_key = '<AUTH_KEY>', # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-push.md b/docs/examples/1.6.x/server-python/examples/messaging/create-push.md deleted file mode 100644 index 825104aa07..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-push.md +++ /dev/null @@ -1,27 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_push( - message_id = '<MESSAGE_ID>', - title = '<TITLE>', - body = '<BODY>', - topics = [], # optional - users = [], # optional - targets = [], # optional - data = {}, # optional - action = '<ACTION>', # optional - image = '[ID1:ID2]', # optional - icon = '<ICON>', # optional - sound = '<SOUND>', # optional - color = '<COLOR>', # optional - tag = '<TAG>', # optional - badge = '<BADGE>', # optional - draft = False, # optional - scheduled_at = '' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index 9ec7d8dd5e..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_sendgrid_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', - api_key = '<API_KEY>', # optional - from_name = '<FROM_NAME>', # optional - from_email = 'email@example.com', # optional - reply_to_name = '<REPLY_TO_NAME>', # optional - reply_to_email = 'email@example.com', # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-python/examples/messaging/create-sms.md deleted file mode 100644 index 50bd9c821a..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-sms.md +++ /dev/null @@ -1,18 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_sms( - message_id = '<MESSAGE_ID>', - content = '<CONTENT>', - topics = [], # optional - users = [], # optional - targets = [], # optional - draft = False, # optional - scheduled_at = '' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-smtp-provider.md deleted file mode 100644 index d18b883be0..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,25 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_smtp_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', - host = '<HOST>', - port = 1, # optional - username = '<USERNAME>', # optional - password = '<PASSWORD>', # optional - encryption = SmtpEncryption.NONE, # optional - auto_tls = False, # optional - mailer = '<MAILER>', # optional - from_name = '<FROM_NAME>', # optional - from_email = 'email@example.com', # optional - reply_to_name = '<REPLY_TO_NAME>', # optional - reply_to_email = 'email@example.com', # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-python/examples/messaging/create-subscriber.md deleted file mode 100644 index 8c6eab3cc1..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_jwt('<YOUR_JWT>') # Your secret JSON Web Token - -messaging = Messaging(client) - -result = messaging.create_subscriber( - topic_id = '<TOPIC_ID>', - subscriber_id = '<SUBSCRIBER_ID>', - target_id = '<TARGET_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-telesign-provider.md deleted file mode 100644 index cf26b82f1f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_telesign_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', - from = '+12065550100', # optional - customer_id = '<CUSTOMER_ID>', # optional - api_key = '<API_KEY>', # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index 896fbf5911..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_textmagic_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', - from = '+12065550100', # optional - username = '<USERNAME>', # optional - api_key = '<API_KEY>', # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-python/examples/messaging/create-topic.md deleted file mode 100644 index 0d58b9d094..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_topic( - topic_id = '<TOPIC_ID>', - name = '<NAME>', - subscribe = ["any"] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-twilio-provider.md deleted file mode 100644 index 9be321f313..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_twilio_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', - from = '+12065550100', # optional - account_sid = '<ACCOUNT_SID>', # optional - auth_token = '<AUTH_TOKEN>', # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/create-vonage-provider.md deleted file mode 100644 index a39246d398..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.create_vonage_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', - from = '+12065550100', # optional - api_key = '<API_KEY>', # optional - api_secret = '<API_SECRET>', # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/delete-provider.md deleted file mode 100644 index cb06a2b5ed..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/delete-provider.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.delete_provider( - provider_id = '<PROVIDER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-python/examples/messaging/delete-subscriber.md deleted file mode 100644 index ca25bdb2aa..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_jwt('<YOUR_JWT>') # Your secret JSON Web Token - -messaging = Messaging(client) - -result = messaging.delete_subscriber( - topic_id = '<TOPIC_ID>', - subscriber_id = '<SUBSCRIBER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-python/examples/messaging/delete-topic.md deleted file mode 100644 index e91403a543..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/delete-topic.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.delete_topic( - topic_id = '<TOPIC_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/delete.md b/docs/examples/1.6.x/server-python/examples/messaging/delete.md deleted file mode 100644 index b6d7081120..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.delete( - message_id = '<MESSAGE_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/get-message.md b/docs/examples/1.6.x/server-python/examples/messaging/get-message.md deleted file mode 100644 index 90b2035202..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/get-message.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.get_message( - message_id = '<MESSAGE_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/get-provider.md deleted file mode 100644 index b49376055c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/get-provider.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.get_provider( - provider_id = '<PROVIDER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-python/examples/messaging/get-subscriber.md deleted file mode 100644 index 68427cf6e6..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.get_subscriber( - topic_id = '<TOPIC_ID>', - subscriber_id = '<SUBSCRIBER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-python/examples/messaging/get-topic.md deleted file mode 100644 index 158c18fdd4..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/get-topic.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.get_topic( - topic_id = '<TOPIC_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-python/examples/messaging/list-message-logs.md deleted file mode 100644 index d920a93816..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.list_message_logs( - message_id = '<MESSAGE_ID>', - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-python/examples/messaging/list-messages.md deleted file mode 100644 index 0cb376e81e..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/list-messages.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.list_messages( - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-python/examples/messaging/list-provider-logs.md deleted file mode 100644 index 8590f9b9dd..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.list_provider_logs( - provider_id = '<PROVIDER_ID>', - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-python/examples/messaging/list-providers.md deleted file mode 100644 index cc6aec1425..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/list-providers.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.list_providers( - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-python/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index e39c81feca..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.list_subscriber_logs( - subscriber_id = '<SUBSCRIBER_ID>', - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-python/examples/messaging/list-subscribers.md deleted file mode 100644 index 1c49bc084a..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.list_subscribers( - topic_id = '<TOPIC_ID>', - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-python/examples/messaging/list-targets.md deleted file mode 100644 index 5d38f70a6a..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/list-targets.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.list_targets( - message_id = '<MESSAGE_ID>', - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-python/examples/messaging/list-topic-logs.md deleted file mode 100644 index 6b312454da..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.list_topic_logs( - topic_id = '<TOPIC_ID>', - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-python/examples/messaging/list-topics.md deleted file mode 100644 index 6bdd594e41..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/list-topics.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.list_topics( - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-apns-provider.md deleted file mode 100644 index 5fb6c06c4c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_apns_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', # optional - enabled = False, # optional - auth_key = '<AUTH_KEY>', # optional - auth_key_id = '<AUTH_KEY_ID>', # optional - team_id = '<TEAM_ID>', # optional - bundle_id = '<BUNDLE_ID>', # optional - sandbox = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-email.md b/docs/examples/1.6.x/server-python/examples/messaging/update-email.md deleted file mode 100644 index 2b7576a9a3..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-email.md +++ /dev/null @@ -1,23 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_email( - message_id = '<MESSAGE_ID>', - topics = [], # optional - users = [], # optional - targets = [], # optional - subject = '<SUBJECT>', # optional - content = '<CONTENT>', # optional - draft = False, # optional - html = False, # optional - cc = [], # optional - bcc = [], # optional - scheduled_at = '', # optional - attachments = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-fcm-provider.md deleted file mode 100644 index 4a4b3dc390..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_fcm_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', # optional - enabled = False, # optional - service_account_json = {} # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index f64307ea3e..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_mailgun_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', # optional - api_key = '<API_KEY>', # optional - domain = '<DOMAIN>', # optional - is_eu_region = False, # optional - enabled = False, # optional - from_name = '<FROM_NAME>', # optional - from_email = 'email@example.com', # optional - reply_to_name = '<REPLY_TO_NAME>', # optional - reply_to_email = '<REPLY_TO_EMAIL>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-msg91provider.md deleted file mode 100644 index 2d88e70d3a..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_msg91_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', # optional - enabled = False, # optional - template_id = '<TEMPLATE_ID>', # optional - sender_id = '<SENDER_ID>', # optional - auth_key = '<AUTH_KEY>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-push.md b/docs/examples/1.6.x/server-python/examples/messaging/update-push.md deleted file mode 100644 index 6069a928ef..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-push.md +++ /dev/null @@ -1,27 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_push( - message_id = '<MESSAGE_ID>', - topics = [], # optional - users = [], # optional - targets = [], # optional - title = '<TITLE>', # optional - body = '<BODY>', # optional - data = {}, # optional - action = '<ACTION>', # optional - image = '[ID1:ID2]', # optional - icon = '<ICON>', # optional - sound = '<SOUND>', # optional - color = '<COLOR>', # optional - tag = '<TAG>', # optional - badge = None, # optional - draft = False, # optional - scheduled_at = '' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index d54c5ccf0a..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_sendgrid_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', # optional - enabled = False, # optional - api_key = '<API_KEY>', # optional - from_name = '<FROM_NAME>', # optional - from_email = 'email@example.com', # optional - reply_to_name = '<REPLY_TO_NAME>', # optional - reply_to_email = '<REPLY_TO_EMAIL>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-python/examples/messaging/update-sms.md deleted file mode 100644 index 9f1902bfcb..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-sms.md +++ /dev/null @@ -1,18 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_sms( - message_id = '<MESSAGE_ID>', - topics = [], # optional - users = [], # optional - targets = [], # optional - content = '<CONTENT>', # optional - draft = False, # optional - scheduled_at = '' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-smtp-provider.md deleted file mode 100644 index 0bbe18d187..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,25 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_smtp_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', # optional - host = '<HOST>', # optional - port = 1, # optional - username = '<USERNAME>', # optional - password = '<PASSWORD>', # optional - encryption = SmtpEncryption.NONE, # optional - auto_tls = False, # optional - mailer = '<MAILER>', # optional - from_name = '<FROM_NAME>', # optional - from_email = 'email@example.com', # optional - reply_to_name = '<REPLY_TO_NAME>', # optional - reply_to_email = '<REPLY_TO_EMAIL>', # optional - enabled = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-telesign-provider.md deleted file mode 100644 index b285490c3e..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_telesign_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', # optional - enabled = False, # optional - customer_id = '<CUSTOMER_ID>', # optional - api_key = '<API_KEY>', # optional - from = '<FROM>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index 4384e4c4db..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_textmagic_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', # optional - enabled = False, # optional - username = '<USERNAME>', # optional - api_key = '<API_KEY>', # optional - from = '<FROM>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-python/examples/messaging/update-topic.md deleted file mode 100644 index 3d084b1707..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_topic( - topic_id = '<TOPIC_ID>', - name = '<NAME>', # optional - subscribe = ["any"] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-twilio-provider.md deleted file mode 100644 index e8bb4c0892..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_twilio_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', # optional - enabled = False, # optional - account_sid = '<ACCOUNT_SID>', # optional - auth_token = '<AUTH_TOKEN>', # optional - from = '<FROM>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-python/examples/messaging/update-vonage-provider.md deleted file mode 100644 index 115851538a..0000000000 --- a/docs/examples/1.6.x/server-python/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging(client) - -result = messaging.update_vonage_provider( - provider_id = '<PROVIDER_ID>', - name = '<NAME>', # optional - enabled = False, # optional - api_key = '<API_KEY>', # optional - api_secret = '<API_SECRET>', # optional - from = '<FROM>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-python/examples/storage/create-bucket.md deleted file mode 100644 index 2ca86a5eb2..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/create-bucket.md +++ /dev/null @@ -1,21 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -storage = Storage(client) - -result = storage.create_bucket( - bucket_id = '<BUCKET_ID>', - name = '<NAME>', - permissions = ["read("any")"], # optional - file_security = False, # optional - enabled = False, # optional - maximum_file_size = 1, # optional - allowed_file_extensions = [], # optional - compression = .NONE, # optional - encryption = False, # optional - antivirus = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/create-file.md b/docs/examples/1.6.x/server-python/examples/storage/create-file.md deleted file mode 100644 index 391b6427b1..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/create-file.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client -from appwrite.input_file import InputFile - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -storage = Storage(client) - -result = storage.create_file( - bucket_id = '<BUCKET_ID>', - file_id = '<FILE_ID>', - file = InputFile.from_path('file.png'), - permissions = ["read("any")"] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-python/examples/storage/delete-bucket.md deleted file mode 100644 index 980e1ec32c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/delete-bucket.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -storage = Storage(client) - -result = storage.delete_bucket( - bucket_id = '<BUCKET_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/delete-file.md b/docs/examples/1.6.x/server-python/examples/storage/delete-file.md deleted file mode 100644 index 8bce51d143..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/delete-file.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -storage = Storage(client) - -result = storage.delete_file( - bucket_id = '<BUCKET_ID>', - file_id = '<FILE_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-python/examples/storage/get-bucket.md deleted file mode 100644 index a1712b375d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/get-bucket.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -storage = Storage(client) - -result = storage.get_bucket( - bucket_id = '<BUCKET_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-python/examples/storage/get-file-download.md deleted file mode 100644 index d8658356d6..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/get-file-download.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -storage = Storage(client) - -result = storage.get_file_download( - bucket_id = '<BUCKET_ID>', - file_id = '<FILE_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-python/examples/storage/get-file-preview.md deleted file mode 100644 index f69f9227a5..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/get-file-preview.md +++ /dev/null @@ -1,24 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -storage = Storage(client) - -result = storage.get_file_preview( - bucket_id = '<BUCKET_ID>', - file_id = '<FILE_ID>', - width = 0, # optional - height = 0, # optional - gravity = ImageGravity.CENTER, # optional - quality = 0, # optional - border_width = 0, # optional - border_color = '', # optional - border_radius = 0, # optional - opacity = 0, # optional - rotation = -360, # optional - background = '', # optional - output = ImageFormat.JPG # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-python/examples/storage/get-file-view.md deleted file mode 100644 index 043772a66e..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/get-file-view.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -storage = Storage(client) - -result = storage.get_file_view( - bucket_id = '<BUCKET_ID>', - file_id = '<FILE_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/get-file.md b/docs/examples/1.6.x/server-python/examples/storage/get-file.md deleted file mode 100644 index af451afbee..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/get-file.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -storage = Storage(client) - -result = storage.get_file( - bucket_id = '<BUCKET_ID>', - file_id = '<FILE_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-python/examples/storage/list-buckets.md deleted file mode 100644 index e6202bd5ab..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/list-buckets.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -storage = Storage(client) - -result = storage.list_buckets( - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/list-files.md b/docs/examples/1.6.x/server-python/examples/storage/list-files.md deleted file mode 100644 index d1408581f4..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/list-files.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -storage = Storage(client) - -result = storage.list_files( - bucket_id = '<BUCKET_ID>', - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-python/examples/storage/update-bucket.md deleted file mode 100644 index bcb59eafb1..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/update-bucket.md +++ /dev/null @@ -1,21 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -storage = Storage(client) - -result = storage.update_bucket( - bucket_id = '<BUCKET_ID>', - name = '<NAME>', - permissions = ["read("any")"], # optional - file_security = False, # optional - enabled = False, # optional - maximum_file_size = 1, # optional - allowed_file_extensions = [], # optional - compression = .NONE, # optional - encryption = False, # optional - antivirus = False # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/storage/update-file.md b/docs/examples/1.6.x/server-python/examples/storage/update-file.md deleted file mode 100644 index 22e32cbac8..0000000000 --- a/docs/examples/1.6.x/server-python/examples/storage/update-file.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -storage = Storage(client) - -result = storage.update_file( - bucket_id = '<BUCKET_ID>', - file_id = '<FILE_ID>', - name = '<NAME>', # optional - permissions = ["read("any")"] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/create-membership.md b/docs/examples/1.6.x/server-python/examples/teams/create-membership.md deleted file mode 100644 index 3664e35eb3..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/create-membership.md +++ /dev/null @@ -1,18 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.create_membership( - team_id = '<TEAM_ID>', - roles = [], - email = 'email@example.com', # optional - user_id = '<USER_ID>', # optional - phone = '+12065550100', # optional - url = 'https://example.com', # optional - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/create.md b/docs/examples/1.6.x/server-python/examples/teams/create.md deleted file mode 100644 index 94a0467cc9..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/create.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.create( - team_id = '<TEAM_ID>', - name = '<NAME>', - roles = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-python/examples/teams/delete-membership.md deleted file mode 100644 index 9dccc49423..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/delete-membership.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.delete_membership( - team_id = '<TEAM_ID>', - membership_id = '<MEMBERSHIP_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/delete.md b/docs/examples/1.6.x/server-python/examples/teams/delete.md deleted file mode 100644 index f92048854a..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.delete( - team_id = '<TEAM_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/get-membership.md b/docs/examples/1.6.x/server-python/examples/teams/get-membership.md deleted file mode 100644 index fa961e3ea5..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/get-membership.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.get_membership( - team_id = '<TEAM_ID>', - membership_id = '<MEMBERSHIP_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-python/examples/teams/get-prefs.md deleted file mode 100644 index 6b097f1793..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.get_prefs( - team_id = '<TEAM_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/get.md b/docs/examples/1.6.x/server-python/examples/teams/get.md deleted file mode 100644 index 20a807e802..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/get.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.get( - team_id = '<TEAM_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-python/examples/teams/list-memberships.md deleted file mode 100644 index 02bb575628..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/list-memberships.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.list_memberships( - team_id = '<TEAM_ID>', - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/list.md b/docs/examples/1.6.x/server-python/examples/teams/list.md deleted file mode 100644 index 7a3018f242..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/list.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.list( - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-python/examples/teams/update-membership-status.md deleted file mode 100644 index 6e06b8d037..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/update-membership-status.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.update_membership_status( - team_id = '<TEAM_ID>', - membership_id = '<MEMBERSHIP_ID>', - user_id = '<USER_ID>', - secret = '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/update-membership.md b/docs/examples/1.6.x/server-python/examples/teams/update-membership.md deleted file mode 100644 index ecdfe2b8fd..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/update-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.update_membership( - team_id = '<TEAM_ID>', - membership_id = '<MEMBERSHIP_ID>', - roles = [] -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/update-name.md b/docs/examples/1.6.x/server-python/examples/teams/update-name.md deleted file mode 100644 index b5f44aaad5..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.update_name( - team_id = '<TEAM_ID>', - name = '<NAME>' -) diff --git a/docs/examples/1.6.x/server-python/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-python/examples/teams/update-prefs.md deleted file mode 100644 index c31f64f992..0000000000 --- a/docs/examples/1.6.x/server-python/examples/teams/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_session('') # The user session to authenticate with - -teams = Teams(client) - -result = teams.update_prefs( - team_id = '<TEAM_ID>', - prefs = {} -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-python/examples/users/create-argon2user.md deleted file mode 100644 index ab35ec62df..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-argon2user.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_argon2_user( - user_id = '<USER_ID>', - email = 'email@example.com', - password = 'password', - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-python/examples/users/create-bcrypt-user.md deleted file mode 100644 index eadd5e46ad..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_bcrypt_user( - user_id = '<USER_ID>', - email = 'email@example.com', - password = 'password', - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-python/examples/users/create-j-w-t.md deleted file mode 100644 index 56d27f4de1..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-j-w-t.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_jwt( - user_id = '<USER_ID>', - session_id = '<SESSION_ID>', # optional - duration = 0 # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-python/examples/users/create-m-d5user.md deleted file mode 100644 index 81c1b462ec..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-m-d5user.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_md5_user( - user_id = '<USER_ID>', - email = 'email@example.com', - password = 'password', - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index 0d2f63e31b..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_mfa_recovery_codes( - user_id = '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-python/examples/users/create-p-h-pass-user.md deleted file mode 100644 index e499792cc9..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,15 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_ph_pass_user( - user_id = '<USER_ID>', - email = 'email@example.com', - password = 'password', - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-python/examples/users/create-s-h-a-user.md deleted file mode 100644 index c7cacbc2e3..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_sha_user( - user_id = '<USER_ID>', - email = 'email@example.com', - password = 'password', - password_version = PasswordHash.SHA1, # optional - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-python/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index a3fd282c2c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,18 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_scrypt_modified_user( - user_id = '<USER_ID>', - email = 'email@example.com', - password = 'password', - password_salt = '<PASSWORD_SALT>', - password_salt_separator = '<PASSWORD_SALT_SEPARATOR>', - password_signer_key = '<PASSWORD_SIGNER_KEY>', - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-python/examples/users/create-scrypt-user.md deleted file mode 100644 index 483755a7de..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,20 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_scrypt_user( - user_id = '<USER_ID>', - email = 'email@example.com', - password = 'password', - password_salt = '<PASSWORD_SALT>', - password_cpu = None, - password_memory = None, - password_parallel = None, - password_length = None, - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-session.md b/docs/examples/1.6.x/server-python/examples/users/create-session.md deleted file mode 100644 index d28faf9a7b..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-session.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_session( - user_id = '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-target.md b/docs/examples/1.6.x/server-python/examples/users/create-target.md deleted file mode 100644 index 2f3ccb6f5f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-target.md +++ /dev/null @@ -1,18 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import MessagingProviderType - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_target( - user_id = '<USER_ID>', - target_id = '<TARGET_ID>', - provider_type = MessagingProviderType.EMAIL, - identifier = '<IDENTIFIER>', - provider_id = '<PROVIDER_ID>', # optional - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create-token.md b/docs/examples/1.6.x/server-python/examples/users/create-token.md deleted file mode 100644 index ee58dbb435..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create-token.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create_token( - user_id = '<USER_ID>', - length = 4, # optional - expire = 60 # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/create.md b/docs/examples/1.6.x/server-python/examples/users/create.md deleted file mode 100644 index e310b81f4c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/create.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.create( - user_id = '<USER_ID>', - email = 'email@example.com', # optional - phone = '+12065550100', # optional - password = '', # optional - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete-identity.md b/docs/examples/1.6.x/server-python/examples/users/delete-identity.md deleted file mode 100644 index 493f618ce1..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/delete-identity.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.delete_identity( - identity_id = '<IDENTITY_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-python/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index e7c3525277..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,14 +0,0 @@ -from appwrite.client import Client -from appwrite.enums import AuthenticatorType - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.delete_mfa_authenticator( - user_id = '<USER_ID>', - type = AuthenticatorType.TOTP -) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete-session.md b/docs/examples/1.6.x/server-python/examples/users/delete-session.md deleted file mode 100644 index 658a49848d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/delete-session.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.delete_session( - user_id = '<USER_ID>', - session_id = '<SESSION_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-python/examples/users/delete-sessions.md deleted file mode 100644 index 6fdd149bc5..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/delete-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.delete_sessions( - user_id = '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete-target.md b/docs/examples/1.6.x/server-python/examples/users/delete-target.md deleted file mode 100644 index 67d94d3015..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/delete-target.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.delete_target( - user_id = '<USER_ID>', - target_id = '<TARGET_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/delete.md b/docs/examples/1.6.x/server-python/examples/users/delete.md deleted file mode 100644 index 056647f8aa..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/delete.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.delete( - user_id = '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index 21e9b2730d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.get_mfa_recovery_codes( - user_id = '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/get-prefs.md b/docs/examples/1.6.x/server-python/examples/users/get-prefs.md deleted file mode 100644 index 62c0488bf6..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.get_prefs( - user_id = '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/get-target.md b/docs/examples/1.6.x/server-python/examples/users/get-target.md deleted file mode 100644 index 994fbfab0b..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/get-target.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.get_target( - user_id = '<USER_ID>', - target_id = '<TARGET_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/get.md b/docs/examples/1.6.x/server-python/examples/users/get.md deleted file mode 100644 index 3fbfdc748c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/get.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.get( - user_id = '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-identities.md b/docs/examples/1.6.x/server-python/examples/users/list-identities.md deleted file mode 100644 index 20de979a79..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/list-identities.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.list_identities( - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-logs.md b/docs/examples/1.6.x/server-python/examples/users/list-logs.md deleted file mode 100644 index 6c7376428c..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/list-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.list_logs( - user_id = '<USER_ID>', - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-memberships.md b/docs/examples/1.6.x/server-python/examples/users/list-memberships.md deleted file mode 100644 index 38f1b05202..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/list-memberships.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.list_memberships( - user_id = '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-python/examples/users/list-mfa-factors.md deleted file mode 100644 index 425f4988f3..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.list_mfa_factors( - user_id = '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-sessions.md b/docs/examples/1.6.x/server-python/examples/users/list-sessions.md deleted file mode 100644 index 7271449602..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/list-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.list_sessions( - user_id = '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/list-targets.md b/docs/examples/1.6.x/server-python/examples/users/list-targets.md deleted file mode 100644 index e0c288982d..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/list-targets.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.list_targets( - user_id = '<USER_ID>', - queries = [] # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/list.md b/docs/examples/1.6.x/server-python/examples/users/list.md deleted file mode 100644 index 5401629abd..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/list.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.list( - queries = [], # optional - search = '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-python/examples/users/update-email-verification.md deleted file mode 100644 index af0387e403..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-email-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_email_verification( - user_id = '<USER_ID>', - email_verification = False -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-email.md b/docs/examples/1.6.x/server-python/examples/users/update-email.md deleted file mode 100644 index fb9f0b5e41..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-email.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_email( - user_id = '<USER_ID>', - email = 'email@example.com' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-labels.md b/docs/examples/1.6.x/server-python/examples/users/update-labels.md deleted file mode 100644 index 58e7145a93..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-labels.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_labels( - user_id = '<USER_ID>', - labels = [] -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-python/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index 7aede583f3..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_mfa_recovery_codes( - user_id = '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-mfa.md b/docs/examples/1.6.x/server-python/examples/users/update-mfa.md deleted file mode 100644 index 9ed34b511f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-mfa.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_mfa( - user_id = '<USER_ID>', - mfa = False -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-name.md b/docs/examples/1.6.x/server-python/examples/users/update-name.md deleted file mode 100644 index d232424aa0..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_name( - user_id = '<USER_ID>', - name = '<NAME>' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-password.md b/docs/examples/1.6.x/server-python/examples/users/update-password.md deleted file mode 100644 index 1d3c30168f..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-password.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_password( - user_id = '<USER_ID>', - password = '' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-python/examples/users/update-phone-verification.md deleted file mode 100644 index 5f61f9498a..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-phone-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_phone_verification( - user_id = '<USER_ID>', - phone_verification = False -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-phone.md b/docs/examples/1.6.x/server-python/examples/users/update-phone.md deleted file mode 100644 index 246e0a7717..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-phone.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_phone( - user_id = '<USER_ID>', - number = '+12065550100' -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-prefs.md b/docs/examples/1.6.x/server-python/examples/users/update-prefs.md deleted file mode 100644 index 0fafb6dd01..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_prefs( - user_id = '<USER_ID>', - prefs = {} -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-status.md b/docs/examples/1.6.x/server-python/examples/users/update-status.md deleted file mode 100644 index d970440d99..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-status.md +++ /dev/null @@ -1,13 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_status( - user_id = '<USER_ID>', - status = False -) diff --git a/docs/examples/1.6.x/server-python/examples/users/update-target.md b/docs/examples/1.6.x/server-python/examples/users/update-target.md deleted file mode 100644 index 97370cb203..0000000000 --- a/docs/examples/1.6.x/server-python/examples/users/update-target.md +++ /dev/null @@ -1,16 +0,0 @@ -from appwrite.client import Client - -client = Client() -client.set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('<YOUR_PROJECT_ID>') # Your project ID -client.set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users(client) - -result = users.update_target( - user_id = '<USER_ID>', - target_id = '<TARGET_ID>', - identifier = '<IDENTIFIER>', # optional - provider_id = '<PROVIDER_ID>', # optional - name = '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-rest/examples/account/create-anonymous-session.md deleted file mode 100644 index 772e31903e..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,6 +0,0 @@ -POST /v1/account/sessions/anonymous HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-rest/examples/account/create-email-password-session.md deleted file mode 100644 index bee865dac0..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-email-password-session.md +++ /dev/null @@ -1,10 +0,0 @@ -POST /v1/account/sessions/email HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "email": "email@example.com", - "password": "password" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-email-token.md b/docs/examples/1.6.x/server-rest/examples/account/create-email-token.md deleted file mode 100644 index 206711b906..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-email-token.md +++ /dev/null @@ -1,11 +0,0 @@ -POST /v1/account/tokens/email HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "phrase": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-rest/examples/account/create-j-w-t.md deleted file mode 100644 index 83169a46f9..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-j-w-t.md +++ /dev/null @@ -1,6 +0,0 @@ -POST /v1/account/jwts HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-rest/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 43b946c7b6..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/account/tokens/magic-url HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "url": "https://example.com", - "phrase": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-rest/examples/account/create-mfa-authenticator.md deleted file mode 100644 index baacbbe18b..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,8 +0,0 @@ -POST /v1/account/mfa/authenticators/{type} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-rest/examples/account/create-mfa-challenge.md deleted file mode 100644 index 991710a0cb..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,9 +0,0 @@ -POST /v1/account/mfa/challenge HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "factor": "email" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index b7214f244d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,8 +0,0 @@ -POST /v1/account/mfa/recovery-codes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-rest/examples/account/create-o-auth2token.md deleted file mode 100644 index 99abb6d4a9..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,6 +0,0 @@ -GET /v1/account/tokens/oauth2/{provider} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-rest/examples/account/create-phone-token.md deleted file mode 100644 index 4a9a99c949..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-phone-token.md +++ /dev/null @@ -1,10 +0,0 @@ -POST /v1/account/tokens/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "phone": "+12065550100" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-rest/examples/account/create-phone-verification.md deleted file mode 100644 index 3811b6a523..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-phone-verification.md +++ /dev/null @@ -1,8 +0,0 @@ -POST /v1/account/verification/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-recovery.md b/docs/examples/1.6.x/server-rest/examples/account/create-recovery.md deleted file mode 100644 index f8f0a9cdd6..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-recovery.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/account/recovery HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "email": "email@example.com", - "url": "https://example.com" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-session.md b/docs/examples/1.6.x/server-rest/examples/account/create-session.md deleted file mode 100644 index 2a9108c0f4..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-session.md +++ /dev/null @@ -1,10 +0,0 @@ -POST /v1/account/sessions/token HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create-verification.md b/docs/examples/1.6.x/server-rest/examples/account/create-verification.md deleted file mode 100644 index 7582b81d01..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create-verification.md +++ /dev/null @@ -1,11 +0,0 @@ -POST /v1/account/verification HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "url": "https://example.com" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/create.md b/docs/examples/1.6.x/server-rest/examples/account/create.md deleted file mode 100644 index ec4b11df00..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/create.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/account HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "password": , - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/delete-identity.md b/docs/examples/1.6.x/server-rest/examples/account/delete-identity.md deleted file mode 100644 index 01df4d7e90..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/delete-identity.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/account/identities/{identityId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-rest/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 25b1733019..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/account/mfa/authenticators/{type} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/delete-session.md b/docs/examples/1.6.x/server-rest/examples/account/delete-session.md deleted file mode 100644 index f8d4c0035f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/delete-session.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/account/sessions/{sessionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-rest/examples/account/delete-sessions.md deleted file mode 100644 index 1e9d00b1ca..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/delete-sessions.md +++ /dev/null @@ -1,8 +0,0 @@ -DELETE /v1/account/sessions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index cb27036775..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/mfa/recovery-codes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/get-prefs.md b/docs/examples/1.6.x/server-rest/examples/account/get-prefs.md deleted file mode 100644 index c0513aa8b6..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/get-prefs.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/prefs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/get-session.md b/docs/examples/1.6.x/server-rest/examples/account/get-session.md deleted file mode 100644 index 64950545ec..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/get-session.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/sessions/{sessionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/get.md b/docs/examples/1.6.x/server-rest/examples/account/get.md deleted file mode 100644 index 40841841e5..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/get.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/list-identities.md b/docs/examples/1.6.x/server-rest/examples/account/list-identities.md deleted file mode 100644 index 2ea442b347..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/list-identities.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/identities HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/list-logs.md b/docs/examples/1.6.x/server-rest/examples/account/list-logs.md deleted file mode 100644 index 9d1589e9a2..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/list-logs.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/logs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-rest/examples/account/list-mfa-factors.md deleted file mode 100644 index 5b12a4948a..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/mfa/factors HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/list-sessions.md b/docs/examples/1.6.x/server-rest/examples/account/list-sessions.md deleted file mode 100644 index 39ee92bb20..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/list-sessions.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/account/sessions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-email.md b/docs/examples/1.6.x/server-rest/examples/account/update-email.md deleted file mode 100644 index 4c9723d856..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-email.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/account/email HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "email": "email@example.com", - "password": "password" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-rest/examples/account/update-m-f-a.md deleted file mode 100644 index 668cc887a0..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-m-f-a.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/account/mfa HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "mfa": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-rest/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index b568b35c55..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,10 +0,0 @@ -PUT /v1/account/sessions/magic-url HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-rest/examples/account/update-mfa-authenticator.md deleted file mode 100644 index 3048091fb7..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,11 +0,0 @@ -PUT /v1/account/mfa/authenticators/{type} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "otp": "<OTP>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-rest/examples/account/update-mfa-challenge.md deleted file mode 100644 index 33d5fe45d5..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,12 +0,0 @@ -PUT /v1/account/mfa/challenge HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "challengeId": "<CHALLENGE_ID>", - "otp": "<OTP>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index 353908edcf..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,8 +0,0 @@ -PATCH /v1/account/mfa/recovery-codes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-name.md b/docs/examples/1.6.x/server-rest/examples/account/update-name.md deleted file mode 100644 index 43d100c8f5..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-name.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/account/name HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-password.md b/docs/examples/1.6.x/server-rest/examples/account/update-password.md deleted file mode 100644 index e35d9a8c76..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-password.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/account/password HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "password": , - "oldPassword": "password" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-rest/examples/account/update-phone-session.md deleted file mode 100644 index 540267f6d8..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-phone-session.md +++ /dev/null @@ -1,10 +0,0 @@ -PUT /v1/account/sessions/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-rest/examples/account/update-phone-verification.md deleted file mode 100644 index 301f0b1057..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-phone-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -PUT /v1/account/verification/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-phone.md b/docs/examples/1.6.x/server-rest/examples/account/update-phone.md deleted file mode 100644 index ea35a1b8ca..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-phone.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/account/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "phone": "+12065550100", - "password": "password" -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-prefs.md b/docs/examples/1.6.x/server-rest/examples/account/update-prefs.md deleted file mode 100644 index 87af8ec625..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-prefs.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/account/prefs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "prefs": {} -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-recovery.md b/docs/examples/1.6.x/server-rest/examples/account/update-recovery.md deleted file mode 100644 index 77ae28a33d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-recovery.md +++ /dev/null @@ -1,13 +0,0 @@ -PUT /v1/account/recovery HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>", - "password": -} diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-session.md b/docs/examples/1.6.x/server-rest/examples/account/update-session.md deleted file mode 100644 index d8a7b97f3c..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-session.md +++ /dev/null @@ -1,8 +0,0 @@ -PATCH /v1/account/sessions/{sessionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-status.md b/docs/examples/1.6.x/server-rest/examples/account/update-status.md deleted file mode 100644 index b10060a866..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-status.md +++ /dev/null @@ -1,8 +0,0 @@ -PATCH /v1/account/status HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/account/update-verification.md b/docs/examples/1.6.x/server-rest/examples/account/update-verification.md deleted file mode 100644 index cd6c2f9e88..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/account/update-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -PUT /v1/account/verification HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-browser.md deleted file mode 100644 index b7861af9e8..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/avatars/get-browser.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/avatars/browsers/{code} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-credit-card.md deleted file mode 100644 index c01974a5ff..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/avatars/credit-cards/{code} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-favicon.md deleted file mode 100644 index 377d021965..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/avatars/get-favicon.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/avatars/favicon HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-flag.md deleted file mode 100644 index 3034220d31..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/avatars/get-flag.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/avatars/flags/{code} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-image.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-image.md deleted file mode 100644 index fb34b92df4..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/avatars/get-image.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/avatars/image HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-initials.md deleted file mode 100644 index c1e5cd066d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/avatars/get-initials.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/avatars/initials HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-rest/examples/avatars/get-q-r.md deleted file mode 100644 index 05add56280..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/avatars/get-q-r.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/avatars/qr HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-boolean-attribute.md deleted file mode 100644 index c2d3a05eff..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": , - "required": false, - "default": false, - "array": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-collection.md b/docs/examples/1.6.x/server-rest/examples/databases/create-collection.md deleted file mode 100644 index 2ceb00c67d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-collection.md +++ /dev/null @@ -1,14 +0,0 @@ -POST /v1/databases/{databaseId}/collections HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "collectionId": "<COLLECTION_ID>", - "name": "<NAME>", - "permissions": ["read(\"any\")"], - "documentSecurity": false, - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-datetime-attribute.md deleted file mode 100644 index 8b717bb08b..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": , - "required": false, - "default": , - "array": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-document.md b/docs/examples/1.6.x/server-rest/examples/databases/create-document.md deleted file mode 100644 index e61a3deff2..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-document.md +++ /dev/null @@ -1,14 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - -{ - "documentId": "<DOCUMENT_ID>", - "data": {}, - "permissions": ["read(\"any\")"] -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-email-attribute.md deleted file mode 100644 index 8b7dc1cc28..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/email HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": , - "required": false, - "default": "email@example.com", - "array": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-enum-attribute.md deleted file mode 100644 index 3eb3c084c2..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": , - "elements": [], - "required": false, - "default": "<DEFAULT>", - "array": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-float-attribute.md deleted file mode 100644 index a688549b0f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/float HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": , - "required": false, - "min": 0, - "max": 0, - "default": 0, - "array": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-index.md b/docs/examples/1.6.x/server-rest/examples/databases/create-index.md deleted file mode 100644 index c02336035a..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-index.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": , - "type": "key", - "attributes": [], - "orders": [] -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-integer-attribute.md deleted file mode 100644 index f21710018f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": , - "required": false, - "min": 0, - "max": 0, - "default": 0, - "array": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-ip-attribute.md deleted file mode 100644 index a89d13e390..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": , - "required": false, - "default": , - "array": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-relationship-attribute.md deleted file mode 100644 index fa14ee33bb..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/relationship HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "relatedCollectionId": "<RELATED_COLLECTION_ID>", - "type": "oneToOne", - "twoWay": false, - "key": , - "twoWayKey": , - "onDelete": "cascade" -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-string-attribute.md deleted file mode 100644 index b14825e1f8..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/string HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": , - "size": 1, - "required": false, - "default": "<DEFAULT>", - "array": false, - "encrypt": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/create-url-attribute.md deleted file mode 100644 index c40e70f8b1..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/url HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": , - "required": false, - "default": "https://example.com", - "array": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/create.md b/docs/examples/1.6.x/server-rest/examples/databases/create.md deleted file mode 100644 index 6a4954f0ad..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/create.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/databases HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "databaseId": "<DATABASE_ID>", - "name": "<NAME>", - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/delete-attribute.md deleted file mode 100644 index 7980c1c3f5..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/delete-attribute.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-rest/examples/databases/delete-collection.md deleted file mode 100644 index 4c78160192..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/delete-collection.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/delete-document.md b/docs/examples/1.6.x/server-rest/examples/databases/delete-document.md deleted file mode 100644 index 5f7e3ffef5..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/delete-document.md +++ /dev/null @@ -1,9 +0,0 @@ -DELETE /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/delete-index.md b/docs/examples/1.6.x/server-rest/examples/databases/delete-index.md deleted file mode 100644 index 5c41baf57d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/delete-index.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/databases/{databaseId}/collections/{collectionId}/indexes/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/delete.md b/docs/examples/1.6.x/server-rest/examples/databases/delete.md deleted file mode 100644 index d9557c1192..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/delete.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/databases/{databaseId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/get-attribute.md deleted file mode 100644 index 416ed42a88..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/get-attribute.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/get-collection.md b/docs/examples/1.6.x/server-rest/examples/databases/get-collection.md deleted file mode 100644 index 54b6b60dfa..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/get-collection.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/get-document.md b/docs/examples/1.6.x/server-rest/examples/databases/get-document.md deleted file mode 100644 index ff9950ba08..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/get-document.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/get-index.md b/docs/examples/1.6.x/server-rest/examples/databases/get-index.md deleted file mode 100644 index 4170437cf3..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/get-index.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/databases/{databaseId}/collections/{collectionId}/indexes/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/get.md b/docs/examples/1.6.x/server-rest/examples/databases/get.md deleted file mode 100644 index d946abbc85..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/get.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/databases/{databaseId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-rest/examples/databases/list-attributes.md deleted file mode 100644 index 01d8f71e8b..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/list-attributes.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/databases/{databaseId}/collections/{collectionId}/attributes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/list-collections.md b/docs/examples/1.6.x/server-rest/examples/databases/list-collections.md deleted file mode 100644 index 1ce2e5339d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/list-collections.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/databases/{databaseId}/collections HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/list-documents.md b/docs/examples/1.6.x/server-rest/examples/databases/list-documents.md deleted file mode 100644 index f57d5f243c..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/list-documents.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/databases/{databaseId}/collections/{collectionId}/documents HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-rest/examples/databases/list-indexes.md deleted file mode 100644 index 57a45b513a..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/list-indexes.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/databases/{databaseId}/collections/{collectionId}/indexes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/list.md b/docs/examples/1.6.x/server-rest/examples/databases/list.md deleted file mode 100644 index 715b7f3f1d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/list.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/databases HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-boolean-attribute.md deleted file mode 100644 index 2a2acc1df8..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "required": false, - "default": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-collection.md b/docs/examples/1.6.x/server-rest/examples/databases/update-collection.md deleted file mode 100644 index fdaf7e65bd..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-collection.md +++ /dev/null @@ -1,13 +0,0 @@ -PUT /v1/databases/{databaseId}/collections/{collectionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "permissions": ["read(\"any\")"], - "documentSecurity": false, - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-datetime-attribute.md deleted file mode 100644 index 3bff0cf1a6..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "required": false, - "default": -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-document.md b/docs/examples/1.6.x/server-rest/examples/databases/update-document.md deleted file mode 100644 index d27465c556..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-document.md +++ /dev/null @@ -1,13 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/documents/{documentId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - -{ - "data": {}, - "permissions": ["read(\"any\")"] -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-email-attribute.md deleted file mode 100644 index 8e13c9222f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/email/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "required": false, - "default": "email@example.com" -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-enum-attribute.md deleted file mode 100644 index ee3baf5c85..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "elements": [], - "required": false, - "default": "<DEFAULT>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-float-attribute.md deleted file mode 100644 index 871eaf1ab8..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,13 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/float/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "required": false, - "min": 0, - "max": 0, - "default": 0 -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-integer-attribute.md deleted file mode 100644 index 0673c67e3a..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,13 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "required": false, - "min": 0, - "max": 0, - "default": 0 -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-ip-attribute.md deleted file mode 100644 index dc60998b6d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "required": false, - "default": -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-relationship-attribute.md deleted file mode 100644 index f7aaa6ca1b..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,10 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "onDelete": "cascade" -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-string-attribute.md deleted file mode 100644 index fd6ae0b8f8..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/string/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "required": false, - "default": "<DEFAULT>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-rest/examples/databases/update-url-attribute.md deleted file mode 100644 index b677970863..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/url/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "required": false, - "default": "https://example.com" -} diff --git a/docs/examples/1.6.x/server-rest/examples/databases/update.md b/docs/examples/1.6.x/server-rest/examples/databases/update.md deleted file mode 100644 index 0fae967e7b..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/databases/update.md +++ /dev/null @@ -1,11 +0,0 @@ -PUT /v1/databases/{databaseId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/create-build.md b/docs/examples/1.6.x/server-rest/examples/functions/create-build.md deleted file mode 100644 index 584609d1da..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/create-build.md +++ /dev/null @@ -1,10 +0,0 @@ -POST /v1/functions/{functionId}/deployments/{deploymentId}/build HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "buildId": "<BUILD_ID>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-rest/examples/functions/create-deployment.md deleted file mode 100644 index b822c3245c..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/create-deployment.md +++ /dev/null @@ -1,30 +0,0 @@ -POST /v1/functions/{functionId}/deployments HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -Content-Length: *Length of your entity body in bytes* - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="entrypoint" - -"<ENTRYPOINT>" - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="commands" - -"<COMMANDS>" - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="code" - -cf 94 84 24 8d c4 91 10 0f dc 54 26 6c 8e 4b bc -e8 ee 55 94 29 e7 94 89 19 26 28 01 26 29 3f 16... - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="activate" - -false - ---cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/server-rest/examples/functions/create-execution.md b/docs/examples/1.6.x/server-rest/examples/functions/create-execution.md deleted file mode 100644 index 594eed59b4..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/create-execution.md +++ /dev/null @@ -1,17 +0,0 @@ -POST /v1/functions/{functionId}/executions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - -{ - "body": "<BODY>", - "async": false, - "path": "<PATH>", - "method": "GET", - "headers": {}, - "scheduledAt": -} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/create-variable.md b/docs/examples/1.6.x/server-rest/examples/functions/create-variable.md deleted file mode 100644 index 511efbeb5a..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/create-variable.md +++ /dev/null @@ -1,11 +0,0 @@ -POST /v1/functions/{functionId}/variables HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": "<KEY>", - "value": "<VALUE>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/create.md b/docs/examples/1.6.x/server-rest/examples/functions/create.md deleted file mode 100644 index 89addac4fb..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/create.md +++ /dev/null @@ -1,30 +0,0 @@ -POST /v1/functions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "functionId": "<FUNCTION_ID>", - "name": "<NAME>", - "runtime": "node-14.5", - "execute": ["any"], - "events": [], - "schedule": , - "timeout": 1, - "enabled": false, - "logging": false, - "entrypoint": "<ENTRYPOINT>", - "commands": "<COMMANDS>", - "scopes": [], - "installationId": "<INSTALLATION_ID>", - "providerRepositoryId": "<PROVIDER_REPOSITORY_ID>", - "providerBranch": "<PROVIDER_BRANCH>", - "providerSilentMode": false, - "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>", - "templateRepository": "<TEMPLATE_REPOSITORY>", - "templateOwner": "<TEMPLATE_OWNER>", - "templateRootDirectory": "<TEMPLATE_ROOT_DIRECTORY>", - "templateBranch": "<TEMPLATE_BRANCH>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-rest/examples/functions/delete-deployment.md deleted file mode 100644 index 1d80de488f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/delete-deployment.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-rest/examples/functions/delete-execution.md deleted file mode 100644 index bc34b12e9a..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/delete-execution.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/functions/{functionId}/executions/{executionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-rest/examples/functions/delete-variable.md deleted file mode 100644 index a9ec4ecde1..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/delete-variable.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/functions/{functionId}/variables/{variableId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/delete.md b/docs/examples/1.6.x/server-rest/examples/functions/delete.md deleted file mode 100644 index 9916ab6016..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/delete.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/functions/{functionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-rest/examples/functions/download-deployment.md deleted file mode 100644 index 3bcb92b0e4..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/download-deployment.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/functions/{functionId}/deployments/{deploymentId}/download HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-rest/examples/functions/get-deployment.md deleted file mode 100644 index 882a5ec659..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/get-deployment.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/get-execution.md b/docs/examples/1.6.x/server-rest/examples/functions/get-execution.md deleted file mode 100644 index a14c896a6f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/get-execution.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/functions/{functionId}/executions/{executionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/get-variable.md b/docs/examples/1.6.x/server-rest/examples/functions/get-variable.md deleted file mode 100644 index 435de87d1d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/get-variable.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/functions/{functionId}/variables/{variableId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/get.md b/docs/examples/1.6.x/server-rest/examples/functions/get.md deleted file mode 100644 index 6a763ec557..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/get.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/functions/{functionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-rest/examples/functions/list-deployments.md deleted file mode 100644 index 32d813313c..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/list-deployments.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/functions/{functionId}/deployments HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/list-executions.md b/docs/examples/1.6.x/server-rest/examples/functions/list-executions.md deleted file mode 100644 index e2d75d27c0..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/list-executions.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/functions/{functionId}/executions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-rest/examples/functions/list-runtimes.md deleted file mode 100644 index 358bcedfcd..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/list-runtimes.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/functions/runtimes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/list-variables.md b/docs/examples/1.6.x/server-rest/examples/functions/list-variables.md deleted file mode 100644 index 48fb392980..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/list-variables.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/functions/{functionId}/variables HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/list.md b/docs/examples/1.6.x/server-rest/examples/functions/list.md deleted file mode 100644 index a8cb40e2f3..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/list.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/functions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-rest/examples/functions/update-deployment-build.md deleted file mode 100644 index 740c04b91e..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,7 +0,0 @@ -PATCH /v1/functions/{functionId}/deployments/{deploymentId}/build HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-rest/examples/functions/update-deployment.md deleted file mode 100644 index a644913d94..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/update-deployment.md +++ /dev/null @@ -1,7 +0,0 @@ -PATCH /v1/functions/{functionId}/deployments/{deploymentId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/functions/update-variable.md b/docs/examples/1.6.x/server-rest/examples/functions/update-variable.md deleted file mode 100644 index 0fdd3ac5f5..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/update-variable.md +++ /dev/null @@ -1,11 +0,0 @@ -PUT /v1/functions/{functionId}/variables/{variableId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "key": "<KEY>", - "value": "<VALUE>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/functions/update.md b/docs/examples/1.6.x/server-rest/examples/functions/update.md deleted file mode 100644 index c74161a96c..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/functions/update.md +++ /dev/null @@ -1,25 +0,0 @@ -PUT /v1/functions/{functionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "runtime": "node-14.5", - "execute": ["any"], - "events": [], - "schedule": , - "timeout": 1, - "enabled": false, - "logging": false, - "entrypoint": "<ENTRYPOINT>", - "commands": "<COMMANDS>", - "scopes": [], - "installationId": "<INSTALLATION_ID>", - "providerRepositoryId": "<PROVIDER_REPOSITORY_ID>", - "providerBranch": "<PROVIDER_BRANCH>", - "providerSilentMode": false, - "providerRootDirectory": "<PROVIDER_ROOT_DIRECTORY>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/graphql/mutation.md b/docs/examples/1.6.x/server-rest/examples/graphql/mutation.md deleted file mode 100644 index 7e367323ae..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/graphql/mutation.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/graphql/mutation HTTP/1.1 -Host: cloud.appwrite.io -X-Sdk-Graphql: true -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "query": {} -} diff --git a/docs/examples/1.6.x/server-rest/examples/graphql/query.md b/docs/examples/1.6.x/server-rest/examples/graphql/query.md deleted file mode 100644 index 2b7f32fd94..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/graphql/query.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/graphql HTTP/1.1 -Host: cloud.appwrite.io -X-Sdk-Graphql: true -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "query": {} -} diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-rest/examples/health/get-antivirus.md deleted file mode 100644 index 4210461968..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-antivirus.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/anti-virus HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-cache.md b/docs/examples/1.6.x/server-rest/examples/health/get-cache.md deleted file mode 100644 index b0a322f80f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-cache.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/cache HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-certificate.md b/docs/examples/1.6.x/server-rest/examples/health/get-certificate.md deleted file mode 100644 index f183ecb555..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-certificate.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/certificate HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-d-b.md b/docs/examples/1.6.x/server-rest/examples/health/get-d-b.md deleted file mode 100644 index 2685c7e230..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-d-b.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/db HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-rest/examples/health/get-failed-jobs.md deleted file mode 100644 index 16fd22f6a5..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/failed/{name} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-rest/examples/health/get-pub-sub.md deleted file mode 100644 index 336531207e..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-pub-sub.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/pubsub HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-builds.md deleted file mode 100644 index bed1e14fc8..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-builds.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/builds HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-certificates.md deleted file mode 100644 index a4f9247248..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/certificates HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-databases.md deleted file mode 100644 index ef7e9b66ce..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-databases.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/databases HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-deletes.md deleted file mode 100644 index 9a43c99bf3..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/deletes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-functions.md deleted file mode 100644 index acef066f4a..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-functions.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/functions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-logs.md deleted file mode 100644 index bb5126e7c3..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-logs.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/logs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-mails.md deleted file mode 100644 index ea8f161582..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-mails.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/mails HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-messaging.md deleted file mode 100644 index 74cea8d67e..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/messaging HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-migrations.md deleted file mode 100644 index e7728d8353..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/migrations HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage-dump.md deleted file mode 100644 index 2a9680055e..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/usage-dump HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage.md deleted file mode 100644 index e7cb93391f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-usage.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/usage HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue-webhooks.md deleted file mode 100644 index dbb10191f7..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue/webhooks HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-queue.md b/docs/examples/1.6.x/server-rest/examples/health/get-queue.md deleted file mode 100644 index d0109a6b2c..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-queue.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/queue HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-rest/examples/health/get-storage-local.md deleted file mode 100644 index d7bc8237d9..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-storage-local.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/storage/local HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-storage.md b/docs/examples/1.6.x/server-rest/examples/health/get-storage.md deleted file mode 100644 index b2f8bfee26..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-storage.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/storage HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get-time.md b/docs/examples/1.6.x/server-rest/examples/health/get-time.md deleted file mode 100644 index fa9b52bef0..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get-time.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health/time HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/health/get.md b/docs/examples/1.6.x/server-rest/examples/health/get.md deleted file mode 100644 index 08e20d1a08..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/health/get.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/health HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/locale/get.md b/docs/examples/1.6.x/server-rest/examples/locale/get.md deleted file mode 100644 index c9dbe68a31..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/locale/get.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/locale HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-codes.md b/docs/examples/1.6.x/server-rest/examples/locale/list-codes.md deleted file mode 100644 index 8d0d871db4..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/locale/list-codes.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/locale/codes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-continents.md b/docs/examples/1.6.x/server-rest/examples/locale/list-continents.md deleted file mode 100644 index 8b9799de34..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/locale/list-continents.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/locale/continents HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-rest/examples/locale/list-countries-e-u.md deleted file mode 100644 index 3a121207ac..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/locale/countries/eu HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-rest/examples/locale/list-countries-phones.md deleted file mode 100644 index 1eae458ee3..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/locale/countries/phones HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-countries.md b/docs/examples/1.6.x/server-rest/examples/locale/list-countries.md deleted file mode 100644 index 5ea5cd4ac0..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/locale/list-countries.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/locale/countries HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-rest/examples/locale/list-currencies.md deleted file mode 100644 index cf387187b2..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/locale/list-currencies.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/locale/currencies HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/locale/list-languages.md b/docs/examples/1.6.x/server-rest/examples/locale/list-languages.md deleted file mode 100644 index b0d4d680a1..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/locale/list-languages.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/locale/languages HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-apns-provider.md deleted file mode 100644 index bcbf1be099..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -POST /v1/messaging/providers/apns HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "providerId": "<PROVIDER_ID>", - "name": "<NAME>", - "authKey": "<AUTH_KEY>", - "authKeyId": "<AUTH_KEY_ID>", - "teamId": "<TEAM_ID>", - "bundleId": "<BUNDLE_ID>", - "sandbox": false, - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-email.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-email.md deleted file mode 100644 index 49b34ce5dd..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-email.md +++ /dev/null @@ -1,21 +0,0 @@ -POST /v1/messaging/messages/email HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "messageId": "<MESSAGE_ID>", - "subject": "<SUBJECT>", - "content": "<CONTENT>", - "topics": [], - "users": [], - "targets": [], - "cc": [], - "bcc": [], - "attachments": [], - "draft": false, - "html": false, - "scheduledAt": -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-fcm-provider.md deleted file mode 100644 index 75355675c6..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/messaging/providers/fcm HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "providerId": "<PROVIDER_ID>", - "name": "<NAME>", - "serviceAccountJSON": {}, - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index 2516714a65..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -POST /v1/messaging/providers/mailgun HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "providerId": "<PROVIDER_ID>", - "name": "<NAME>", - "apiKey": "<API_KEY>", - "domain": "<DOMAIN>", - "isEuRegion": false, - "fromName": "<FROM_NAME>", - "fromEmail": "email@example.com", - "replyToName": "<REPLY_TO_NAME>", - "replyToEmail": "email@example.com", - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-msg91provider.md deleted file mode 100644 index 776568c2e1..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,15 +0,0 @@ -POST /v1/messaging/providers/msg91 HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "providerId": "<PROVIDER_ID>", - "name": "<NAME>", - "templateId": "<TEMPLATE_ID>", - "senderId": "<SENDER_ID>", - "authKey": "<AUTH_KEY>", - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-push.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-push.md deleted file mode 100644 index cb95ab984d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-push.md +++ /dev/null @@ -1,25 +0,0 @@ -POST /v1/messaging/messages/push HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "messageId": "<MESSAGE_ID>", - "title": "<TITLE>", - "body": "<BODY>", - "topics": [], - "users": [], - "targets": [], - "data": {}, - "action": "<ACTION>", - "image": "[ID1:ID2]", - "icon": "<ICON>", - "sound": "<SOUND>", - "color": "<COLOR>", - "tag": "<TAG>", - "badge": "<BADGE>", - "draft": false, - "scheduledAt": -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index 4ff66b4248..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -POST /v1/messaging/providers/sendgrid HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "providerId": "<PROVIDER_ID>", - "name": "<NAME>", - "apiKey": "<API_KEY>", - "fromName": "<FROM_NAME>", - "fromEmail": "email@example.com", - "replyToName": "<REPLY_TO_NAME>", - "replyToEmail": "email@example.com", - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-sms.md deleted file mode 100644 index 3549a2c8ce..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-sms.md +++ /dev/null @@ -1,16 +0,0 @@ -POST /v1/messaging/messages/sms HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "messageId": "<MESSAGE_ID>", - "content": "<CONTENT>", - "topics": [], - "users": [], - "targets": [], - "draft": false, - "scheduledAt": -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-smtp-provider.md deleted file mode 100644 index 35c3753cd6..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,23 +0,0 @@ -POST /v1/messaging/providers/smtp HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "providerId": "<PROVIDER_ID>", - "name": "<NAME>", - "host": "<HOST>", - "port": 1, - "username": "<USERNAME>", - "password": "<PASSWORD>", - "encryption": "none", - "autoTLS": false, - "mailer": "<MAILER>", - "fromName": "<FROM_NAME>", - "fromEmail": "email@example.com", - "replyToName": "<REPLY_TO_NAME>", - "replyToEmail": "email@example.com", - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-subscriber.md deleted file mode 100644 index fc88e3c12d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-JWT: <YOUR_JWT> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "subscriberId": "<SUBSCRIBER_ID>", - "targetId": "<TARGET_ID>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-telesign-provider.md deleted file mode 100644 index 57d1d0ebd6..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -POST /v1/messaging/providers/telesign HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "providerId": "<PROVIDER_ID>", - "name": "<NAME>", - "from": "+12065550100", - "customerId": "<CUSTOMER_ID>", - "apiKey": "<API_KEY>", - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index b7b830601f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -POST /v1/messaging/providers/textmagic HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "providerId": "<PROVIDER_ID>", - "name": "<NAME>", - "from": "+12065550100", - "username": "<USERNAME>", - "apiKey": "<API_KEY>", - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-topic.md deleted file mode 100644 index a805ac5951..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-topic.md +++ /dev/null @@ -1,12 +0,0 @@ -POST /v1/messaging/topics HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "topicId": "<TOPIC_ID>", - "name": "<NAME>", - "subscribe": ["any"] -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-twilio-provider.md deleted file mode 100644 index b0d8dbe432..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -POST /v1/messaging/providers/twilio HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "providerId": "<PROVIDER_ID>", - "name": "<NAME>", - "from": "+12065550100", - "accountSid": "<ACCOUNT_SID>", - "authToken": "<AUTH_TOKEN>", - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/create-vonage-provider.md deleted file mode 100644 index 0366560f2b..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,15 +0,0 @@ -POST /v1/messaging/providers/vonage HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "providerId": "<PROVIDER_ID>", - "name": "<NAME>", - "from": "+12065550100", - "apiKey": "<API_KEY>", - "apiSecret": "<API_SECRET>", - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/delete-provider.md deleted file mode 100644 index 138eddcde4..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/delete-provider.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/messaging/providers/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-rest/examples/messaging/delete-subscriber.md deleted file mode 100644 index bbaa568a5c..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,9 +0,0 @@ -DELETE /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-JWT: <YOUR_JWT> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-rest/examples/messaging/delete-topic.md deleted file mode 100644 index a3faad27a2..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/delete-topic.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/messaging/topics/{topicId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/delete.md b/docs/examples/1.6.x/server-rest/examples/messaging/delete.md deleted file mode 100644 index 84997d4be9..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/delete.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/messaging/messages/{messageId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/get-message.md b/docs/examples/1.6.x/server-rest/examples/messaging/get-message.md deleted file mode 100644 index f64f9d1a7d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/get-message.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/messages/{messageId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/get-provider.md deleted file mode 100644 index 499fb6f685..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/get-provider.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/providers/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-rest/examples/messaging/get-subscriber.md deleted file mode 100644 index 25922d4792..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/topics/{topicId}/subscribers/{subscriberId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-rest/examples/messaging/get-topic.md deleted file mode 100644 index 9eba673740..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/get-topic.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/topics/{topicId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-message-logs.md deleted file mode 100644 index f9caa0bc3a..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/messages/{messageId}/logs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-messages.md deleted file mode 100644 index 509a029b2c..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/list-messages.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/messages HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-provider-logs.md deleted file mode 100644 index b083fc766f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/providers/{providerId}/logs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-providers.md deleted file mode 100644 index 214b31bc8d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/list-providers.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/providers HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index ddbc4f6aa5..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/subscribers/{subscriberId}/logs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-subscribers.md deleted file mode 100644 index eefcfff199..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/topics/{topicId}/subscribers HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-targets.md deleted file mode 100644 index c8bb1791e3..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/list-targets.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/messages/{messageId}/targets HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-topic-logs.md deleted file mode 100644 index 3225bde3ce..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/topics/{topicId}/logs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-rest/examples/messaging/list-topics.md deleted file mode 100644 index f752e77c47..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/list-topics.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/messaging/topics HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-apns-provider.md deleted file mode 100644 index f26ee35f70..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,16 +0,0 @@ -PATCH /v1/messaging/providers/apns/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "enabled": false, - "authKey": "<AUTH_KEY>", - "authKeyId": "<AUTH_KEY_ID>", - "teamId": "<TEAM_ID>", - "bundleId": "<BUNDLE_ID>", - "sandbox": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-email.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-email.md deleted file mode 100644 index 22d169c354..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-email.md +++ /dev/null @@ -1,20 +0,0 @@ -PATCH /v1/messaging/messages/email/{messageId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "topics": [], - "users": [], - "targets": [], - "subject": "<SUBJECT>", - "content": "<CONTENT>", - "draft": false, - "html": false, - "cc": [], - "bcc": [], - "scheduledAt": , - "attachments": [] -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-fcm-provider.md deleted file mode 100644 index d6802ba1ce..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/messaging/providers/fcm/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "enabled": false, - "serviceAccountJSON": {} -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index 818ad01ae3..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -PATCH /v1/messaging/providers/mailgun/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "apiKey": "<API_KEY>", - "domain": "<DOMAIN>", - "isEuRegion": false, - "enabled": false, - "fromName": "<FROM_NAME>", - "fromEmail": "email@example.com", - "replyToName": "<REPLY_TO_NAME>", - "replyToEmail": "<REPLY_TO_EMAIL>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-msg91provider.md deleted file mode 100644 index 721a590602..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,14 +0,0 @@ -PATCH /v1/messaging/providers/msg91/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "enabled": false, - "templateId": "<TEMPLATE_ID>", - "senderId": "<SENDER_ID>", - "authKey": "<AUTH_KEY>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-push.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-push.md deleted file mode 100644 index 4bef5e902f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-push.md +++ /dev/null @@ -1,24 +0,0 @@ -PATCH /v1/messaging/messages/push/{messageId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "topics": [], - "users": [], - "targets": [], - "title": "<TITLE>", - "body": "<BODY>", - "data": {}, - "action": "<ACTION>", - "image": "[ID1:ID2]", - "icon": "<ICON>", - "sound": "<SOUND>", - "color": "<COLOR>", - "tag": "<TAG>", - "badge": 0, - "draft": false, - "scheduledAt": -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index 3ca8af372e..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,16 +0,0 @@ -PATCH /v1/messaging/providers/sendgrid/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "enabled": false, - "apiKey": "<API_KEY>", - "fromName": "<FROM_NAME>", - "fromEmail": "email@example.com", - "replyToName": "<REPLY_TO_NAME>", - "replyToEmail": "<REPLY_TO_EMAIL>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-sms.md deleted file mode 100644 index 08ac37f45b..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-sms.md +++ /dev/null @@ -1,15 +0,0 @@ -PATCH /v1/messaging/messages/sms/{messageId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "topics": [], - "users": [], - "targets": [], - "content": "<CONTENT>", - "draft": false, - "scheduledAt": -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-smtp-provider.md deleted file mode 100644 index c37ff1027c..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -PATCH /v1/messaging/providers/smtp/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "host": "<HOST>", - "port": 1, - "username": "<USERNAME>", - "password": "<PASSWORD>", - "encryption": "none", - "autoTLS": false, - "mailer": "<MAILER>", - "fromName": "<FROM_NAME>", - "fromEmail": "email@example.com", - "replyToName": "<REPLY_TO_NAME>", - "replyToEmail": "<REPLY_TO_EMAIL>", - "enabled": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-telesign-provider.md deleted file mode 100644 index 50b48fd655..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,14 +0,0 @@ -PATCH /v1/messaging/providers/telesign/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "enabled": false, - "customerId": "<CUSTOMER_ID>", - "apiKey": "<API_KEY>", - "from": "<FROM>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index f9692cc945..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,14 +0,0 @@ -PATCH /v1/messaging/providers/textmagic/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "enabled": false, - "username": "<USERNAME>", - "apiKey": "<API_KEY>", - "from": "<FROM>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-topic.md deleted file mode 100644 index 50fd57acd3..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-topic.md +++ /dev/null @@ -1,11 +0,0 @@ -PATCH /v1/messaging/topics/{topicId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "subscribe": ["any"] -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-twilio-provider.md deleted file mode 100644 index 78dbe9dcea..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,14 +0,0 @@ -PATCH /v1/messaging/providers/twilio/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "enabled": false, - "accountSid": "<ACCOUNT_SID>", - "authToken": "<AUTH_TOKEN>", - "from": "<FROM>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-rest/examples/messaging/update-vonage-provider.md deleted file mode 100644 index cc17380616..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,14 +0,0 @@ -PATCH /v1/messaging/providers/vonage/{providerId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "enabled": false, - "apiKey": "<API_KEY>", - "apiSecret": "<API_SECRET>", - "from": "<FROM>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-rest/examples/storage/create-bucket.md deleted file mode 100644 index 6c11c5f0c6..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/create-bucket.md +++ /dev/null @@ -1,19 +0,0 @@ -POST /v1/storage/buckets HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "bucketId": "<BUCKET_ID>", - "name": "<NAME>", - "permissions": ["read(\"any\")"], - "fileSecurity": false, - "enabled": false, - "maximumFileSize": 1, - "allowedFileExtensions": [], - "compression": "none", - "encryption": false, - "antivirus": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/storage/create-file.md b/docs/examples/1.6.x/server-rest/examples/storage/create-file.md deleted file mode 100644 index c93c525987..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/create-file.md +++ /dev/null @@ -1,27 +0,0 @@ -POST /v1/storage/buckets/{bucketId}/files HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: multipart/form-data; boundary="cec8e8123c05ba25" -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> -Content-Length: *Length of your entity body in bytes* - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="fileId" - -"<FILE_ID>" - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="file" - -cf 94 84 24 8d c4 91 10 0f dc 54 26 6c 8e 4b bc -e8 ee 55 94 29 e7 94 89 19 26 28 01 26 29 3f 16... - ---cec8e8123c05ba25 -Content-Disposition: form-data; name="permissions[]" - -["read(\"any\")"] - ---cec8e8123c05ba25-- diff --git a/docs/examples/1.6.x/server-rest/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-rest/examples/storage/delete-bucket.md deleted file mode 100644 index 51898e1078..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/delete-bucket.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/storage/buckets/{bucketId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/storage/delete-file.md b/docs/examples/1.6.x/server-rest/examples/storage/delete-file.md deleted file mode 100644 index f0c6cb1fc0..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/delete-file.md +++ /dev/null @@ -1,9 +0,0 @@ -DELETE /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-rest/examples/storage/get-bucket.md deleted file mode 100644 index b201700f17..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/get-bucket.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/storage/buckets/{bucketId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-rest/examples/storage/get-file-download.md deleted file mode 100644 index 5559ffa32e..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/get-file-download.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/storage/buckets/{bucketId}/files/{fileId}/download HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-rest/examples/storage/get-file-preview.md deleted file mode 100644 index dd25c4ca29..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/get-file-preview.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/storage/buckets/{bucketId}/files/{fileId}/preview HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-rest/examples/storage/get-file-view.md deleted file mode 100644 index 4e08d2868b..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/get-file-view.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/storage/buckets/{bucketId}/files/{fileId}/view HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/storage/get-file.md b/docs/examples/1.6.x/server-rest/examples/storage/get-file.md deleted file mode 100644 index 4f878588b1..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/get-file.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-rest/examples/storage/list-buckets.md deleted file mode 100644 index 337c39c4ae..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/list-buckets.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/storage/buckets HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/storage/list-files.md b/docs/examples/1.6.x/server-rest/examples/storage/list-files.md deleted file mode 100644 index 0644b40320..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/list-files.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/storage/buckets/{bucketId}/files HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-rest/examples/storage/update-bucket.md deleted file mode 100644 index 003d461901..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/update-bucket.md +++ /dev/null @@ -1,18 +0,0 @@ -PUT /v1/storage/buckets/{bucketId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>", - "permissions": ["read(\"any\")"], - "fileSecurity": false, - "enabled": false, - "maximumFileSize": 1, - "allowedFileExtensions": [], - "compression": "none", - "encryption": false, - "antivirus": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/storage/update-file.md b/docs/examples/1.6.x/server-rest/examples/storage/update-file.md deleted file mode 100644 index 6ee412b647..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/storage/update-file.md +++ /dev/null @@ -1,13 +0,0 @@ -PUT /v1/storage/buckets/{bucketId}/files/{fileId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - -{ - "name": "<NAME>", - "permissions": ["read(\"any\")"] -} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/create-membership.md b/docs/examples/1.6.x/server-rest/examples/teams/create-membership.md deleted file mode 100644 index 6d5e8a3b48..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/create-membership.md +++ /dev/null @@ -1,17 +0,0 @@ -POST /v1/teams/{teamId}/memberships HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - -{ - "email": "email@example.com", - "userId": "<USER_ID>", - "phone": "+12065550100", - "roles": [], - "url": "https://example.com", - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/create.md b/docs/examples/1.6.x/server-rest/examples/teams/create.md deleted file mode 100644 index bc273cb35f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/create.md +++ /dev/null @@ -1,14 +0,0 @@ -POST /v1/teams HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - -{ - "teamId": "<TEAM_ID>", - "name": "<NAME>", - "roles": [] -} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-rest/examples/teams/delete-membership.md deleted file mode 100644 index 32e5ed4177..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/delete-membership.md +++ /dev/null @@ -1,9 +0,0 @@ -DELETE /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/teams/delete.md b/docs/examples/1.6.x/server-rest/examples/teams/delete.md deleted file mode 100644 index 8cf0c667a3..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/delete.md +++ /dev/null @@ -1,9 +0,0 @@ -DELETE /v1/teams/{teamId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/teams/get-membership.md b/docs/examples/1.6.x/server-rest/examples/teams/get-membership.md deleted file mode 100644 index 40d0b5601e..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/get-membership.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-rest/examples/teams/get-prefs.md deleted file mode 100644 index d143f6b904..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/get-prefs.md +++ /dev/null @@ -1,8 +0,0 @@ -GET /v1/teams/{teamId}/prefs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/teams/get.md b/docs/examples/1.6.x/server-rest/examples/teams/get.md deleted file mode 100644 index 0ca3c655c5..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/get.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/teams/{teamId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-rest/examples/teams/list-memberships.md deleted file mode 100644 index 39309d9c75..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/list-memberships.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/teams/{teamId}/memberships HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/teams/list.md b/docs/examples/1.6.x/server-rest/examples/teams/list.md deleted file mode 100644 index e02fb01ce3..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/list.md +++ /dev/null @@ -1,9 +0,0 @@ -GET /v1/teams HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - diff --git a/docs/examples/1.6.x/server-rest/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-rest/examples/teams/update-membership-status.md deleted file mode 100644 index 5cc6b91536..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/update-membership-status.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/teams/{teamId}/memberships/{membershipId}/status HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "userId": "<USER_ID>", - "secret": "<SECRET>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/update-membership.md b/docs/examples/1.6.x/server-rest/examples/teams/update-membership.md deleted file mode 100644 index cac7c16bdb..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/update-membership.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/teams/{teamId}/memberships/{membershipId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - -{ - "roles": [] -} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/update-name.md b/docs/examples/1.6.x/server-rest/examples/teams/update-name.md deleted file mode 100644 index d36b3db779..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/update-name.md +++ /dev/null @@ -1,12 +0,0 @@ -PUT /v1/teams/{teamId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-Key: <YOUR_API_KEY> -X-Appwrite-JWT: <YOUR_JWT> - -{ - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-rest/examples/teams/update-prefs.md deleted file mode 100644 index d6b42128be..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/teams/update-prefs.md +++ /dev/null @@ -1,11 +0,0 @@ -PUT /v1/teams/{teamId}/prefs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Session: -X-Appwrite-JWT: <YOUR_JWT> - -{ - "prefs": {} -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-rest/examples/users/create-argon2user.md deleted file mode 100644 index f21a7661e4..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-argon2user.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/users/argon2 HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "password": "password", - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-rest/examples/users/create-bcrypt-user.md deleted file mode 100644 index 1f28133fb1..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/users/bcrypt HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "password": "password", - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-rest/examples/users/create-j-w-t.md deleted file mode 100644 index 7dc3943dfd..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-j-w-t.md +++ /dev/null @@ -1,11 +0,0 @@ -POST /v1/users/{userId}/jwts HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "sessionId": "<SESSION_ID>", - "duration": 0 -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-rest/examples/users/create-m-d5user.md deleted file mode 100644 index e81ee952ad..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-m-d5user.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/users/md5 HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "password": "password", - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index 39eb9ec6f8..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,7 +0,0 @@ -PATCH /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-rest/examples/users/create-p-h-pass-user.md deleted file mode 100644 index cfbf131cc6..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,13 +0,0 @@ -POST /v1/users/phpass HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "password": "password", - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-rest/examples/users/create-s-h-a-user.md deleted file mode 100644 index 4d67231999..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,14 +0,0 @@ -POST /v1/users/sha HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "password": "password", - "passwordVersion": "sha1", - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index d81ba878b1..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,16 +0,0 @@ -POST /v1/users/scrypt-modified HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "password": "password", - "passwordSalt": "<PASSWORD_SALT>", - "passwordSaltSeparator": "<PASSWORD_SALT_SEPARATOR>", - "passwordSignerKey": "<PASSWORD_SIGNER_KEY>", - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-user.md deleted file mode 100644 index 21dc205a30..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,18 +0,0 @@ -POST /v1/users/scrypt HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "password": "password", - "passwordSalt": "<PASSWORD_SALT>", - "passwordCpu": 0, - "passwordMemory": 0, - "passwordParallel": 0, - "passwordLength": 0, - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-session.md b/docs/examples/1.6.x/server-rest/examples/users/create-session.md deleted file mode 100644 index 61608c96b0..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-session.md +++ /dev/null @@ -1,7 +0,0 @@ -POST /v1/users/{userId}/sessions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-target.md b/docs/examples/1.6.x/server-rest/examples/users/create-target.md deleted file mode 100644 index 13910ad39c..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-target.md +++ /dev/null @@ -1,14 +0,0 @@ -POST /v1/users/{userId}/targets HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "targetId": "<TARGET_ID>", - "providerType": "email", - "identifier": "<IDENTIFIER>", - "providerId": "<PROVIDER_ID>", - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create-token.md b/docs/examples/1.6.x/server-rest/examples/users/create-token.md deleted file mode 100644 index 90b96725b7..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create-token.md +++ /dev/null @@ -1,11 +0,0 @@ -POST /v1/users/{userId}/tokens HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "length": 4, - "expire": 60 -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/create.md b/docs/examples/1.6.x/server-rest/examples/users/create.md deleted file mode 100644 index 026bba49b3..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/create.md +++ /dev/null @@ -1,14 +0,0 @@ -POST /v1/users HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "userId": "<USER_ID>", - "email": "email@example.com", - "phone": "+12065550100", - "password": , - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete-identity.md b/docs/examples/1.6.x/server-rest/examples/users/delete-identity.md deleted file mode 100644 index eba9192b72..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/delete-identity.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/users/identities/{identityId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-rest/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index 081a59aead..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/users/{userId}/mfa/authenticators/{type} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete-session.md b/docs/examples/1.6.x/server-rest/examples/users/delete-session.md deleted file mode 100644 index f2a1a7079b..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/delete-session.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/users/{userId}/sessions/{sessionId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-rest/examples/users/delete-sessions.md deleted file mode 100644 index 11a55e3249..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/delete-sessions.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/users/{userId}/sessions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete-target.md b/docs/examples/1.6.x/server-rest/examples/users/delete-target.md deleted file mode 100644 index 7a84c4f764..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/delete-target.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/users/{userId}/targets/{targetId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/delete.md b/docs/examples/1.6.x/server-rest/examples/users/delete.md deleted file mode 100644 index 44c60c5901..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/delete.md +++ /dev/null @@ -1,7 +0,0 @@ -DELETE /v1/users/{userId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index fd69bac8cb..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/get-prefs.md b/docs/examples/1.6.x/server-rest/examples/users/get-prefs.md deleted file mode 100644 index 3383dc1df1..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/get-prefs.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/users/{userId}/prefs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/get-target.md b/docs/examples/1.6.x/server-rest/examples/users/get-target.md deleted file mode 100644 index 2391d11c38..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/get-target.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/users/{userId}/targets/{targetId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/get.md b/docs/examples/1.6.x/server-rest/examples/users/get.md deleted file mode 100644 index 84cf52eb3d..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/get.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/users/{userId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-identities.md b/docs/examples/1.6.x/server-rest/examples/users/list-identities.md deleted file mode 100644 index 518a46b632..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/list-identities.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/users/identities HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-logs.md b/docs/examples/1.6.x/server-rest/examples/users/list-logs.md deleted file mode 100644 index 08c534aa95..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/list-logs.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/users/{userId}/logs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-memberships.md b/docs/examples/1.6.x/server-rest/examples/users/list-memberships.md deleted file mode 100644 index c273866a40..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/list-memberships.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/users/{userId}/memberships HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-rest/examples/users/list-mfa-factors.md deleted file mode 100644 index 13c3685384..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/users/{userId}/mfa/factors HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-sessions.md b/docs/examples/1.6.x/server-rest/examples/users/list-sessions.md deleted file mode 100644 index fff9772c2b..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/list-sessions.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/users/{userId}/sessions HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/list-targets.md b/docs/examples/1.6.x/server-rest/examples/users/list-targets.md deleted file mode 100644 index 7e5151d1e2..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/list-targets.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/users/{userId}/targets HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/list.md b/docs/examples/1.6.x/server-rest/examples/users/list.md deleted file mode 100644 index c7916d3b08..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/list.md +++ /dev/null @@ -1,7 +0,0 @@ -GET /v1/users HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-rest/examples/users/update-email-verification.md deleted file mode 100644 index b0c7def168..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-email-verification.md +++ /dev/null @@ -1,10 +0,0 @@ -PATCH /v1/users/{userId}/verification HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "emailVerification": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-email.md b/docs/examples/1.6.x/server-rest/examples/users/update-email.md deleted file mode 100644 index 1ea77d58b9..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-email.md +++ /dev/null @@ -1,10 +0,0 @@ -PATCH /v1/users/{userId}/email HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "email": "email@example.com" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-labels.md b/docs/examples/1.6.x/server-rest/examples/users/update-labels.md deleted file mode 100644 index 50e33667ac..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-labels.md +++ /dev/null @@ -1,10 +0,0 @@ -PUT /v1/users/{userId}/labels HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "labels": [] -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-rest/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index 1164bc5735..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,7 +0,0 @@ -PUT /v1/users/{userId}/mfa/recovery-codes HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-mfa.md b/docs/examples/1.6.x/server-rest/examples/users/update-mfa.md deleted file mode 100644 index a63bd11e4a..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-mfa.md +++ /dev/null @@ -1,10 +0,0 @@ -PATCH /v1/users/{userId}/mfa HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "mfa": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-name.md b/docs/examples/1.6.x/server-rest/examples/users/update-name.md deleted file mode 100644 index 442b9cce84..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-name.md +++ /dev/null @@ -1,10 +0,0 @@ -PATCH /v1/users/{userId}/name HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-password.md b/docs/examples/1.6.x/server-rest/examples/users/update-password.md deleted file mode 100644 index 4c0e964b47..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-password.md +++ /dev/null @@ -1,10 +0,0 @@ -PATCH /v1/users/{userId}/password HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "password": -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-rest/examples/users/update-phone-verification.md deleted file mode 100644 index 5a446f2a5e..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-phone-verification.md +++ /dev/null @@ -1,10 +0,0 @@ -PATCH /v1/users/{userId}/verification/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "phoneVerification": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-phone.md b/docs/examples/1.6.x/server-rest/examples/users/update-phone.md deleted file mode 100644 index 2f30e7590f..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-phone.md +++ /dev/null @@ -1,10 +0,0 @@ -PATCH /v1/users/{userId}/phone HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "number": "+12065550100" -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-prefs.md b/docs/examples/1.6.x/server-rest/examples/users/update-prefs.md deleted file mode 100644 index 7d0171cc50..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-prefs.md +++ /dev/null @@ -1,10 +0,0 @@ -PATCH /v1/users/{userId}/prefs HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "prefs": {} -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-status.md b/docs/examples/1.6.x/server-rest/examples/users/update-status.md deleted file mode 100644 index 2fbdd7a180..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-status.md +++ /dev/null @@ -1,10 +0,0 @@ -PATCH /v1/users/{userId}/status HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "status": false -} diff --git a/docs/examples/1.6.x/server-rest/examples/users/update-target.md b/docs/examples/1.6.x/server-rest/examples/users/update-target.md deleted file mode 100644 index 4b9815cb8a..0000000000 --- a/docs/examples/1.6.x/server-rest/examples/users/update-target.md +++ /dev/null @@ -1,12 +0,0 @@ -PATCH /v1/users/{userId}/targets/{targetId} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.5.0 -X-Appwrite-Project: <YOUR_PROJECT_ID> -X-Appwrite-Key: <YOUR_API_KEY> - -{ - "identifier": "<IDENTIFIER>", - "providerId": "<PROVIDER_ID>", - "name": "<NAME>" -} diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-ruby/examples/account/create-anonymous-session.md deleted file mode 100644 index 5e73f3f0d8..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,11 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.create_anonymous_session() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-ruby/examples/account/create-email-password-session.md deleted file mode 100644 index d5391d881a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-email-password-session.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.create_email_password_session( - email: 'email@example.com', - password: 'password' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-email-token.md b/docs/examples/1.6.x/server-ruby/examples/account/create-email-token.md deleted file mode 100644 index 823cc108f0..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-email-token.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.create_email_token( - user_id: '<USER_ID>', - email: 'email@example.com', - phrase: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-ruby/examples/account/create-j-w-t.md deleted file mode 100644 index a6632a73c6..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-j-w-t.md +++ /dev/null @@ -1,11 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.create_jwt() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-ruby/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 015ad800f8..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.create_magic_url_token( - user_id: '<USER_ID>', - email: 'email@example.com', - url: 'https://example.com', # optional - phrase: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-authenticator.md deleted file mode 100644 index cec05887a2..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.create_mfa_authenticator( - type: AuthenticatorType::TOTP -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-challenge.md deleted file mode 100644 index d4e9d8ed20..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.create_mfa_challenge( - factor: AuthenticationFactor::EMAIL -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index bf66c399b6..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.create_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-ruby/examples/account/create-o-auth2token.md deleted file mode 100644 index 5b17f1c29d..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.create_o_auth2_token( - provider: OAuthProvider::AMAZON, - success: 'https://example.com', # optional - failure: 'https://example.com', # optional - scopes: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-ruby/examples/account/create-phone-token.md deleted file mode 100644 index 592b964c37..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-phone-token.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.create_phone_token( - user_id: '<USER_ID>', - phone: '+12065550100' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-ruby/examples/account/create-phone-verification.md deleted file mode 100644 index 50c0ce0e4a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-phone-verification.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.create_phone_verification() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-recovery.md b/docs/examples/1.6.x/server-ruby/examples/account/create-recovery.md deleted file mode 100644 index 91bf09fd12..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-recovery.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.create_recovery( - email: 'email@example.com', - url: 'https://example.com' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-session.md b/docs/examples/1.6.x/server-ruby/examples/account/create-session.md deleted file mode 100644 index ce6c738667..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-session.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.create_session( - user_id: '<USER_ID>', - secret: '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create-verification.md b/docs/examples/1.6.x/server-ruby/examples/account/create-verification.md deleted file mode 100644 index d4614d47ce..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.create_verification( - url: 'https://example.com' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/create.md b/docs/examples/1.6.x/server-ruby/examples/account/create.md deleted file mode 100644 index 8922cf4241..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/create.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.create( - user_id: '<USER_ID>', - email: 'email@example.com', - password: '', - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/delete-identity.md b/docs/examples/1.6.x/server-ruby/examples/account/delete-identity.md deleted file mode 100644 index 2a3ebb72b2..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/delete-identity.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.delete_identity( - identity_id: '<IDENTITY_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-ruby/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 1d21a5cd43..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.delete_mfa_authenticator( - type: AuthenticatorType::TOTP -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/delete-session.md b/docs/examples/1.6.x/server-ruby/examples/account/delete-session.md deleted file mode 100644 index c597e807a4..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/delete-session.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.delete_session( - session_id: '<SESSION_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-ruby/examples/account/delete-sessions.md deleted file mode 100644 index 379c893da2..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/delete-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.delete_sessions() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index f91b03550e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.get_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/get-prefs.md b/docs/examples/1.6.x/server-ruby/examples/account/get-prefs.md deleted file mode 100644 index 65a1e22885..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/get-prefs.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.get_prefs() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/get-session.md b/docs/examples/1.6.x/server-ruby/examples/account/get-session.md deleted file mode 100644 index d8341c61d9..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/get-session.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.get_session( - session_id: '<SESSION_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/get.md b/docs/examples/1.6.x/server-ruby/examples/account/get.md deleted file mode 100644 index ac2c9d0b3a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/get.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.get() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/list-identities.md b/docs/examples/1.6.x/server-ruby/examples/account/list-identities.md deleted file mode 100644 index 98ae35d512..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/list-identities.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.list_identities( - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/list-logs.md b/docs/examples/1.6.x/server-ruby/examples/account/list-logs.md deleted file mode 100644 index 1462f08cb5..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/list-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.list_logs( - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-ruby/examples/account/list-mfa-factors.md deleted file mode 100644 index c228560721..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.list_mfa_factors() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/list-sessions.md b/docs/examples/1.6.x/server-ruby/examples/account/list-sessions.md deleted file mode 100644 index 8b67920586..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/list-sessions.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.list_sessions() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-email.md b/docs/examples/1.6.x/server-ruby/examples/account/update-email.md deleted file mode 100644 index 66e8e3a1d7..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-email.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_email( - email: 'email@example.com', - password: 'password' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-ruby/examples/account/update-m-f-a.md deleted file mode 100644 index cfb58d4741..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-m-f-a.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_mfa( - mfa: false -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-ruby/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 3635bc1ed7..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.update_magic_url_session( - user_id: '<USER_ID>', - secret: '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-authenticator.md deleted file mode 100644 index 15d964c37e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_mfa_authenticator( - type: AuthenticatorType::TOTP, - otp: '<OTP>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-challenge.md deleted file mode 100644 index f412b4bcbf..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_mfa_challenge( - challenge_id: '<CHALLENGE_ID>', - otp: '<OTP>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index 14b069e99e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_mfa_recovery_codes() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-name.md b/docs/examples/1.6.x/server-ruby/examples/account/update-name.md deleted file mode 100644 index fa7a3e32c1..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-name.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_name( - name: '<NAME>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-password.md b/docs/examples/1.6.x/server-ruby/examples/account/update-password.md deleted file mode 100644 index 7342f7d017..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-password.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_password( - password: '', - old_password: 'password' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-ruby/examples/account/update-phone-session.md deleted file mode 100644 index 46e6abede5..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-phone-session.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - -account = Account.new(client) - -result = account.update_phone_session( - user_id: '<USER_ID>', - secret: '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-ruby/examples/account/update-phone-verification.md deleted file mode 100644 index 662b172f05..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-phone-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_phone_verification( - user_id: '<USER_ID>', - secret: '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-phone.md b/docs/examples/1.6.x/server-ruby/examples/account/update-phone.md deleted file mode 100644 index 8ed5e1d21c..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-phone.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_phone( - phone: '+12065550100', - password: 'password' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-prefs.md b/docs/examples/1.6.x/server-ruby/examples/account/update-prefs.md deleted file mode 100644 index 296a67d683..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_prefs( - prefs: {} -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-recovery.md b/docs/examples/1.6.x/server-ruby/examples/account/update-recovery.md deleted file mode 100644 index 97ac1d4fa5..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-recovery.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_recovery( - user_id: '<USER_ID>', - secret: '<SECRET>', - password: '' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-session.md b/docs/examples/1.6.x/server-ruby/examples/account/update-session.md deleted file mode 100644 index 4bfded0e4e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-session.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_session( - session_id: '<SESSION_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-status.md b/docs/examples/1.6.x/server-ruby/examples/account/update-status.md deleted file mode 100644 index 72b81280a7..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-status.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_status() diff --git a/docs/examples/1.6.x/server-ruby/examples/account/update-verification.md b/docs/examples/1.6.x/server-ruby/examples/account/update-verification.md deleted file mode 100644 index 29f01d3843..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/account/update-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -account = Account.new(client) - -result = account.update_verification( - user_id: '<USER_ID>', - secret: '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-browser.md deleted file mode 100644 index 199e9e26d1..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/avatars/get-browser.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -avatars = Avatars.new(client) - -result = avatars.get_browser( - code: Browser::AVANT_BROWSER, - width: 0, # optional - height: 0, # optional - quality: 0 # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-credit-card.md deleted file mode 100644 index 68e1a1cc0e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -avatars = Avatars.new(client) - -result = avatars.get_credit_card( - code: CreditCard::AMERICAN_EXPRESS, - width: 0, # optional - height: 0, # optional - quality: 0 # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-favicon.md deleted file mode 100644 index 0ebf7fdc05..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/avatars/get-favicon.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -avatars = Avatars.new(client) - -result = avatars.get_favicon( - url: 'https://example.com' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-flag.md deleted file mode 100644 index c249f2fbbc..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/avatars/get-flag.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -avatars = Avatars.new(client) - -result = avatars.get_flag( - code: Flag::AFGHANISTAN, - width: 0, # optional - height: 0, # optional - quality: 0 # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-image.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-image.md deleted file mode 100644 index c21ddf74b5..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/avatars/get-image.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -avatars = Avatars.new(client) - -result = avatars.get_image( - url: 'https://example.com', - width: 0, # optional - height: 0 # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-initials.md deleted file mode 100644 index ffac9acd23..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/avatars/get-initials.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -avatars = Avatars.new(client) - -result = avatars.get_initials( - name: '<NAME>', # optional - width: 0, # optional - height: 0, # optional - background: '' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-ruby/examples/avatars/get-q-r.md deleted file mode 100644 index a5eb84eb01..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/avatars/get-q-r.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -avatars = Avatars.new(client) - -result = avatars.get_qr( - text: '<TEXT>', - size: 1, # optional - margin: 0, # optional - download: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-boolean-attribute.md deleted file mode 100644 index 5d709737f4..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_boolean_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - default: false, # optional - array: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-collection.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-collection.md deleted file mode 100644 index 801c9ad01d..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-collection.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_collection( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - name: '<NAME>', - permissions: ["read("any")"], # optional - document_security: false, # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-datetime-attribute.md deleted file mode 100644 index 5bdd4e234f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_datetime_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - default: '', # optional - array: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-document.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-document.md deleted file mode 100644 index 0dd99aa3a5..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-document.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -databases = Databases.new(client) - -result = databases.create_document( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - document_id: '<DOCUMENT_ID>', - data: {}, - permissions: ["read("any")"] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-email-attribute.md deleted file mode 100644 index dcacad20bf..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_email_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - default: 'email@example.com', # optional - array: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-enum-attribute.md deleted file mode 100644 index 374efab75f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_enum_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - elements: [], - required: false, - default: '<DEFAULT>', # optional - array: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-float-attribute.md deleted file mode 100644 index e90c657582..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_float_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - min: null, # optional - max: null, # optional - default: null, # optional - array: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-index.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-index.md deleted file mode 100644 index e195c5921e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-index.md +++ /dev/null @@ -1,20 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_index( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - type: IndexType::KEY, - attributes: [], - orders: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-integer-attribute.md deleted file mode 100644 index eaafbc3280..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_integer_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - min: null, # optional - max: null, # optional - default: null, # optional - array: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-ip-attribute.md deleted file mode 100644 index babe694df5..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_ip_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - default: '', # optional - array: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-relationship-attribute.md deleted file mode 100644 index 8ed96f53f3..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_relationship_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - related_collection_id: '<RELATED_COLLECTION_ID>', - type: RelationshipType::ONETOONE, - two_way: false, # optional - key: '', # optional - two_way_key: '', # optional - on_delete: RelationMutate::CASCADE # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-string-attribute.md deleted file mode 100644 index 6bf200d122..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_string_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - size: 1, - required: false, - default: '<DEFAULT>', # optional - array: false, # optional - encrypt: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/create-url-attribute.md deleted file mode 100644 index fd39f03085..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_url_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - default: 'https://example.com', # optional - array: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/create.md b/docs/examples/1.6.x/server-ruby/examples/databases/create.md deleted file mode 100644 index d000e1e239..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/create.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.create( - database_id: '<DATABASE_ID>', - name: '<NAME>', - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/delete-attribute.md deleted file mode 100644 index fbcf76ff92..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/delete-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.delete_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-ruby/examples/databases/delete-collection.md deleted file mode 100644 index 4cbc39c552..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/delete-collection.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.delete_collection( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/delete-document.md b/docs/examples/1.6.x/server-ruby/examples/databases/delete-document.md deleted file mode 100644 index de947b04cb..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/delete-document.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -databases = Databases.new(client) - -result = databases.delete_document( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - document_id: '<DOCUMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/delete-index.md b/docs/examples/1.6.x/server-ruby/examples/databases/delete-index.md deleted file mode 100644 index 5249ceaf22..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/delete-index.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.delete_index( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/delete.md b/docs/examples/1.6.x/server-ruby/examples/databases/delete.md deleted file mode 100644 index 31b169f07f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.delete( - database_id: '<DATABASE_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/get-attribute.md deleted file mode 100644 index f1ca6b9545..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/get-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.get_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/get-collection.md b/docs/examples/1.6.x/server-ruby/examples/databases/get-collection.md deleted file mode 100644 index 0c26fb63f2..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/get-collection.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.get_collection( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/get-document.md b/docs/examples/1.6.x/server-ruby/examples/databases/get-document.md deleted file mode 100644 index 35f802ca96..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/get-document.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -databases = Databases.new(client) - -result = databases.get_document( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - document_id: '<DOCUMENT_ID>', - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/get-index.md b/docs/examples/1.6.x/server-ruby/examples/databases/get-index.md deleted file mode 100644 index bb5e831ae7..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/get-index.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.get_index( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/get.md b/docs/examples/1.6.x/server-ruby/examples/databases/get.md deleted file mode 100644 index fb678031bc..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/get.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.get( - database_id: '<DATABASE_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-ruby/examples/databases/list-attributes.md deleted file mode 100644 index 8c15ccdb23..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/list-attributes.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.list_attributes( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/list-collections.md b/docs/examples/1.6.x/server-ruby/examples/databases/list-collections.md deleted file mode 100644 index b04d6dfcbc..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/list-collections.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.list_collections( - database_id: '<DATABASE_ID>', - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/list-documents.md b/docs/examples/1.6.x/server-ruby/examples/databases/list-documents.md deleted file mode 100644 index 8337438bdf..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/list-documents.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -databases = Databases.new(client) - -result = databases.list_documents( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-ruby/examples/databases/list-indexes.md deleted file mode 100644 index 851196b36c..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/list-indexes.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.list_indexes( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/list.md b/docs/examples/1.6.x/server-ruby/examples/databases/list.md deleted file mode 100644 index 76a9472f57..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/list.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.list( - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-boolean-attribute.md deleted file mode 100644 index 1c9ea78263..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_boolean_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - default: false -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-collection.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-collection.md deleted file mode 100644 index 871c2838b5..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-collection.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_collection( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - name: '<NAME>', - permissions: ["read("any")"], # optional - document_security: false, # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-datetime-attribute.md deleted file mode 100644 index 784513a16f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_datetime_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - default: '' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-document.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-document.md deleted file mode 100644 index c870243599..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-document.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -databases = Databases.new(client) - -result = databases.update_document( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - document_id: '<DOCUMENT_ID>', - data: {}, # optional - permissions: ["read("any")"] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-email-attribute.md deleted file mode 100644 index ff8b2a722a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_email_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - default: 'email@example.com' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-enum-attribute.md deleted file mode 100644 index 60acfcad55..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_enum_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - elements: [], - required: false, - default: '<DEFAULT>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-float-attribute.md deleted file mode 100644 index 691aec9c1b..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_float_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - min: null, - max: null, - default: null -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-integer-attribute.md deleted file mode 100644 index 05d0b1a2f8..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_integer_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - min: null, - max: null, - default: null -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-ip-attribute.md deleted file mode 100644 index c0520fa1f0..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_ip_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - default: '' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-relationship-attribute.md deleted file mode 100644 index 58e2e49347..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_relationship_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - on_delete: RelationMutate::CASCADE # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-string-attribute.md deleted file mode 100644 index f065dd2229..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_string_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - default: '<DEFAULT>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-ruby/examples/databases/update-url-attribute.md deleted file mode 100644 index 7778c26ced..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_url_attribute( - database_id: '<DATABASE_ID>', - collection_id: '<COLLECTION_ID>', - key: '', - required: false, - default: 'https://example.com' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/databases/update.md b/docs/examples/1.6.x/server-ruby/examples/databases/update.md deleted file mode 100644 index acafe1ac1f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/databases/update.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -databases = Databases.new(client) - -result = databases.update( - database_id: '<DATABASE_ID>', - name: '<NAME>', - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/create-build.md b/docs/examples/1.6.x/server-ruby/examples/functions/create-build.md deleted file mode 100644 index e2a0c6a48f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/create-build.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.create_build( - function_id: '<FUNCTION_ID>', - deployment_id: '<DEPLOYMENT_ID>', - build_id: '<BUILD_ID>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-ruby/examples/functions/create-deployment.md deleted file mode 100644 index a21bd37d6f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/create-deployment.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.create_deployment( - function_id: '<FUNCTION_ID>', - code: InputFile.from_path('dir/file.png'), - activate: false, - entrypoint: '<ENTRYPOINT>', # optional - commands: '<COMMANDS>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/create-execution.md b/docs/examples/1.6.x/server-ruby/examples/functions/create-execution.md deleted file mode 100644 index d2c5786418..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/create-execution.md +++ /dev/null @@ -1,20 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -functions = Functions.new(client) - -result = functions.create_execution( - function_id: '<FUNCTION_ID>', - body: '<BODY>', # optional - async: false, # optional - path: '<PATH>', # optional - method: ExecutionMethod::GET, # optional - headers: {}, # optional - scheduled_at: '' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/create-variable.md b/docs/examples/1.6.x/server-ruby/examples/functions/create-variable.md deleted file mode 100644 index 0a5de5506a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/create-variable.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.create_variable( - function_id: '<FUNCTION_ID>', - key: '<KEY>', - value: '<VALUE>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/create.md b/docs/examples/1.6.x/server-ruby/examples/functions/create.md deleted file mode 100644 index 975f985607..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/create.md +++ /dev/null @@ -1,35 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.create( - function_id: '<FUNCTION_ID>', - name: '<NAME>', - runtime: ::NODE_14_5, - execute: ["any"], # optional - events: [], # optional - schedule: '', # optional - timeout: 1, # optional - enabled: false, # optional - logging: false, # optional - entrypoint: '<ENTRYPOINT>', # optional - commands: '<COMMANDS>', # optional - scopes: [], # optional - installation_id: '<INSTALLATION_ID>', # optional - provider_repository_id: '<PROVIDER_REPOSITORY_ID>', # optional - provider_branch: '<PROVIDER_BRANCH>', # optional - provider_silent_mode: false, # optional - provider_root_directory: '<PROVIDER_ROOT_DIRECTORY>', # optional - template_repository: '<TEMPLATE_REPOSITORY>', # optional - template_owner: '<TEMPLATE_OWNER>', # optional - template_root_directory: '<TEMPLATE_ROOT_DIRECTORY>', # optional - template_branch: '<TEMPLATE_BRANCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-ruby/examples/functions/delete-deployment.md deleted file mode 100644 index 7e525b78e9..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/delete-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.delete_deployment( - function_id: '<FUNCTION_ID>', - deployment_id: '<DEPLOYMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-ruby/examples/functions/delete-execution.md deleted file mode 100644 index 07003cdfe9..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/delete-execution.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.delete_execution( - function_id: '<FUNCTION_ID>', - execution_id: '<EXECUTION_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-ruby/examples/functions/delete-variable.md deleted file mode 100644 index dd2a4df1e4..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/delete-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.delete_variable( - function_id: '<FUNCTION_ID>', - variable_id: '<VARIABLE_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/delete.md b/docs/examples/1.6.x/server-ruby/examples/functions/delete.md deleted file mode 100644 index a55d56f196..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.delete( - function_id: '<FUNCTION_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-ruby/examples/functions/download-deployment.md deleted file mode 100644 index 57369287e6..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/download-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.download_deployment( - function_id: '<FUNCTION_ID>', - deployment_id: '<DEPLOYMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-ruby/examples/functions/get-deployment.md deleted file mode 100644 index d5c9698be9..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/get-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.get_deployment( - function_id: '<FUNCTION_ID>', - deployment_id: '<DEPLOYMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/get-execution.md b/docs/examples/1.6.x/server-ruby/examples/functions/get-execution.md deleted file mode 100644 index a127259c3f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/get-execution.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -functions = Functions.new(client) - -result = functions.get_execution( - function_id: '<FUNCTION_ID>', - execution_id: '<EXECUTION_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/get-variable.md b/docs/examples/1.6.x/server-ruby/examples/functions/get-variable.md deleted file mode 100644 index 8e7c73ac3d..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/get-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.get_variable( - function_id: '<FUNCTION_ID>', - variable_id: '<VARIABLE_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/get.md b/docs/examples/1.6.x/server-ruby/examples/functions/get.md deleted file mode 100644 index 36872251ad..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/get.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.get( - function_id: '<FUNCTION_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-ruby/examples/functions/list-deployments.md deleted file mode 100644 index 4213536fed..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/list-deployments.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.list_deployments( - function_id: '<FUNCTION_ID>', - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/list-executions.md b/docs/examples/1.6.x/server-ruby/examples/functions/list-executions.md deleted file mode 100644 index 41cb940f74..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/list-executions.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -functions = Functions.new(client) - -result = functions.list_executions( - function_id: '<FUNCTION_ID>', - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-ruby/examples/functions/list-runtimes.md deleted file mode 100644 index b305843dd9..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/list-runtimes.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.list_runtimes() diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/list-variables.md b/docs/examples/1.6.x/server-ruby/examples/functions/list-variables.md deleted file mode 100644 index 91b2371e00..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/list-variables.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.list_variables( - function_id: '<FUNCTION_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/list.md b/docs/examples/1.6.x/server-ruby/examples/functions/list.md deleted file mode 100644 index b73c5f958e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/list.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.list( - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment-build.md deleted file mode 100644 index 39a09321d1..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.update_deployment_build( - function_id: '<FUNCTION_ID>', - deployment_id: '<DEPLOYMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment.md deleted file mode 100644 index 913ac485c9..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/update-deployment.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.update_deployment( - function_id: '<FUNCTION_ID>', - deployment_id: '<DEPLOYMENT_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/update-variable.md b/docs/examples/1.6.x/server-ruby/examples/functions/update-variable.md deleted file mode 100644 index 9b029d7882..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/update-variable.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.update_variable( - function_id: '<FUNCTION_ID>', - variable_id: '<VARIABLE_ID>', - key: '<KEY>', - value: '<VALUE>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/functions/update.md b/docs/examples/1.6.x/server-ruby/examples/functions/update.md deleted file mode 100644 index 7111a48b13..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/functions/update.md +++ /dev/null @@ -1,30 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -functions = Functions.new(client) - -result = functions.update( - function_id: '<FUNCTION_ID>', - name: '<NAME>', - runtime: ::NODE_14_5, # optional - execute: ["any"], # optional - events: [], # optional - schedule: '', # optional - timeout: 1, # optional - enabled: false, # optional - logging: false, # optional - entrypoint: '<ENTRYPOINT>', # optional - commands: '<COMMANDS>', # optional - scopes: [], # optional - installation_id: '<INSTALLATION_ID>', # optional - provider_repository_id: '<PROVIDER_REPOSITORY_ID>', # optional - provider_branch: '<PROVIDER_BRANCH>', # optional - provider_silent_mode: false, # optional - provider_root_directory: '<PROVIDER_ROOT_DIRECTORY>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/graphql/mutation.md b/docs/examples/1.6.x/server-ruby/examples/graphql/mutation.md deleted file mode 100644 index 6c656da967..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/graphql/mutation.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -graphql = Graphql.new(client) - -result = graphql.mutation( - query: {} -) diff --git a/docs/examples/1.6.x/server-ruby/examples/graphql/query.md b/docs/examples/1.6.x/server-ruby/examples/graphql/query.md deleted file mode 100644 index ced6a9de02..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/graphql/query.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -graphql = Graphql.new(client) - -result = graphql.query( - query: {} -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-ruby/examples/health/get-antivirus.md deleted file mode 100644 index 41081c1837..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-antivirus.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_antivirus() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-cache.md b/docs/examples/1.6.x/server-ruby/examples/health/get-cache.md deleted file mode 100644 index 371f77f58a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-cache.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_cache() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-certificate.md b/docs/examples/1.6.x/server-ruby/examples/health/get-certificate.md deleted file mode 100644 index 82c26057ef..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-certificate.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_certificate( - domain: '' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-d-b.md b/docs/examples/1.6.x/server-ruby/examples/health/get-d-b.md deleted file mode 100644 index 48039916fc..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-d-b.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_db() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-ruby/examples/health/get-failed-jobs.md deleted file mode 100644 index 440095c7bb..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_failed_jobs( - name: ::V1_DATABASE, - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-ruby/examples/health/get-pub-sub.md deleted file mode 100644 index b77e726671..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-pub-sub.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_pub_sub() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-builds.md deleted file mode 100644 index 18dc388dc7..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-builds.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_builds( - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-certificates.md deleted file mode 100644 index 541e2ddd30..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_certificates( - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-databases.md deleted file mode 100644 index 0be4fc0614..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-databases.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_databases( - name: '<NAME>', # optional - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-deletes.md deleted file mode 100644 index 1f95b21ddf..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_deletes( - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-functions.md deleted file mode 100644 index 34e1d73044..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-functions.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_functions( - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-logs.md deleted file mode 100644 index 87ee4c2a0f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_logs( - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-mails.md deleted file mode 100644 index ccf8fe87fa..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-mails.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_mails( - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-messaging.md deleted file mode 100644 index 7cd55d0aae..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_messaging( - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-migrations.md deleted file mode 100644 index fff087f1ec..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_migrations( - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage-dump.md deleted file mode 100644 index 236507d265..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_usage_dump( - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage.md deleted file mode 100644 index ebe54bf6b3..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-usage.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_usage( - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue-webhooks.md deleted file mode 100644 index ce159224f9..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue_webhooks( - threshold: null # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-queue.md b/docs/examples/1.6.x/server-ruby/examples/health/get-queue.md deleted file mode 100644 index c9bf96a1bd..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-queue.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_queue() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-ruby/examples/health/get-storage-local.md deleted file mode 100644 index 4ae699107a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-storage-local.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_storage_local() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-storage.md b/docs/examples/1.6.x/server-ruby/examples/health/get-storage.md deleted file mode 100644 index 6da3548b71..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-storage.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_storage() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get-time.md b/docs/examples/1.6.x/server-ruby/examples/health/get-time.md deleted file mode 100644 index 20be01b942..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get-time.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get_time() diff --git a/docs/examples/1.6.x/server-ruby/examples/health/get.md b/docs/examples/1.6.x/server-ruby/examples/health/get.md deleted file mode 100644 index 7b51ecea84..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/health/get.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -health = Health.new(client) - -result = health.get() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/get.md b/docs/examples/1.6.x/server-ruby/examples/locale/get.md deleted file mode 100644 index 4c26a0913f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/locale/get.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -locale = Locale.new(client) - -result = locale.get() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-codes.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-codes.md deleted file mode 100644 index 3f4b763024..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/locale/list-codes.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -locale = Locale.new(client) - -result = locale.list_codes() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-continents.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-continents.md deleted file mode 100644 index a841a55ec8..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/locale/list-continents.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -locale = Locale.new(client) - -result = locale.list_continents() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-e-u.md deleted file mode 100644 index 21845cd953..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -locale = Locale.new(client) - -result = locale.list_countries_eu() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-phones.md deleted file mode 100644 index 453a86cde0..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -locale = Locale.new(client) - -result = locale.list_countries_phones() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-countries.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-countries.md deleted file mode 100644 index c34d341515..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/locale/list-countries.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -locale = Locale.new(client) - -result = locale.list_countries() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-currencies.md deleted file mode 100644 index 30af2ef359..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/locale/list-currencies.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -locale = Locale.new(client) - -result = locale.list_currencies() diff --git a/docs/examples/1.6.x/server-ruby/examples/locale/list-languages.md b/docs/examples/1.6.x/server-ruby/examples/locale/list-languages.md deleted file mode 100644 index 904f9cebe3..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/locale/list-languages.md +++ /dev/null @@ -1,12 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -locale = Locale.new(client) - -result = locale.list_languages() diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-apns-provider.md deleted file mode 100644 index e18993ddd9..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_apns_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', - auth_key: '<AUTH_KEY>', # optional - auth_key_id: '<AUTH_KEY_ID>', # optional - team_id: '<TEAM_ID>', # optional - bundle_id: '<BUNDLE_ID>', # optional - sandbox: false, # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-email.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-email.md deleted file mode 100644 index 98b069f1b1..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-email.md +++ /dev/null @@ -1,25 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_email( - message_id: '<MESSAGE_ID>', - subject: '<SUBJECT>', - content: '<CONTENT>', - topics: [], # optional - users: [], # optional - targets: [], # optional - cc: [], # optional - bcc: [], # optional - attachments: [], # optional - draft: false, # optional - html: false, # optional - scheduled_at: '' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-fcm-provider.md deleted file mode 100644 index 05daa6f63a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_fcm_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', - service_account_json: {}, # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index 2640bb0dfb..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,23 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_mailgun_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', - api_key: '<API_KEY>', # optional - domain: '<DOMAIN>', # optional - is_eu_region: false, # optional - from_name: '<FROM_NAME>', # optional - from_email: 'email@example.com', # optional - reply_to_name: '<REPLY_TO_NAME>', # optional - reply_to_email: 'email@example.com', # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-msg91provider.md deleted file mode 100644 index 1f6d408146..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_msg91_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', - template_id: '<TEMPLATE_ID>', # optional - sender_id: '<SENDER_ID>', # optional - auth_key: '<AUTH_KEY>', # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-push.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-push.md deleted file mode 100644 index ccb2f79f79..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-push.md +++ /dev/null @@ -1,29 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_push( - message_id: '<MESSAGE_ID>', - title: '<TITLE>', - body: '<BODY>', - topics: [], # optional - users: [], # optional - targets: [], # optional - data: {}, # optional - action: '<ACTION>', # optional - image: '[ID1:ID2]', # optional - icon: '<ICON>', # optional - sound: '<SOUND>', # optional - color: '<COLOR>', # optional - tag: '<TAG>', # optional - badge: '<BADGE>', # optional - draft: false, # optional - scheduled_at: '' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index 1f129e8c79..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_sendgrid_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', - api_key: '<API_KEY>', # optional - from_name: '<FROM_NAME>', # optional - from_email: 'email@example.com', # optional - reply_to_name: '<REPLY_TO_NAME>', # optional - reply_to_email: 'email@example.com', # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-sms.md deleted file mode 100644 index 7ae0ad6faf..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-sms.md +++ /dev/null @@ -1,20 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_sms( - message_id: '<MESSAGE_ID>', - content: '<CONTENT>', - topics: [], # optional - users: [], # optional - targets: [], # optional - draft: false, # optional - scheduled_at: '' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-smtp-provider.md deleted file mode 100644 index aa514fc3e1..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,27 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_smtp_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', - host: '<HOST>', - port: 1, # optional - username: '<USERNAME>', # optional - password: '<PASSWORD>', # optional - encryption: SmtpEncryption::NONE, # optional - auto_tls: false, # optional - mailer: '<MAILER>', # optional - from_name: '<FROM_NAME>', # optional - from_email: 'email@example.com', # optional - reply_to_name: '<REPLY_TO_NAME>', # optional - reply_to_email: 'email@example.com', # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-subscriber.md deleted file mode 100644 index a5dbcc0c50..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_jwt('<YOUR_JWT>') # Your secret JSON Web Token - -messaging = Messaging.new(client) - -result = messaging.create_subscriber( - topic_id: '<TOPIC_ID>', - subscriber_id: '<SUBSCRIBER_ID>', - target_id: '<TARGET_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-telesign-provider.md deleted file mode 100644 index 7f8430be07..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_telesign_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', # optional - customer_id: '<CUSTOMER_ID>', # optional - api_key: '<API_KEY>', # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index ab49e44f48..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_textmagic_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', # optional - username: '<USERNAME>', # optional - api_key: '<API_KEY>', # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-topic.md deleted file mode 100644 index d4c77f0e45..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-topic.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_topic( - topic_id: '<TOPIC_ID>', - name: '<NAME>', - subscribe: ["any"] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-twilio-provider.md deleted file mode 100644 index ef0d6ced8d..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_twilio_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', # optional - account_sid: '<ACCOUNT_SID>', # optional - auth_token: '<AUTH_TOKEN>', # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/create-vonage-provider.md deleted file mode 100644 index 4a20d79140..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.create_vonage_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', - from: '+12065550100', # optional - api_key: '<API_KEY>', # optional - api_secret: '<API_SECRET>', # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/delete-provider.md deleted file mode 100644 index 2abdb5b537..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/delete-provider.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.delete_provider( - provider_id: '<PROVIDER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-ruby/examples/messaging/delete-subscriber.md deleted file mode 100644 index 4f527336cc..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_jwt('<YOUR_JWT>') # Your secret JSON Web Token - -messaging = Messaging.new(client) - -result = messaging.delete_subscriber( - topic_id: '<TOPIC_ID>', - subscriber_id: '<SUBSCRIBER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-ruby/examples/messaging/delete-topic.md deleted file mode 100644 index 253f5cdc17..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/delete-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.delete_topic( - topic_id: '<TOPIC_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/delete.md b/docs/examples/1.6.x/server-ruby/examples/messaging/delete.md deleted file mode 100644 index 00eeaa3b57..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.delete( - message_id: '<MESSAGE_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/get-message.md b/docs/examples/1.6.x/server-ruby/examples/messaging/get-message.md deleted file mode 100644 index 15ebe03221..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/get-message.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.get_message( - message_id: '<MESSAGE_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/get-provider.md deleted file mode 100644 index 73845ee7fb..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/get-provider.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.get_provider( - provider_id: '<PROVIDER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-ruby/examples/messaging/get-subscriber.md deleted file mode 100644 index c1ede6456f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.get_subscriber( - topic_id: '<TOPIC_ID>', - subscriber_id: '<SUBSCRIBER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-ruby/examples/messaging/get-topic.md deleted file mode 100644 index bf232b20b3..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/get-topic.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.get_topic( - topic_id: '<TOPIC_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-message-logs.md deleted file mode 100644 index 7b9ef925f8..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.list_message_logs( - message_id: '<MESSAGE_ID>', - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-messages.md deleted file mode 100644 index 97d73e6e32..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/list-messages.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.list_messages( - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-provider-logs.md deleted file mode 100644 index 8510f5cd91..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.list_provider_logs( - provider_id: '<PROVIDER_ID>', - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-providers.md deleted file mode 100644 index 4df1f29fc9..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/list-providers.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.list_providers( - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index 2a40254b9a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.list_subscriber_logs( - subscriber_id: '<SUBSCRIBER_ID>', - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscribers.md deleted file mode 100644 index f14aeb0b2e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.list_subscribers( - topic_id: '<TOPIC_ID>', - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-targets.md deleted file mode 100644 index 0c4a696ea2..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/list-targets.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.list_targets( - message_id: '<MESSAGE_ID>', - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-topic-logs.md deleted file mode 100644 index 52fca3ec11..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.list_topic_logs( - topic_id: '<TOPIC_ID>', - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-ruby/examples/messaging/list-topics.md deleted file mode 100644 index 89edddc1af..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/list-topics.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.list_topics( - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-apns-provider.md deleted file mode 100644 index b37dfa0a46..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_apns_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', # optional - enabled: false, # optional - auth_key: '<AUTH_KEY>', # optional - auth_key_id: '<AUTH_KEY_ID>', # optional - team_id: '<TEAM_ID>', # optional - bundle_id: '<BUNDLE_ID>', # optional - sandbox: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-email.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-email.md deleted file mode 100644 index 6323e02939..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-email.md +++ /dev/null @@ -1,25 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_email( - message_id: '<MESSAGE_ID>', - topics: [], # optional - users: [], # optional - targets: [], # optional - subject: '<SUBJECT>', # optional - content: '<CONTENT>', # optional - draft: false, # optional - html: false, # optional - cc: [], # optional - bcc: [], # optional - scheduled_at: '', # optional - attachments: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-fcm-provider.md deleted file mode 100644 index 6c7b776cd0..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_fcm_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', # optional - enabled: false, # optional - service_account_json: {} # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index ca8f8a0502..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,23 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_mailgun_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', # optional - api_key: '<API_KEY>', # optional - domain: '<DOMAIN>', # optional - is_eu_region: false, # optional - enabled: false, # optional - from_name: '<FROM_NAME>', # optional - from_email: 'email@example.com', # optional - reply_to_name: '<REPLY_TO_NAME>', # optional - reply_to_email: '<REPLY_TO_EMAIL>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-msg91provider.md deleted file mode 100644 index 6c939c7aa6..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_msg91_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', # optional - enabled: false, # optional - template_id: '<TEMPLATE_ID>', # optional - sender_id: '<SENDER_ID>', # optional - auth_key: '<AUTH_KEY>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-push.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-push.md deleted file mode 100644 index 9a7ef52443..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-push.md +++ /dev/null @@ -1,29 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_push( - message_id: '<MESSAGE_ID>', - topics: [], # optional - users: [], # optional - targets: [], # optional - title: '<TITLE>', # optional - body: '<BODY>', # optional - data: {}, # optional - action: '<ACTION>', # optional - image: '[ID1:ID2]', # optional - icon: '<ICON>', # optional - sound: '<SOUND>', # optional - color: '<COLOR>', # optional - tag: '<TAG>', # optional - badge: null, # optional - draft: false, # optional - scheduled_at: '' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index d472dc7153..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,21 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_sendgrid_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', # optional - enabled: false, # optional - api_key: '<API_KEY>', # optional - from_name: '<FROM_NAME>', # optional - from_email: 'email@example.com', # optional - reply_to_name: '<REPLY_TO_NAME>', # optional - reply_to_email: '<REPLY_TO_EMAIL>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-sms.md deleted file mode 100644 index 87fa0f9e14..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-sms.md +++ /dev/null @@ -1,20 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_sms( - message_id: '<MESSAGE_ID>', - topics: [], # optional - users: [], # optional - targets: [], # optional - content: '<CONTENT>', # optional - draft: false, # optional - scheduled_at: '' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-smtp-provider.md deleted file mode 100644 index 979036974b..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,27 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_smtp_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', # optional - host: '<HOST>', # optional - port: 1, # optional - username: '<USERNAME>', # optional - password: '<PASSWORD>', # optional - encryption: SmtpEncryption::NONE, # optional - auto_tls: false, # optional - mailer: '<MAILER>', # optional - from_name: '<FROM_NAME>', # optional - from_email: 'email@example.com', # optional - reply_to_name: '<REPLY_TO_NAME>', # optional - reply_to_email: '<REPLY_TO_EMAIL>', # optional - enabled: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-telesign-provider.md deleted file mode 100644 index 95bf2071f2..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_telesign_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', # optional - enabled: false, # optional - customer_id: '<CUSTOMER_ID>', # optional - api_key: '<API_KEY>', # optional - from: '<FROM>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index 7c7f828db0..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_textmagic_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', # optional - enabled: false, # optional - username: '<USERNAME>', # optional - api_key: '<API_KEY>', # optional - from: '<FROM>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-topic.md deleted file mode 100644 index 3e9aa84a5e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-topic.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_topic( - topic_id: '<TOPIC_ID>', - name: '<NAME>', # optional - subscribe: ["any"] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-twilio-provider.md deleted file mode 100644 index 7b88a5998e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_twilio_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', # optional - enabled: false, # optional - account_sid: '<ACCOUNT_SID>', # optional - auth_token: '<AUTH_TOKEN>', # optional - from: '<FROM>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-ruby/examples/messaging/update-vonage-provider.md deleted file mode 100644 index 37f55393e6..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -messaging = Messaging.new(client) - -result = messaging.update_vonage_provider( - provider_id: '<PROVIDER_ID>', - name: '<NAME>', # optional - enabled: false, # optional - api_key: '<API_KEY>', # optional - api_secret: '<API_SECRET>', # optional - from: '<FROM>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-ruby/examples/storage/create-bucket.md deleted file mode 100644 index 8bac198b6c..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/create-bucket.md +++ /dev/null @@ -1,23 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -storage = Storage.new(client) - -result = storage.create_bucket( - bucket_id: '<BUCKET_ID>', - name: '<NAME>', - permissions: ["read("any")"], # optional - file_security: false, # optional - enabled: false, # optional - maximum_file_size: 1, # optional - allowed_file_extensions: [], # optional - compression: ::NONE, # optional - encryption: false, # optional - antivirus: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/create-file.md b/docs/examples/1.6.x/server-ruby/examples/storage/create-file.md deleted file mode 100644 index ba0c27ec86..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/create-file.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -storage = Storage.new(client) - -result = storage.create_file( - bucket_id: '<BUCKET_ID>', - file_id: '<FILE_ID>', - file: InputFile.from_path('dir/file.png'), - permissions: ["read("any")"] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-ruby/examples/storage/delete-bucket.md deleted file mode 100644 index e765f45dd8..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/delete-bucket.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -storage = Storage.new(client) - -result = storage.delete_bucket( - bucket_id: '<BUCKET_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/delete-file.md b/docs/examples/1.6.x/server-ruby/examples/storage/delete-file.md deleted file mode 100644 index a6d90d7952..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/delete-file.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -storage = Storage.new(client) - -result = storage.delete_file( - bucket_id: '<BUCKET_ID>', - file_id: '<FILE_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-ruby/examples/storage/get-bucket.md deleted file mode 100644 index 17e96a375d..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/get-bucket.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -storage = Storage.new(client) - -result = storage.get_bucket( - bucket_id: '<BUCKET_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-ruby/examples/storage/get-file-download.md deleted file mode 100644 index 2a3bcb6b64..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/get-file-download.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -storage = Storage.new(client) - -result = storage.get_file_download( - bucket_id: '<BUCKET_ID>', - file_id: '<FILE_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-ruby/examples/storage/get-file-preview.md deleted file mode 100644 index 768aa9bd4b..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/get-file-preview.md +++ /dev/null @@ -1,26 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -storage = Storage.new(client) - -result = storage.get_file_preview( - bucket_id: '<BUCKET_ID>', - file_id: '<FILE_ID>', - width: 0, # optional - height: 0, # optional - gravity: ImageGravity::CENTER, # optional - quality: 0, # optional - border_width: 0, # optional - border_color: '', # optional - border_radius: 0, # optional - opacity: 0, # optional - rotation: -360, # optional - background: '', # optional - output: ImageFormat::JPG # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-ruby/examples/storage/get-file-view.md deleted file mode 100644 index a93b62d787..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/get-file-view.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -storage = Storage.new(client) - -result = storage.get_file_view( - bucket_id: '<BUCKET_ID>', - file_id: '<FILE_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/get-file.md b/docs/examples/1.6.x/server-ruby/examples/storage/get-file.md deleted file mode 100644 index dfbd05d166..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/get-file.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -storage = Storage.new(client) - -result = storage.get_file( - bucket_id: '<BUCKET_ID>', - file_id: '<FILE_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-ruby/examples/storage/list-buckets.md deleted file mode 100644 index f2e6c63296..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/list-buckets.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -storage = Storage.new(client) - -result = storage.list_buckets( - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/list-files.md b/docs/examples/1.6.x/server-ruby/examples/storage/list-files.md deleted file mode 100644 index 392639a3e0..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/list-files.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -storage = Storage.new(client) - -result = storage.list_files( - bucket_id: '<BUCKET_ID>', - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-ruby/examples/storage/update-bucket.md deleted file mode 100644 index 055ea5de9d..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/update-bucket.md +++ /dev/null @@ -1,23 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -storage = Storage.new(client) - -result = storage.update_bucket( - bucket_id: '<BUCKET_ID>', - name: '<NAME>', - permissions: ["read("any")"], # optional - file_security: false, # optional - enabled: false, # optional - maximum_file_size: 1, # optional - allowed_file_extensions: [], # optional - compression: ::NONE, # optional - encryption: false, # optional - antivirus: false # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/storage/update-file.md b/docs/examples/1.6.x/server-ruby/examples/storage/update-file.md deleted file mode 100644 index d83780dcde..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/storage/update-file.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -storage = Storage.new(client) - -result = storage.update_file( - bucket_id: '<BUCKET_ID>', - file_id: '<FILE_ID>', - name: '<NAME>', # optional - permissions: ["read("any")"] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/create-membership.md b/docs/examples/1.6.x/server-ruby/examples/teams/create-membership.md deleted file mode 100644 index d1310df525..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/create-membership.md +++ /dev/null @@ -1,20 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.create_membership( - team_id: '<TEAM_ID>', - roles: [], - email: 'email@example.com', # optional - user_id: '<USER_ID>', # optional - phone: '+12065550100', # optional - url: 'https://example.com', # optional - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/create.md b/docs/examples/1.6.x/server-ruby/examples/teams/create.md deleted file mode 100644 index f35023c8f3..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/create.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.create( - team_id: '<TEAM_ID>', - name: '<NAME>', - roles: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-ruby/examples/teams/delete-membership.md deleted file mode 100644 index 82ab4380ce..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/delete-membership.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.delete_membership( - team_id: '<TEAM_ID>', - membership_id: '<MEMBERSHIP_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/delete.md b/docs/examples/1.6.x/server-ruby/examples/teams/delete.md deleted file mode 100644 index bd80fbd985..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.delete( - team_id: '<TEAM_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/get-membership.md b/docs/examples/1.6.x/server-ruby/examples/teams/get-membership.md deleted file mode 100644 index 0cb3d9d87e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/get-membership.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.get_membership( - team_id: '<TEAM_ID>', - membership_id: '<MEMBERSHIP_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-ruby/examples/teams/get-prefs.md deleted file mode 100644 index 4cf9b58647..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/get-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.get_prefs( - team_id: '<TEAM_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/get.md b/docs/examples/1.6.x/server-ruby/examples/teams/get.md deleted file mode 100644 index bd98069ccc..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/get.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.get( - team_id: '<TEAM_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-ruby/examples/teams/list-memberships.md deleted file mode 100644 index 98cc550091..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/list-memberships.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.list_memberships( - team_id: '<TEAM_ID>', - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/list.md b/docs/examples/1.6.x/server-ruby/examples/teams/list.md deleted file mode 100644 index 8f375e14e8..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/list.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.list( - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-ruby/examples/teams/update-membership-status.md deleted file mode 100644 index 876c565e72..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/update-membership-status.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.update_membership_status( - team_id: '<TEAM_ID>', - membership_id: '<MEMBERSHIP_ID>', - user_id: '<USER_ID>', - secret: '<SECRET>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/update-membership.md b/docs/examples/1.6.x/server-ruby/examples/teams/update-membership.md deleted file mode 100644 index 89c57fa1fa..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/update-membership.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.update_membership( - team_id: '<TEAM_ID>', - membership_id: '<MEMBERSHIP_ID>', - roles: [] -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/update-name.md b/docs/examples/1.6.x/server-ruby/examples/teams/update-name.md deleted file mode 100644 index ad628e833e..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/update-name.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.update_name( - team_id: '<TEAM_ID>', - name: '<NAME>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-ruby/examples/teams/update-prefs.md deleted file mode 100644 index a3d73497ee..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/teams/update-prefs.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_session('') # The user session to authenticate with - -teams = Teams.new(client) - -result = teams.update_prefs( - team_id: '<TEAM_ID>', - prefs: {} -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-argon2user.md deleted file mode 100644 index d67fe3c7ae..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-argon2user.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_argon2_user( - user_id: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-bcrypt-user.md deleted file mode 100644 index c68ba7562a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_bcrypt_user( - user_id: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-ruby/examples/users/create-j-w-t.md deleted file mode 100644 index f92d8ecdef..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-j-w-t.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_jwt( - user_id: '<USER_ID>', - session_id: '<SESSION_ID>', # optional - duration: 0 # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-m-d5user.md deleted file mode 100644 index a294a5a326..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-m-d5user.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_md5_user( - user_id: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index 9850d43cd7..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_mfa_recovery_codes( - user_id: '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-p-h-pass-user.md deleted file mode 100644 index 0e71f62a63..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,17 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_ph_pass_user( - user_id: '<USER_ID>', - email: 'email@example.com', - password: 'password', - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-s-h-a-user.md deleted file mode 100644 index e44703c403..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_sha_user( - user_id: '<USER_ID>', - email: 'email@example.com', - password: 'password', - password_version: PasswordHash::SHA1, # optional - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index fdcbf528ea..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,20 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_scrypt_modified_user( - user_id: '<USER_ID>', - email: 'email@example.com', - password: 'password', - password_salt: '<PASSWORD_SALT>', - password_salt_separator: '<PASSWORD_SALT_SEPARATOR>', - password_signer_key: '<PASSWORD_SIGNER_KEY>', - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-user.md deleted file mode 100644 index 581a28cc77..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,22 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_scrypt_user( - user_id: '<USER_ID>', - email: 'email@example.com', - password: 'password', - password_salt: '<PASSWORD_SALT>', - password_cpu: null, - password_memory: null, - password_parallel: null, - password_length: null, - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-session.md b/docs/examples/1.6.x/server-ruby/examples/users/create-session.md deleted file mode 100644 index 15d7219f2d..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-session.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_session( - user_id: '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-target.md b/docs/examples/1.6.x/server-ruby/examples/users/create-target.md deleted file mode 100644 index a9441229fb..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-target.md +++ /dev/null @@ -1,20 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_target( - user_id: '<USER_ID>', - target_id: '<TARGET_ID>', - provider_type: MessagingProviderType::EMAIL, - identifier: '<IDENTIFIER>', - provider_id: '<PROVIDER_ID>', # optional - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create-token.md b/docs/examples/1.6.x/server-ruby/examples/users/create-token.md deleted file mode 100644 index 8840b4b1ce..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create-token.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create_token( - user_id: '<USER_ID>', - length: 4, # optional - expire: 60 # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/create.md b/docs/examples/1.6.x/server-ruby/examples/users/create.md deleted file mode 100644 index ffc6b5e4db..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/create.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.create( - user_id: '<USER_ID>', - email: 'email@example.com', # optional - phone: '+12065550100', # optional - password: '', # optional - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete-identity.md b/docs/examples/1.6.x/server-ruby/examples/users/delete-identity.md deleted file mode 100644 index 366e4aee37..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/delete-identity.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.delete_identity( - identity_id: '<IDENTITY_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-ruby/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index 501e68e143..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,16 +0,0 @@ -require 'appwrite' - -include Appwrite -include Appwrite::Enums - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.delete_mfa_authenticator( - user_id: '<USER_ID>', - type: AuthenticatorType::TOTP -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete-session.md b/docs/examples/1.6.x/server-ruby/examples/users/delete-session.md deleted file mode 100644 index 524581c9a7..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/delete-session.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.delete_session( - user_id: '<USER_ID>', - session_id: '<SESSION_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-ruby/examples/users/delete-sessions.md deleted file mode 100644 index fc8f97618a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/delete-sessions.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.delete_sessions( - user_id: '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete-target.md b/docs/examples/1.6.x/server-ruby/examples/users/delete-target.md deleted file mode 100644 index 54005b686d..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/delete-target.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.delete_target( - user_id: '<USER_ID>', - target_id: '<TARGET_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/delete.md b/docs/examples/1.6.x/server-ruby/examples/users/delete.md deleted file mode 100644 index dca01f7612..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/delete.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.delete( - user_id: '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index 3d09974493..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.get_mfa_recovery_codes( - user_id: '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/get-prefs.md b/docs/examples/1.6.x/server-ruby/examples/users/get-prefs.md deleted file mode 100644 index f4e38d9118..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/get-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.get_prefs( - user_id: '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/get-target.md b/docs/examples/1.6.x/server-ruby/examples/users/get-target.md deleted file mode 100644 index a97fca8bbc..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/get-target.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.get_target( - user_id: '<USER_ID>', - target_id: '<TARGET_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/get.md b/docs/examples/1.6.x/server-ruby/examples/users/get.md deleted file mode 100644 index 143f5fc133..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/get.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.get( - user_id: '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-identities.md b/docs/examples/1.6.x/server-ruby/examples/users/list-identities.md deleted file mode 100644 index 4e6a6ffc41..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/list-identities.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.list_identities( - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-logs.md b/docs/examples/1.6.x/server-ruby/examples/users/list-logs.md deleted file mode 100644 index 45b7ad4ac0..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/list-logs.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.list_logs( - user_id: '<USER_ID>', - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-memberships.md b/docs/examples/1.6.x/server-ruby/examples/users/list-memberships.md deleted file mode 100644 index dc26c0e94a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/list-memberships.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.list_memberships( - user_id: '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-ruby/examples/users/list-mfa-factors.md deleted file mode 100644 index 18760fb107..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.list_mfa_factors( - user_id: '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-sessions.md b/docs/examples/1.6.x/server-ruby/examples/users/list-sessions.md deleted file mode 100644 index 875dab433a..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/list-sessions.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.list_sessions( - user_id: '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list-targets.md b/docs/examples/1.6.x/server-ruby/examples/users/list-targets.md deleted file mode 100644 index c836a08769..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/list-targets.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.list_targets( - user_id: '<USER_ID>', - queries: [] # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/list.md b/docs/examples/1.6.x/server-ruby/examples/users/list.md deleted file mode 100644 index 9f60f6876b..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/list.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.list( - queries: [], # optional - search: '<SEARCH>' # optional -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-ruby/examples/users/update-email-verification.md deleted file mode 100644 index 2dc10ae17f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-email-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_email_verification( - user_id: '<USER_ID>', - email_verification: false -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-email.md b/docs/examples/1.6.x/server-ruby/examples/users/update-email.md deleted file mode 100644 index f1ad7fd4b4..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-email.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_email( - user_id: '<USER_ID>', - email: 'email@example.com' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-labels.md b/docs/examples/1.6.x/server-ruby/examples/users/update-labels.md deleted file mode 100644 index 15340763ca..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-labels.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_labels( - user_id: '<USER_ID>', - labels: [] -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-ruby/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index cff62e5600..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,14 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_mfa_recovery_codes( - user_id: '<USER_ID>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-mfa.md b/docs/examples/1.6.x/server-ruby/examples/users/update-mfa.md deleted file mode 100644 index b4b5d19feb..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-mfa.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_mfa( - user_id: '<USER_ID>', - mfa: false -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-name.md b/docs/examples/1.6.x/server-ruby/examples/users/update-name.md deleted file mode 100644 index e8dbfe90dd..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-name.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_name( - user_id: '<USER_ID>', - name: '<NAME>' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-password.md b/docs/examples/1.6.x/server-ruby/examples/users/update-password.md deleted file mode 100644 index 57af0c6c26..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-password.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_password( - user_id: '<USER_ID>', - password: '' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-ruby/examples/users/update-phone-verification.md deleted file mode 100644 index 188c60103c..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-phone-verification.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_phone_verification( - user_id: '<USER_ID>', - phone_verification: false -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-phone.md b/docs/examples/1.6.x/server-ruby/examples/users/update-phone.md deleted file mode 100644 index 2a4ce0b5cf..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-phone.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_phone( - user_id: '<USER_ID>', - number: '+12065550100' -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-prefs.md b/docs/examples/1.6.x/server-ruby/examples/users/update-prefs.md deleted file mode 100644 index 866d2c2e2f..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-prefs.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_prefs( - user_id: '<USER_ID>', - prefs: {} -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-status.md b/docs/examples/1.6.x/server-ruby/examples/users/update-status.md deleted file mode 100644 index bd589e3c1d..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-status.md +++ /dev/null @@ -1,15 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_status( - user_id: '<USER_ID>', - status: false -) diff --git a/docs/examples/1.6.x/server-ruby/examples/users/update-target.md b/docs/examples/1.6.x/server-ruby/examples/users/update-target.md deleted file mode 100644 index a3ec8ae580..0000000000 --- a/docs/examples/1.6.x/server-ruby/examples/users/update-target.md +++ /dev/null @@ -1,18 +0,0 @@ -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint - .set_project('<YOUR_PROJECT_ID>') # Your project ID - .set_key('<YOUR_API_KEY>') # Your secret API key - -users = Users.new(client) - -result = users.update_target( - user_id: '<USER_ID>', - target_id: '<TARGET_ID>', - identifier: '<IDENTIFIER>', # optional - provider_id: '<PROVIDER_ID>', # optional - name: '<NAME>' # optional -) diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-anonymous-session.md b/docs/examples/1.6.x/server-swift/examples/account/create-anonymous-session.md deleted file mode 100644 index 6392cc4728..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-anonymous-session.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.createAnonymousSession() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-email-password-session.md b/docs/examples/1.6.x/server-swift/examples/account/create-email-password-session.md deleted file mode 100644 index 2ff62e4c3d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-email-password-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.createEmailPasswordSession( - email: "email@example.com", - password: "password" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-email-token.md b/docs/examples/1.6.x/server-swift/examples/account/create-email-token.md deleted file mode 100644 index 1da4ecb425..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-email-token.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.createEmailToken( - userId: "<USER_ID>", - email: "email@example.com", - phrase: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-j-w-t.md b/docs/examples/1.6.x/server-swift/examples/account/create-j-w-t.md deleted file mode 100644 index ade54e673e..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-j-w-t.md +++ /dev/null @@ -1,10 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let jwt = try await account.createJWT() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-magic-u-r-l-token.md b/docs/examples/1.6.x/server-swift/examples/account/create-magic-u-r-l-token.md deleted file mode 100644 index 83d763c871..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-magic-u-r-l-token.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.createMagicURLToken( - userId: "<USER_ID>", - email: "email@example.com", - url: "https://example.com", // optional - phrase: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-mfa-authenticator.md b/docs/examples/1.6.x/server-swift/examples/account/create-mfa-authenticator.md deleted file mode 100644 index 1d1bf46013..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-mfa-authenticator.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let mfaType = try await account.createMfaAuthenticator( - type: .totp -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-mfa-challenge.md b/docs/examples/1.6.x/server-swift/examples/account/create-mfa-challenge.md deleted file mode 100644 index 3798884fde..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-mfa-challenge.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let mfaChallenge = try await account.createMfaChallenge( - factor: .email -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/account/create-mfa-recovery-codes.md deleted file mode 100644 index acbd337f21..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let mfaRecoveryCodes = try await account.createMfaRecoveryCodes() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-o-auth2token.md b/docs/examples/1.6.x/server-swift/examples/account/create-o-auth2token.md deleted file mode 100644 index 4224c6b4c3..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-o-auth2token.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let success = try await account.createOAuth2Token( - provider: .amazon, - success: "https://example.com", // optional - failure: "https://example.com", // optional - scopes: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-phone-token.md b/docs/examples/1.6.x/server-swift/examples/account/create-phone-token.md deleted file mode 100644 index f8cff783f4..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-phone-token.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let token = try await account.createPhoneToken( - userId: "<USER_ID>", - phone: "+12065550100" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-phone-verification.md b/docs/examples/1.6.x/server-swift/examples/account/create-phone-verification.md deleted file mode 100644 index 3d2af4aed5..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-phone-verification.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let token = try await account.createPhoneVerification() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-recovery.md b/docs/examples/1.6.x/server-swift/examples/account/create-recovery.md deleted file mode 100644 index 3926a8616d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-recovery.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let token = try await account.createRecovery( - email: "email@example.com", - url: "https://example.com" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-session.md b/docs/examples/1.6.x/server-swift/examples/account/create-session.md deleted file mode 100644 index 2bdecc74d3..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.createSession( - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create-verification.md b/docs/examples/1.6.x/server-swift/examples/account/create-verification.md deleted file mode 100644 index 96b414c9f4..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create-verification.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let token = try await account.createVerification( - url: "https://example.com" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/create.md b/docs/examples/1.6.x/server-swift/examples/account/create.md deleted file mode 100644 index cb8dd109bb..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/create.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let user = try await account.create( - userId: "<USER_ID>", - email: "email@example.com", - password: "", - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/delete-identity.md b/docs/examples/1.6.x/server-swift/examples/account/delete-identity.md deleted file mode 100644 index 1a25053fbb..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/delete-identity.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let result = try await account.deleteIdentity( - identityId: "<IDENTITY_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-swift/examples/account/delete-mfa-authenticator.md deleted file mode 100644 index 6d8854a809..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/delete-mfa-authenticator.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let result = try await account.deleteMfaAuthenticator( - type: .totp -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/delete-session.md b/docs/examples/1.6.x/server-swift/examples/account/delete-session.md deleted file mode 100644 index e452a6c13a..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/delete-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let result = try await account.deleteSession( - sessionId: "<SESSION_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/delete-sessions.md b/docs/examples/1.6.x/server-swift/examples/account/delete-sessions.md deleted file mode 100644 index 08f667cca5..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/delete-sessions.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let result = try await account.deleteSessions() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/account/get-mfa-recovery-codes.md deleted file mode 100644 index d8d30b3a06..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/get-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let mfaRecoveryCodes = try await account.getMfaRecoveryCodes() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/get-prefs.md b/docs/examples/1.6.x/server-swift/examples/account/get-prefs.md deleted file mode 100644 index eed98330e0..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/get-prefs.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let preferences = try await account.getPrefs() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/get-session.md b/docs/examples/1.6.x/server-swift/examples/account/get-session.md deleted file mode 100644 index 6f3bce3ec1..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/get-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let session = try await account.getSession( - sessionId: "<SESSION_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/get.md b/docs/examples/1.6.x/server-swift/examples/account/get.md deleted file mode 100644 index 80ae68232e..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let user = try await account.get() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/list-identities.md b/docs/examples/1.6.x/server-swift/examples/account/list-identities.md deleted file mode 100644 index 175508b3c0..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/list-identities.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let identityList = try await account.listIdentities( - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/list-logs.md b/docs/examples/1.6.x/server-swift/examples/account/list-logs.md deleted file mode 100644 index c2e505a78a..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/list-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let logList = try await account.listLogs( - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/list-mfa-factors.md b/docs/examples/1.6.x/server-swift/examples/account/list-mfa-factors.md deleted file mode 100644 index 41dd98aab1..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/list-mfa-factors.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let mfaFactors = try await account.listMfaFactors() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/list-sessions.md b/docs/examples/1.6.x/server-swift/examples/account/list-sessions.md deleted file mode 100644 index 922c8f305c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/list-sessions.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let sessionList = try await account.listSessions() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-email.md b/docs/examples/1.6.x/server-swift/examples/account/update-email.md deleted file mode 100644 index 7a94b49610..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-email.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let user = try await account.updateEmail( - email: "email@example.com", - password: "password" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-m-f-a.md b/docs/examples/1.6.x/server-swift/examples/account/update-m-f-a.md deleted file mode 100644 index 46c849d678..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-m-f-a.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let user = try await account.updateMFA( - mfa: false -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-magic-u-r-l-session.md b/docs/examples/1.6.x/server-swift/examples/account/update-magic-u-r-l-session.md deleted file mode 100644 index 6571266959..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-magic-u-r-l-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.updateMagicURLSession( - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-mfa-authenticator.md b/docs/examples/1.6.x/server-swift/examples/account/update-mfa-authenticator.md deleted file mode 100644 index 2bb3ce7430..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-mfa-authenticator.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let user = try await account.updateMfaAuthenticator( - type: .totp, - otp: "<OTP>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-mfa-challenge.md b/docs/examples/1.6.x/server-swift/examples/account/update-mfa-challenge.md deleted file mode 100644 index 2eac96d81b..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-mfa-challenge.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let result = try await account.updateMfaChallenge( - challengeId: "<CHALLENGE_ID>", - otp: "<OTP>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/account/update-mfa-recovery-codes.md deleted file mode 100644 index f06ede45e9..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-mfa-recovery-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let mfaRecoveryCodes = try await account.updateMfaRecoveryCodes() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-name.md b/docs/examples/1.6.x/server-swift/examples/account/update-name.md deleted file mode 100644 index d51f9d26aa..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-name.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let user = try await account.updateName( - name: "<NAME>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-password.md b/docs/examples/1.6.x/server-swift/examples/account/update-password.md deleted file mode 100644 index d9232b8c7c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-password.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let user = try await account.updatePassword( - password: "", - oldPassword: "password" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-phone-session.md b/docs/examples/1.6.x/server-swift/examples/account/update-phone-session.md deleted file mode 100644 index df1feae1e3..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-phone-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - -let account = Account(client) - -let session = try await account.updatePhoneSession( - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-phone-verification.md b/docs/examples/1.6.x/server-swift/examples/account/update-phone-verification.md deleted file mode 100644 index 20085acf7d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-phone-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let token = try await account.updatePhoneVerification( - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-phone.md b/docs/examples/1.6.x/server-swift/examples/account/update-phone.md deleted file mode 100644 index c7c817bd74..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-phone.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let user = try await account.updatePhone( - phone: "+12065550100", - password: "password" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-prefs.md b/docs/examples/1.6.x/server-swift/examples/account/update-prefs.md deleted file mode 100644 index 3fc0a9cae1..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let user = try await account.updatePrefs( - prefs: [:] -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-recovery.md b/docs/examples/1.6.x/server-swift/examples/account/update-recovery.md deleted file mode 100644 index 0b8d463322..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-recovery.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let token = try await account.updateRecovery( - userId: "<USER_ID>", - secret: "<SECRET>", - password: "" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-session.md b/docs/examples/1.6.x/server-swift/examples/account/update-session.md deleted file mode 100644 index 40b88d801e..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let session = try await account.updateSession( - sessionId: "<SESSION_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-status.md b/docs/examples/1.6.x/server-swift/examples/account/update-status.md deleted file mode 100644 index 1d2f7f220d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-status.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let user = try await account.updateStatus() - diff --git a/docs/examples/1.6.x/server-swift/examples/account/update-verification.md b/docs/examples/1.6.x/server-swift/examples/account/update-verification.md deleted file mode 100644 index 07c1131206..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/account/update-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let account = Account(client) - -let token = try await account.updateVerification( - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-browser.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-browser.md deleted file mode 100644 index 3ac6c599db..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/avatars/get-browser.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let avatars = Avatars(client) - -let bytes = try await avatars.getBrowser( - code: .avantBrowser, - width: 0, // optional - height: 0, // optional - quality: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-credit-card.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-credit-card.md deleted file mode 100644 index 306ceb843a..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/avatars/get-credit-card.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let avatars = Avatars(client) - -let bytes = try await avatars.getCreditCard( - code: .americanExpress, - width: 0, // optional - height: 0, // optional - quality: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-favicon.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-favicon.md deleted file mode 100644 index 9121f07043..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/avatars/get-favicon.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let avatars = Avatars(client) - -let bytes = try await avatars.getFavicon( - url: "https://example.com" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-flag.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-flag.md deleted file mode 100644 index 3c9bd75859..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/avatars/get-flag.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let avatars = Avatars(client) - -let bytes = try await avatars.getFlag( - code: .afghanistan, - width: 0, // optional - height: 0, // optional - quality: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-image.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-image.md deleted file mode 100644 index e32b51535d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/avatars/get-image.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let avatars = Avatars(client) - -let bytes = try await avatars.getImage( - url: "https://example.com", - width: 0, // optional - height: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-initials.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-initials.md deleted file mode 100644 index bba05387d4..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/avatars/get-initials.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let avatars = Avatars(client) - -let bytes = try await avatars.getInitials( - name: "<NAME>", // optional - width: 0, // optional - height: 0, // optional - background: "" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/avatars/get-q-r.md b/docs/examples/1.6.x/server-swift/examples/avatars/get-q-r.md deleted file mode 100644 index d84500b8de..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/avatars/get-q-r.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let avatars = Avatars(client) - -let bytes = try await avatars.getQR( - text: "<TEXT>", - size: 1, // optional - margin: 0, // optional - download: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-boolean-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-boolean-attribute.md deleted file mode 100644 index ac737f72f9..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-boolean-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeBoolean = try await databases.createBooleanAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: false, // optional - array: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-collection.md b/docs/examples/1.6.x/server-swift/examples/databases/create-collection.md deleted file mode 100644 index 46984d4c5a..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-collection.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let collection = try await databases.createCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - name: "<NAME>", - permissions: ["read("any")"], // optional - documentSecurity: false, // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-datetime-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-datetime-attribute.md deleted file mode 100644 index e88ecbc759..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-datetime-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeDatetime = try await databases.createDatetimeAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "", // optional - array: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-document.md b/docs/examples/1.6.x/server-swift/examples/databases/create-document.md deleted file mode 100644 index 78ea97b607..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-document.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let databases = Databases(client) - -let document = try await databases.createDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - data: [:], - permissions: ["read("any")"] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-email-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-email-attribute.md deleted file mode 100644 index f0325b83e1..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-email-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeEmail = try await databases.createEmailAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "email@example.com", // optional - array: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-enum-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-enum-attribute.md deleted file mode 100644 index 3773e7eff8..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-enum-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeEnum = try await databases.createEnumAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - elements: [], - required: false, - default: "<DEFAULT>", // optional - array: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-float-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-float-attribute.md deleted file mode 100644 index e303345c87..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-float-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeFloat = try await databases.createFloatAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, // optional - max: 0, // optional - default: 0, // optional - array: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-index.md b/docs/examples/1.6.x/server-swift/examples/databases/create-index.md deleted file mode 100644 index 6f8d526bfe..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-index.md +++ /dev/null @@ -1,19 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let index = try await databases.createIndex( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - type: .key, - attributes: [], - orders: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-integer-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-integer-attribute.md deleted file mode 100644 index f51508c574..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-integer-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeInteger = try await databases.createIntegerAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, // optional - max: 0, // optional - default: 0, // optional - array: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-ip-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-ip-attribute.md deleted file mode 100644 index 57283b5179..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-ip-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeIp = try await databases.createIpAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "", // optional - array: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-relationship-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-relationship-attribute.md deleted file mode 100644 index 8ed18bf84e..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-relationship-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeRelationship = try await databases.createRelationshipAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - relatedCollectionId: "<RELATED_COLLECTION_ID>", - type: .oneToOne, - twoWay: false, // optional - key: "", // optional - twoWayKey: "", // optional - onDelete: .cascade // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-string-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-string-attribute.md deleted file mode 100644 index eb6a42c176..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-string-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeString = try await databases.createStringAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - size: 1, - required: false, - default: "<DEFAULT>", // optional - array: false, // optional - encrypt: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create-url-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/create-url-attribute.md deleted file mode 100644 index 79773fed10..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create-url-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeUrl = try await databases.createUrlAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "https://example.com", // optional - array: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/create.md b/docs/examples/1.6.x/server-swift/examples/databases/create.md deleted file mode 100644 index 9ce32c48bc..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/create.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let database = try await databases.create( - databaseId: "<DATABASE_ID>", - name: "<NAME>", - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/delete-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/delete-attribute.md deleted file mode 100644 index b2eeb4acb9..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/delete-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let result = try await databases.deleteAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/delete-collection.md b/docs/examples/1.6.x/server-swift/examples/databases/delete-collection.md deleted file mode 100644 index 987ecee9b5..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/delete-collection.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let result = try await databases.deleteCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/delete-document.md b/docs/examples/1.6.x/server-swift/examples/databases/delete-document.md deleted file mode 100644 index 38a1ae2bb4..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/delete-document.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let databases = Databases(client) - -let result = try await databases.deleteDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/delete-index.md b/docs/examples/1.6.x/server-swift/examples/databases/delete-index.md deleted file mode 100644 index e07f1a9acc..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/delete-index.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let result = try await databases.deleteIndex( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/delete.md b/docs/examples/1.6.x/server-swift/examples/databases/delete.md deleted file mode 100644 index 101fa3527f..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let result = try await databases.delete( - databaseId: "<DATABASE_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/get-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/get-attribute.md deleted file mode 100644 index 3395449166..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/get-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let result = try await databases.getAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/get-collection.md b/docs/examples/1.6.x/server-swift/examples/databases/get-collection.md deleted file mode 100644 index f99d553e2d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/get-collection.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let collection = try await databases.getCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/get-document.md b/docs/examples/1.6.x/server-swift/examples/databases/get-document.md deleted file mode 100644 index dee5699341..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/get-document.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let databases = Databases(client) - -let document = try await databases.getDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/get-index.md b/docs/examples/1.6.x/server-swift/examples/databases/get-index.md deleted file mode 100644 index 1ab80c9bc9..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/get-index.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let index = try await databases.getIndex( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/get.md b/docs/examples/1.6.x/server-swift/examples/databases/get.md deleted file mode 100644 index ecddbc2c1d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let database = try await databases.get( - databaseId: "<DATABASE_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/list-attributes.md b/docs/examples/1.6.x/server-swift/examples/databases/list-attributes.md deleted file mode 100644 index 15393cb5ca..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/list-attributes.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeList = try await databases.listAttributes( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/list-collections.md b/docs/examples/1.6.x/server-swift/examples/databases/list-collections.md deleted file mode 100644 index 96f68b6187..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/list-collections.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let collectionList = try await databases.listCollections( - databaseId: "<DATABASE_ID>", - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/list-documents.md b/docs/examples/1.6.x/server-swift/examples/databases/list-documents.md deleted file mode 100644 index 8fc3698337..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/list-documents.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let databases = Databases(client) - -let documentList = try await databases.listDocuments( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/list-indexes.md b/docs/examples/1.6.x/server-swift/examples/databases/list-indexes.md deleted file mode 100644 index cdfcca859c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/list-indexes.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let indexList = try await databases.listIndexes( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/list.md b/docs/examples/1.6.x/server-swift/examples/databases/list.md deleted file mode 100644 index 8236f5d49c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let databaseList = try await databases.list( - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-boolean-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-boolean-attribute.md deleted file mode 100644 index 354aaddcdd..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-boolean-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeBoolean = try await databases.updateBooleanAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: false -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-collection.md b/docs/examples/1.6.x/server-swift/examples/databases/update-collection.md deleted file mode 100644 index 1d1d062017..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-collection.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let collection = try await databases.updateCollection( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - name: "<NAME>", - permissions: ["read("any")"], // optional - documentSecurity: false, // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-datetime-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-datetime-attribute.md deleted file mode 100644 index 1bdcef6d27..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-datetime-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeDatetime = try await databases.updateDatetimeAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-document.md b/docs/examples/1.6.x/server-swift/examples/databases/update-document.md deleted file mode 100644 index d00bf5dad2..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-document.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let databases = Databases(client) - -let document = try await databases.updateDocument( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - documentId: "<DOCUMENT_ID>", - data: [:], // optional - permissions: ["read("any")"] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-email-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-email-attribute.md deleted file mode 100644 index 8cc4630ae8..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-email-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeEmail = try await databases.updateEmailAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "email@example.com" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-enum-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-enum-attribute.md deleted file mode 100644 index ac9f1bdb5d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-enum-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeEnum = try await databases.updateEnumAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - elements: [], - required: false, - default: "<DEFAULT>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-float-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-float-attribute.md deleted file mode 100644 index faee58b2ae..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-float-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeFloat = try await databases.updateFloatAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, - max: 0, - default: 0 -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-integer-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-integer-attribute.md deleted file mode 100644 index a91d97d3ce..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-integer-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeInteger = try await databases.updateIntegerAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - min: 0, - max: 0, - default: 0 -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-ip-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-ip-attribute.md deleted file mode 100644 index 895700a0a1..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-ip-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeIp = try await databases.updateIpAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-relationship-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-relationship-attribute.md deleted file mode 100644 index 7b4f399d3b..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-relationship-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeRelationship = try await databases.updateRelationshipAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - onDelete: .cascade // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-string-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-string-attribute.md deleted file mode 100644 index 102e4b7ace..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-string-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeString = try await databases.updateStringAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "<DEFAULT>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update-url-attribute.md b/docs/examples/1.6.x/server-swift/examples/databases/update-url-attribute.md deleted file mode 100644 index bc081e08ee..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update-url-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let attributeUrl = try await databases.updateUrlAttribute( - databaseId: "<DATABASE_ID>", - collectionId: "<COLLECTION_ID>", - key: "", - required: false, - default: "https://example.com" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/databases/update.md b/docs/examples/1.6.x/server-swift/examples/databases/update.md deleted file mode 100644 index 3b49ba065a..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/databases/update.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let databases = Databases(client) - -let database = try await databases.update( - databaseId: "<DATABASE_ID>", - name: "<NAME>", - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/create-build.md b/docs/examples/1.6.x/server-swift/examples/functions/create-build.md deleted file mode 100644 index bddaf6e361..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/create-build.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let result = try await functions.createBuild( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>", - buildId: "<BUILD_ID>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/create-deployment.md b/docs/examples/1.6.x/server-swift/examples/functions/create-deployment.md deleted file mode 100644 index ea2e8dff76..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/create-deployment.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let deployment = try await functions.createDeployment( - functionId: "<FUNCTION_ID>", - code: InputFile.fromPath("file.png"), - activate: false, - entrypoint: "<ENTRYPOINT>", // optional - commands: "<COMMANDS>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/create-execution.md b/docs/examples/1.6.x/server-swift/examples/functions/create-execution.md deleted file mode 100644 index 9acfdea4d7..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/create-execution.md +++ /dev/null @@ -1,20 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let functions = Functions(client) - -let execution = try await functions.createExecution( - functionId: "<FUNCTION_ID>", - body: "<BODY>", // optional - async: false, // optional - path: "<PATH>", // optional - method: .gET, // optional - headers: [:], // optional - scheduledAt: "" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/create-variable.md b/docs/examples/1.6.x/server-swift/examples/functions/create-variable.md deleted file mode 100644 index e1cd7275fa..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/create-variable.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let variable = try await functions.createVariable( - functionId: "<FUNCTION_ID>", - key: "<KEY>", - value: "<VALUE>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/create.md b/docs/examples/1.6.x/server-swift/examples/functions/create.md deleted file mode 100644 index e508281f63..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/create.md +++ /dev/null @@ -1,34 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let function = try await functions.create( - functionId: "<FUNCTION_ID>", - name: "<NAME>", - runtime: .node145, - execute: ["any"], // optional - events: [], // optional - schedule: "", // optional - timeout: 1, // optional - enabled: false, // optional - logging: false, // optional - entrypoint: "<ENTRYPOINT>", // optional - commands: "<COMMANDS>", // optional - scopes: [], // optional - installationId: "<INSTALLATION_ID>", // optional - providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", // optional - providerBranch: "<PROVIDER_BRANCH>", // optional - providerSilentMode: false, // optional - providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>", // optional - templateRepository: "<TEMPLATE_REPOSITORY>", // optional - templateOwner: "<TEMPLATE_OWNER>", // optional - templateRootDirectory: "<TEMPLATE_ROOT_DIRECTORY>", // optional - templateBranch: "<TEMPLATE_BRANCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/delete-deployment.md b/docs/examples/1.6.x/server-swift/examples/functions/delete-deployment.md deleted file mode 100644 index 177cc5e2fa..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/delete-deployment.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let result = try await functions.deleteDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/delete-execution.md b/docs/examples/1.6.x/server-swift/examples/functions/delete-execution.md deleted file mode 100644 index 8d04d87d78..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/delete-execution.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let result = try await functions.deleteExecution( - functionId: "<FUNCTION_ID>", - executionId: "<EXECUTION_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/delete-variable.md b/docs/examples/1.6.x/server-swift/examples/functions/delete-variable.md deleted file mode 100644 index 5f31d46d48..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/delete-variable.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let result = try await functions.deleteVariable( - functionId: "<FUNCTION_ID>", - variableId: "<VARIABLE_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/delete.md b/docs/examples/1.6.x/server-swift/examples/functions/delete.md deleted file mode 100644 index 1999a00645..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let result = try await functions.delete( - functionId: "<FUNCTION_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/download-deployment.md b/docs/examples/1.6.x/server-swift/examples/functions/download-deployment.md deleted file mode 100644 index 5e50b6798d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/download-deployment.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let bytes = try await functions.downloadDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/get-deployment.md b/docs/examples/1.6.x/server-swift/examples/functions/get-deployment.md deleted file mode 100644 index a4ce8a7ab2..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/get-deployment.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let deployment = try await functions.getDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/get-execution.md b/docs/examples/1.6.x/server-swift/examples/functions/get-execution.md deleted file mode 100644 index 8358745800..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/get-execution.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let functions = Functions(client) - -let execution = try await functions.getExecution( - functionId: "<FUNCTION_ID>", - executionId: "<EXECUTION_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/get-variable.md b/docs/examples/1.6.x/server-swift/examples/functions/get-variable.md deleted file mode 100644 index 25452ac852..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/get-variable.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let variable = try await functions.getVariable( - functionId: "<FUNCTION_ID>", - variableId: "<VARIABLE_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/get.md b/docs/examples/1.6.x/server-swift/examples/functions/get.md deleted file mode 100644 index 27721b7ca2..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let function = try await functions.get( - functionId: "<FUNCTION_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/list-deployments.md b/docs/examples/1.6.x/server-swift/examples/functions/list-deployments.md deleted file mode 100644 index 2f7c5e09df..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/list-deployments.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let deploymentList = try await functions.listDeployments( - functionId: "<FUNCTION_ID>", - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/list-executions.md b/docs/examples/1.6.x/server-swift/examples/functions/list-executions.md deleted file mode 100644 index ec12403095..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/list-executions.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let functions = Functions(client) - -let executionList = try await functions.listExecutions( - functionId: "<FUNCTION_ID>", - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/list-runtimes.md b/docs/examples/1.6.x/server-swift/examples/functions/list-runtimes.md deleted file mode 100644 index 8c75286cd9..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/list-runtimes.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let runtimeList = try await functions.listRuntimes() - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/list-variables.md b/docs/examples/1.6.x/server-swift/examples/functions/list-variables.md deleted file mode 100644 index d82c9fda8c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/list-variables.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let variableList = try await functions.listVariables( - functionId: "<FUNCTION_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/list.md b/docs/examples/1.6.x/server-swift/examples/functions/list.md deleted file mode 100644 index 6f5a848080..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let functionList = try await functions.list( - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/update-deployment-build.md b/docs/examples/1.6.x/server-swift/examples/functions/update-deployment-build.md deleted file mode 100644 index 4c96a5548e..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/update-deployment-build.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let build = try await functions.updateDeploymentBuild( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/update-deployment.md b/docs/examples/1.6.x/server-swift/examples/functions/update-deployment.md deleted file mode 100644 index 7e28c63b60..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/update-deployment.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let function = try await functions.updateDeployment( - functionId: "<FUNCTION_ID>", - deploymentId: "<DEPLOYMENT_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/update-variable.md b/docs/examples/1.6.x/server-swift/examples/functions/update-variable.md deleted file mode 100644 index 8a72e387ed..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/update-variable.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let variable = try await functions.updateVariable( - functionId: "<FUNCTION_ID>", - variableId: "<VARIABLE_ID>", - key: "<KEY>", - value: "<VALUE>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/functions/update.md b/docs/examples/1.6.x/server-swift/examples/functions/update.md deleted file mode 100644 index 61a0f00a45..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/functions/update.md +++ /dev/null @@ -1,30 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let functions = Functions(client) - -let function = try await functions.update( - functionId: "<FUNCTION_ID>", - name: "<NAME>", - runtime: .node145, // optional - execute: ["any"], // optional - events: [], // optional - schedule: "", // optional - timeout: 1, // optional - enabled: false, // optional - logging: false, // optional - entrypoint: "<ENTRYPOINT>", // optional - commands: "<COMMANDS>", // optional - scopes: [], // optional - installationId: "<INSTALLATION_ID>", // optional - providerRepositoryId: "<PROVIDER_REPOSITORY_ID>", // optional - providerBranch: "<PROVIDER_BRANCH>", // optional - providerSilentMode: false, // optional - providerRootDirectory: "<PROVIDER_ROOT_DIRECTORY>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/graphql/mutation.md b/docs/examples/1.6.x/server-swift/examples/graphql/mutation.md deleted file mode 100644 index 808526faca..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/graphql/mutation.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let graphql = Graphql(client) - -let any = try await graphql.mutation( - query: [:] -) - diff --git a/docs/examples/1.6.x/server-swift/examples/graphql/query.md b/docs/examples/1.6.x/server-swift/examples/graphql/query.md deleted file mode 100644 index a528957dee..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/graphql/query.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let graphql = Graphql(client) - -let any = try await graphql.query( - query: [:] -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-antivirus.md b/docs/examples/1.6.x/server-swift/examples/health/get-antivirus.md deleted file mode 100644 index 5ff9d324c8..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-antivirus.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthAntivirus = try await health.getAntivirus() - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-cache.md b/docs/examples/1.6.x/server-swift/examples/health/get-cache.md deleted file mode 100644 index 74e304cf65..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-cache.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthStatus = try await health.getCache() - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-certificate.md b/docs/examples/1.6.x/server-swift/examples/health/get-certificate.md deleted file mode 100644 index 5fcb837854..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-certificate.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthCertificate = try await health.getCertificate( - domain: "" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-d-b.md b/docs/examples/1.6.x/server-swift/examples/health/get-d-b.md deleted file mode 100644 index e3b7e50545..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-d-b.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthStatus = try await health.getDB() - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-failed-jobs.md b/docs/examples/1.6.x/server-swift/examples/health/get-failed-jobs.md deleted file mode 100644 index 6727f0bd26..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-failed-jobs.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getFailedJobs( - name: .v1Database, - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-pub-sub.md b/docs/examples/1.6.x/server-swift/examples/health/get-pub-sub.md deleted file mode 100644 index ef2cd3aac7..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-pub-sub.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthStatus = try await health.getPubSub() - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-builds.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-builds.md deleted file mode 100644 index d583a7e218..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-builds.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueBuilds( - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-certificates.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-certificates.md deleted file mode 100644 index 80b933ec9c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-certificates.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueCertificates( - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-databases.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-databases.md deleted file mode 100644 index b45ab17ee7..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-databases.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueDatabases( - name: "<NAME>", // optional - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-deletes.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-deletes.md deleted file mode 100644 index 611700f658..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-deletes.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueDeletes( - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-functions.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-functions.md deleted file mode 100644 index 6defa5064c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-functions.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueFunctions( - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-logs.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-logs.md deleted file mode 100644 index e09daf2c43..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-logs.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueLogs( - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-mails.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-mails.md deleted file mode 100644 index 9e01f9a002..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-mails.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueMails( - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-messaging.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-messaging.md deleted file mode 100644 index b8c053a5b2..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-messaging.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueMessaging( - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-migrations.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-migrations.md deleted file mode 100644 index 73a6e2585a..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-migrations.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueMigrations( - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage-dump.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage-dump.md deleted file mode 100644 index b17cf475cc..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage-dump.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueUsageDump( - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage.md deleted file mode 100644 index ce37f408af..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-usage.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueUsage( - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue-webhooks.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue-webhooks.md deleted file mode 100644 index f4ed9ec359..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue-webhooks.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthQueue = try await health.getQueueWebhooks( - threshold: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-queue.md b/docs/examples/1.6.x/server-swift/examples/health/get-queue.md deleted file mode 100644 index d36883534f..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-queue.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthStatus = try await health.getQueue() - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-storage-local.md b/docs/examples/1.6.x/server-swift/examples/health/get-storage-local.md deleted file mode 100644 index 4044ba2a88..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-storage-local.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthStatus = try await health.getStorageLocal() - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-storage.md b/docs/examples/1.6.x/server-swift/examples/health/get-storage.md deleted file mode 100644 index 761aace556..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-storage.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthStatus = try await health.getStorage() - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get-time.md b/docs/examples/1.6.x/server-swift/examples/health/get-time.md deleted file mode 100644 index af085626d0..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get-time.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthTime = try await health.getTime() - diff --git a/docs/examples/1.6.x/server-swift/examples/health/get.md b/docs/examples/1.6.x/server-swift/examples/health/get.md deleted file mode 100644 index e63e18c0c7..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/health/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let health = Health(client) - -let healthStatus = try await health.get() - diff --git a/docs/examples/1.6.x/server-swift/examples/locale/get.md b/docs/examples/1.6.x/server-swift/examples/locale/get.md deleted file mode 100644 index b94af37813..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/locale/get.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let locale = Locale(client) - -let locale = try await locale.get() - diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-codes.md b/docs/examples/1.6.x/server-swift/examples/locale/list-codes.md deleted file mode 100644 index 247f8f3b38..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/locale/list-codes.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let locale = Locale(client) - -let localeCodeList = try await locale.listCodes() - diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-continents.md b/docs/examples/1.6.x/server-swift/examples/locale/list-continents.md deleted file mode 100644 index 481a205659..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/locale/list-continents.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let locale = Locale(client) - -let continentList = try await locale.listContinents() - diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-countries-e-u.md b/docs/examples/1.6.x/server-swift/examples/locale/list-countries-e-u.md deleted file mode 100644 index 047877daca..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/locale/list-countries-e-u.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let locale = Locale(client) - -let countryList = try await locale.listCountriesEU() - diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-countries-phones.md b/docs/examples/1.6.x/server-swift/examples/locale/list-countries-phones.md deleted file mode 100644 index c7e182af88..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/locale/list-countries-phones.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let locale = Locale(client) - -let phoneList = try await locale.listCountriesPhones() - diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-countries.md b/docs/examples/1.6.x/server-swift/examples/locale/list-countries.md deleted file mode 100644 index e0ec084114..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/locale/list-countries.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let locale = Locale(client) - -let countryList = try await locale.listCountries() - diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-currencies.md b/docs/examples/1.6.x/server-swift/examples/locale/list-currencies.md deleted file mode 100644 index 280909d482..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/locale/list-currencies.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let locale = Locale(client) - -let currencyList = try await locale.listCurrencies() - diff --git a/docs/examples/1.6.x/server-swift/examples/locale/list-languages.md b/docs/examples/1.6.x/server-swift/examples/locale/list-languages.md deleted file mode 100644 index 1dcc6ddf56..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/locale/list-languages.md +++ /dev/null @@ -1,11 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let locale = Locale(client) - -let languageList = try await locale.listLanguages() - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-apns-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-apns-provider.md deleted file mode 100644 index f38b435371..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-apns-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.createApnsProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - authKey: "<AUTH_KEY>", // optional - authKeyId: "<AUTH_KEY_ID>", // optional - teamId: "<TEAM_ID>", // optional - bundleId: "<BUNDLE_ID>", // optional - sandbox: false, // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-email.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-email.md deleted file mode 100644 index ede0a3b1b8..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-email.md +++ /dev/null @@ -1,24 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let message = try await messaging.createEmail( - messageId: "<MESSAGE_ID>", - subject: "<SUBJECT>", - content: "<CONTENT>", - topics: [], // optional - users: [], // optional - targets: [], // optional - cc: [], // optional - bcc: [], // optional - attachments: [], // optional - draft: false, // optional - html: false, // optional - scheduledAt: "" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-fcm-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-fcm-provider.md deleted file mode 100644 index b4e8df3f6d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-fcm-provider.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.createFcmProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - serviceAccountJSON: [:], // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-mailgun-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-mailgun-provider.md deleted file mode 100644 index c5f958bb52..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-mailgun-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.createMailgunProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - apiKey: "<API_KEY>", // optional - domain: "<DOMAIN>", // optional - isEuRegion: false, // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "email@example.com", // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-msg91provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-msg91provider.md deleted file mode 100644 index 8e3905160d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-msg91provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.createMsg91Provider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - templateId: "<TEMPLATE_ID>", // optional - senderId: "<SENDER_ID>", // optional - authKey: "<AUTH_KEY>", // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-push.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-push.md deleted file mode 100644 index 7aed2b5792..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-push.md +++ /dev/null @@ -1,28 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let message = try await messaging.createPush( - messageId: "<MESSAGE_ID>", - title: "<TITLE>", - body: "<BODY>", - topics: [], // optional - users: [], // optional - targets: [], // optional - data: [:], // optional - action: "<ACTION>", // optional - image: "[ID1:ID2]", // optional - icon: "<ICON>", // optional - sound: "<SOUND>", // optional - color: "<COLOR>", // optional - tag: "<TAG>", // optional - badge: "<BADGE>", // optional - draft: false, // optional - scheduledAt: "" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-sendgrid-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-sendgrid-provider.md deleted file mode 100644 index 22d1f05e1d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-sendgrid-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.createSendgridProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - apiKey: "<API_KEY>", // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "email@example.com", // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-sms.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-sms.md deleted file mode 100644 index 10936dbd66..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-sms.md +++ /dev/null @@ -1,19 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let message = try await messaging.createSms( - messageId: "<MESSAGE_ID>", - content: "<CONTENT>", - topics: [], // optional - users: [], // optional - targets: [], // optional - draft: false, // optional - scheduledAt: "" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-smtp-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-smtp-provider.md deleted file mode 100644 index bd0d4c05a8..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-smtp-provider.md +++ /dev/null @@ -1,27 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.createSmtpProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - host: "<HOST>", - port: 1, // optional - username: "<USERNAME>", // optional - password: "<PASSWORD>", // optional - encryption: .none, // optional - autoTLS: false, // optional - mailer: "<MAILER>", // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "email@example.com", // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-subscriber.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-subscriber.md deleted file mode 100644 index 170a3072c0..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-subscriber.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setJWT("<YOUR_JWT>") // Your secret JSON Web Token - -let messaging = Messaging(client) - -let subscriber = try await messaging.createSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>", - targetId: "<TARGET_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-telesign-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-telesign-provider.md deleted file mode 100644 index bc4ab89728..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-telesign-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.createTelesignProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", // optional - customerId: "<CUSTOMER_ID>", // optional - apiKey: "<API_KEY>", // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-textmagic-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-textmagic-provider.md deleted file mode 100644 index 735bd57fa1..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-textmagic-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.createTextmagicProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", // optional - username: "<USERNAME>", // optional - apiKey: "<API_KEY>", // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-topic.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-topic.md deleted file mode 100644 index f44aa65d56..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-topic.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let topic = try await messaging.createTopic( - topicId: "<TOPIC_ID>", - name: "<NAME>", - subscribe: ["any"] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-twilio-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-twilio-provider.md deleted file mode 100644 index 8a3594dcfb..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-twilio-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.createTwilioProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", // optional - accountSid: "<ACCOUNT_SID>", // optional - authToken: "<AUTH_TOKEN>", // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/create-vonage-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/create-vonage-provider.md deleted file mode 100644 index 0a932e599f..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/create-vonage-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.createVonageProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", - from: "+12065550100", // optional - apiKey: "<API_KEY>", // optional - apiSecret: "<API_SECRET>", // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/delete-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/delete-provider.md deleted file mode 100644 index 2a8f049140..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/delete-provider.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let result = try await messaging.deleteProvider( - providerId: "<PROVIDER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/delete-subscriber.md b/docs/examples/1.6.x/server-swift/examples/messaging/delete-subscriber.md deleted file mode 100644 index ea1f54641e..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/delete-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setJWT("<YOUR_JWT>") // Your secret JSON Web Token - -let messaging = Messaging(client) - -let result = try await messaging.deleteSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/delete-topic.md b/docs/examples/1.6.x/server-swift/examples/messaging/delete-topic.md deleted file mode 100644 index 76c7c7b821..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/delete-topic.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let result = try await messaging.deleteTopic( - topicId: "<TOPIC_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/delete.md b/docs/examples/1.6.x/server-swift/examples/messaging/delete.md deleted file mode 100644 index e94f4b99f2..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let result = try await messaging.delete( - messageId: "<MESSAGE_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/get-message.md b/docs/examples/1.6.x/server-swift/examples/messaging/get-message.md deleted file mode 100644 index 27256d8f71..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/get-message.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let message = try await messaging.getMessage( - messageId: "<MESSAGE_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/get-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/get-provider.md deleted file mode 100644 index 7647290df1..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/get-provider.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.getProvider( - providerId: "<PROVIDER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/get-subscriber.md b/docs/examples/1.6.x/server-swift/examples/messaging/get-subscriber.md deleted file mode 100644 index ebccc358c8..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/get-subscriber.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let subscriber = try await messaging.getSubscriber( - topicId: "<TOPIC_ID>", - subscriberId: "<SUBSCRIBER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/get-topic.md b/docs/examples/1.6.x/server-swift/examples/messaging/get-topic.md deleted file mode 100644 index 421023cce4..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/get-topic.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let topic = try await messaging.getTopic( - topicId: "<TOPIC_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-message-logs.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-message-logs.md deleted file mode 100644 index 61d2ceccf1..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/list-message-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let logList = try await messaging.listMessageLogs( - messageId: "<MESSAGE_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-messages.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-messages.md deleted file mode 100644 index 8912603782..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/list-messages.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let messageList = try await messaging.listMessages( - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-provider-logs.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-provider-logs.md deleted file mode 100644 index 2ad9cd78df..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/list-provider-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let logList = try await messaging.listProviderLogs( - providerId: "<PROVIDER_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-providers.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-providers.md deleted file mode 100644 index 0bce1e78a5..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/list-providers.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let providerList = try await messaging.listProviders( - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-subscriber-logs.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-subscriber-logs.md deleted file mode 100644 index 78dea44090..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/list-subscriber-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let logList = try await messaging.listSubscriberLogs( - subscriberId: "<SUBSCRIBER_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-subscribers.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-subscribers.md deleted file mode 100644 index 35b3daa16e..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/list-subscribers.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let subscriberList = try await messaging.listSubscribers( - topicId: "<TOPIC_ID>", - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-targets.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-targets.md deleted file mode 100644 index e469da31b3..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/list-targets.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let targetList = try await messaging.listTargets( - messageId: "<MESSAGE_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-topic-logs.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-topic-logs.md deleted file mode 100644 index c8d13bf82b..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/list-topic-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let logList = try await messaging.listTopicLogs( - topicId: "<TOPIC_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/list-topics.md b/docs/examples/1.6.x/server-swift/examples/messaging/list-topics.md deleted file mode 100644 index 3a6ba4c5df..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/list-topics.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let topicList = try await messaging.listTopics( - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-apns-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-apns-provider.md deleted file mode 100644 index 7202530cc7..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-apns-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.updateApnsProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - authKey: "<AUTH_KEY>", // optional - authKeyId: "<AUTH_KEY_ID>", // optional - teamId: "<TEAM_ID>", // optional - bundleId: "<BUNDLE_ID>", // optional - sandbox: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-email.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-email.md deleted file mode 100644 index e27c826281..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-email.md +++ /dev/null @@ -1,24 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let message = try await messaging.updateEmail( - messageId: "<MESSAGE_ID>", - topics: [], // optional - users: [], // optional - targets: [], // optional - subject: "<SUBJECT>", // optional - content: "<CONTENT>", // optional - draft: false, // optional - html: false, // optional - cc: [], // optional - bcc: [], // optional - scheduledAt: "", // optional - attachments: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-fcm-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-fcm-provider.md deleted file mode 100644 index b62ba88f8f..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-fcm-provider.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.updateFcmProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - serviceAccountJSON: [:] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-mailgun-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-mailgun-provider.md deleted file mode 100644 index d684a96ca8..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-mailgun-provider.md +++ /dev/null @@ -1,22 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.updateMailgunProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - apiKey: "<API_KEY>", // optional - domain: "<DOMAIN>", // optional - isEuRegion: false, // optional - enabled: false, // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "<REPLY_TO_EMAIL>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-msg91provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-msg91provider.md deleted file mode 100644 index aac6942de4..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-msg91provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.updateMsg91Provider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - templateId: "<TEMPLATE_ID>", // optional - senderId: "<SENDER_ID>", // optional - authKey: "<AUTH_KEY>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-push.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-push.md deleted file mode 100644 index c793143610..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-push.md +++ /dev/null @@ -1,28 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let message = try await messaging.updatePush( - messageId: "<MESSAGE_ID>", - topics: [], // optional - users: [], // optional - targets: [], // optional - title: "<TITLE>", // optional - body: "<BODY>", // optional - data: [:], // optional - action: "<ACTION>", // optional - image: "[ID1:ID2]", // optional - icon: "<ICON>", // optional - sound: "<SOUND>", // optional - color: "<COLOR>", // optional - tag: "<TAG>", // optional - badge: 0, // optional - draft: false, // optional - scheduledAt: "" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-sendgrid-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-sendgrid-provider.md deleted file mode 100644 index 811fb05aca..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-sendgrid-provider.md +++ /dev/null @@ -1,20 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.updateSendgridProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - apiKey: "<API_KEY>", // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "<REPLY_TO_EMAIL>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-sms.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-sms.md deleted file mode 100644 index db1262ed81..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-sms.md +++ /dev/null @@ -1,19 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let message = try await messaging.updateSms( - messageId: "<MESSAGE_ID>", - topics: [], // optional - users: [], // optional - targets: [], // optional - content: "<CONTENT>", // optional - draft: false, // optional - scheduledAt: "" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-smtp-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-smtp-provider.md deleted file mode 100644 index 98f7a212e7..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-smtp-provider.md +++ /dev/null @@ -1,27 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.updateSmtpProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - host: "<HOST>", // optional - port: 1, // optional - username: "<USERNAME>", // optional - password: "<PASSWORD>", // optional - encryption: .none, // optional - autoTLS: false, // optional - mailer: "<MAILER>", // optional - fromName: "<FROM_NAME>", // optional - fromEmail: "email@example.com", // optional - replyToName: "<REPLY_TO_NAME>", // optional - replyToEmail: "<REPLY_TO_EMAIL>", // optional - enabled: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-telesign-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-telesign-provider.md deleted file mode 100644 index cc3f0ea608..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-telesign-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.updateTelesignProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - customerId: "<CUSTOMER_ID>", // optional - apiKey: "<API_KEY>", // optional - from: "<FROM>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-textmagic-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-textmagic-provider.md deleted file mode 100644 index 68961c41bc..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-textmagic-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.updateTextmagicProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - username: "<USERNAME>", // optional - apiKey: "<API_KEY>", // optional - from: "<FROM>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-topic.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-topic.md deleted file mode 100644 index 5abbf7adcc..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-topic.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let topic = try await messaging.updateTopic( - topicId: "<TOPIC_ID>", - name: "<NAME>", // optional - subscribe: ["any"] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-twilio-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-twilio-provider.md deleted file mode 100644 index a48f18c0e1..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-twilio-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.updateTwilioProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - accountSid: "<ACCOUNT_SID>", // optional - authToken: "<AUTH_TOKEN>", // optional - from: "<FROM>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/messaging/update-vonage-provider.md b/docs/examples/1.6.x/server-swift/examples/messaging/update-vonage-provider.md deleted file mode 100644 index 1c8e47c26f..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/messaging/update-vonage-provider.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let messaging = Messaging(client) - -let provider = try await messaging.updateVonageProvider( - providerId: "<PROVIDER_ID>", - name: "<NAME>", // optional - enabled: false, // optional - apiKey: "<API_KEY>", // optional - apiSecret: "<API_SECRET>", // optional - from: "<FROM>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/create-bucket.md b/docs/examples/1.6.x/server-swift/examples/storage/create-bucket.md deleted file mode 100644 index 7c934ec8bd..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/create-bucket.md +++ /dev/null @@ -1,23 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let storage = Storage(client) - -let bucket = try await storage.createBucket( - bucketId: "<BUCKET_ID>", - name: "<NAME>", - permissions: ["read("any")"], // optional - fileSecurity: false, // optional - enabled: false, // optional - maximumFileSize: 1, // optional - allowedFileExtensions: [], // optional - compression: .none, // optional - encryption: false, // optional - antivirus: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/create-file.md b/docs/examples/1.6.x/server-swift/examples/storage/create-file.md deleted file mode 100644 index 7ce485ad50..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/create-file.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let storage = Storage(client) - -let file = try await storage.createFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - file: InputFile.fromPath("file.png"), - permissions: ["read("any")"] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/delete-bucket.md b/docs/examples/1.6.x/server-swift/examples/storage/delete-bucket.md deleted file mode 100644 index e85ce3b386..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/delete-bucket.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let storage = Storage(client) - -let result = try await storage.deleteBucket( - bucketId: "<BUCKET_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/delete-file.md b/docs/examples/1.6.x/server-swift/examples/storage/delete-file.md deleted file mode 100644 index 8a9ceee18c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/delete-file.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let storage = Storage(client) - -let result = try await storage.deleteFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/get-bucket.md b/docs/examples/1.6.x/server-swift/examples/storage/get-bucket.md deleted file mode 100644 index 4e78e32c9d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/get-bucket.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let storage = Storage(client) - -let bucket = try await storage.getBucket( - bucketId: "<BUCKET_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/get-file-download.md b/docs/examples/1.6.x/server-swift/examples/storage/get-file-download.md deleted file mode 100644 index be3db0c946..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/get-file-download.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let storage = Storage(client) - -let bytes = try await storage.getFileDownload( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/get-file-preview.md b/docs/examples/1.6.x/server-swift/examples/storage/get-file-preview.md deleted file mode 100644 index cab3fc67f4..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/get-file-preview.md +++ /dev/null @@ -1,26 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let storage = Storage(client) - -let bytes = try await storage.getFilePreview( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - width: 0, // optional - height: 0, // optional - gravity: .center, // optional - quality: 0, // optional - borderWidth: 0, // optional - borderColor: "", // optional - borderRadius: 0, // optional - opacity: 0, // optional - rotation: -360, // optional - background: "", // optional - output: .jpg // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/get-file-view.md b/docs/examples/1.6.x/server-swift/examples/storage/get-file-view.md deleted file mode 100644 index d1275a76b0..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/get-file-view.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let storage = Storage(client) - -let bytes = try await storage.getFileView( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/get-file.md b/docs/examples/1.6.x/server-swift/examples/storage/get-file.md deleted file mode 100644 index 1f70f49543..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/get-file.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let storage = Storage(client) - -let file = try await storage.getFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/list-buckets.md b/docs/examples/1.6.x/server-swift/examples/storage/list-buckets.md deleted file mode 100644 index 9fb0b4ea46..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/list-buckets.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let storage = Storage(client) - -let bucketList = try await storage.listBuckets( - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/list-files.md b/docs/examples/1.6.x/server-swift/examples/storage/list-files.md deleted file mode 100644 index cb415b0b6c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/list-files.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let storage = Storage(client) - -let fileList = try await storage.listFiles( - bucketId: "<BUCKET_ID>", - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/update-bucket.md b/docs/examples/1.6.x/server-swift/examples/storage/update-bucket.md deleted file mode 100644 index adb1c35673..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/update-bucket.md +++ /dev/null @@ -1,23 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let storage = Storage(client) - -let bucket = try await storage.updateBucket( - bucketId: "<BUCKET_ID>", - name: "<NAME>", - permissions: ["read("any")"], // optional - fileSecurity: false, // optional - enabled: false, // optional - maximumFileSize: 1, // optional - allowedFileExtensions: [], // optional - compression: .none, // optional - encryption: false, // optional - antivirus: false // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/storage/update-file.md b/docs/examples/1.6.x/server-swift/examples/storage/update-file.md deleted file mode 100644 index 068509959d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/storage/update-file.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let storage = Storage(client) - -let file = try await storage.updateFile( - bucketId: "<BUCKET_ID>", - fileId: "<FILE_ID>", - name: "<NAME>", // optional - permissions: ["read("any")"] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/create-membership.md b/docs/examples/1.6.x/server-swift/examples/teams/create-membership.md deleted file mode 100644 index f4d79427d6..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/create-membership.md +++ /dev/null @@ -1,19 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let membership = try await teams.createMembership( - teamId: "<TEAM_ID>", - roles: [], - email: "email@example.com", // optional - userId: "<USER_ID>", // optional - phone: "+12065550100", // optional - url: "https://example.com", // optional - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/create.md b/docs/examples/1.6.x/server-swift/examples/teams/create.md deleted file mode 100644 index a3e2249aa8..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/create.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let team = try await teams.create( - teamId: "<TEAM_ID>", - name: "<NAME>", - roles: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/delete-membership.md b/docs/examples/1.6.x/server-swift/examples/teams/delete-membership.md deleted file mode 100644 index dac308b836..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/delete-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let result = try await teams.deleteMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/delete.md b/docs/examples/1.6.x/server-swift/examples/teams/delete.md deleted file mode 100644 index 0014ac0f5e..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let result = try await teams.delete( - teamId: "<TEAM_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/get-membership.md b/docs/examples/1.6.x/server-swift/examples/teams/get-membership.md deleted file mode 100644 index 6d9627f417..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/get-membership.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let membership = try await teams.getMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/get-prefs.md b/docs/examples/1.6.x/server-swift/examples/teams/get-prefs.md deleted file mode 100644 index 00d2c94be6..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/get-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let preferences = try await teams.getPrefs( - teamId: "<TEAM_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/get.md b/docs/examples/1.6.x/server-swift/examples/teams/get.md deleted file mode 100644 index 14da194222..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let team = try await teams.get( - teamId: "<TEAM_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/list-memberships.md b/docs/examples/1.6.x/server-swift/examples/teams/list-memberships.md deleted file mode 100644 index 14268f97ab..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/list-memberships.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let membershipList = try await teams.listMemberships( - teamId: "<TEAM_ID>", - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/list.md b/docs/examples/1.6.x/server-swift/examples/teams/list.md deleted file mode 100644 index c0ab352788..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let teamList = try await teams.list( - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/update-membership-status.md b/docs/examples/1.6.x/server-swift/examples/teams/update-membership-status.md deleted file mode 100644 index c6ea9590b5..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/update-membership-status.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let membership = try await teams.updateMembershipStatus( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>", - userId: "<USER_ID>", - secret: "<SECRET>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/update-membership.md b/docs/examples/1.6.x/server-swift/examples/teams/update-membership.md deleted file mode 100644 index 234274000b..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/update-membership.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let membership = try await teams.updateMembership( - teamId: "<TEAM_ID>", - membershipId: "<MEMBERSHIP_ID>", - roles: [] -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/update-name.md b/docs/examples/1.6.x/server-swift/examples/teams/update-name.md deleted file mode 100644 index 450884ba79..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/update-name.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let team = try await teams.updateName( - teamId: "<TEAM_ID>", - name: "<NAME>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/teams/update-prefs.md b/docs/examples/1.6.x/server-swift/examples/teams/update-prefs.md deleted file mode 100644 index 4f5e1d1c6d..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/teams/update-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setSession("") // The user session to authenticate with - -let teams = Teams(client) - -let preferences = try await teams.updatePrefs( - teamId: "<TEAM_ID>", - prefs: [:] -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-argon2user.md b/docs/examples/1.6.x/server-swift/examples/users/create-argon2user.md deleted file mode 100644 index af9bc4b628..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-argon2user.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.createArgon2User( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-bcrypt-user.md b/docs/examples/1.6.x/server-swift/examples/users/create-bcrypt-user.md deleted file mode 100644 index fa65ed9f5c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-bcrypt-user.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.createBcryptUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-j-w-t.md b/docs/examples/1.6.x/server-swift/examples/users/create-j-w-t.md deleted file mode 100644 index 4bb01a7041..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-j-w-t.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let jwt = try await users.createJWT( - userId: "<USER_ID>", - sessionId: "<SESSION_ID>", // optional - duration: 0 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-m-d5user.md b/docs/examples/1.6.x/server-swift/examples/users/create-m-d5user.md deleted file mode 100644 index 7dac068827..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-m-d5user.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.createMD5User( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/users/create-mfa-recovery-codes.md deleted file mode 100644 index d525d6acf0..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-mfa-recovery-codes.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let mfaRecoveryCodes = try await users.createMfaRecoveryCodes( - userId: "<USER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-p-h-pass-user.md b/docs/examples/1.6.x/server-swift/examples/users/create-p-h-pass-user.md deleted file mode 100644 index 1c9f2dc373..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-p-h-pass-user.md +++ /dev/null @@ -1,16 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.createPHPassUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-s-h-a-user.md b/docs/examples/1.6.x/server-swift/examples/users/create-s-h-a-user.md deleted file mode 100644 index e05f420e51..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-s-h-a-user.md +++ /dev/null @@ -1,18 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.createSHAUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - passwordVersion: .sha1, // optional - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-modified-user.md b/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-modified-user.md deleted file mode 100644 index d994e8a85c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-modified-user.md +++ /dev/null @@ -1,19 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.createScryptModifiedUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - passwordSalt: "<PASSWORD_SALT>", - passwordSaltSeparator: "<PASSWORD_SALT_SEPARATOR>", - passwordSignerKey: "<PASSWORD_SIGNER_KEY>", - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-user.md b/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-user.md deleted file mode 100644 index 12790311cd..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-scrypt-user.md +++ /dev/null @@ -1,21 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.createScryptUser( - userId: "<USER_ID>", - email: "email@example.com", - password: "password", - passwordSalt: "<PASSWORD_SALT>", - passwordCpu: 0, - passwordMemory: 0, - passwordParallel: 0, - passwordLength: 0, - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-session.md b/docs/examples/1.6.x/server-swift/examples/users/create-session.md deleted file mode 100644 index f27717c401..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-session.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let session = try await users.createSession( - userId: "<USER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-target.md b/docs/examples/1.6.x/server-swift/examples/users/create-target.md deleted file mode 100644 index 9eaf28d9fa..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-target.md +++ /dev/null @@ -1,19 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let target = try await users.createTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>", - providerType: .email, - identifier: "<IDENTIFIER>", - providerId: "<PROVIDER_ID>", // optional - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create-token.md b/docs/examples/1.6.x/server-swift/examples/users/create-token.md deleted file mode 100644 index bc5691bcae..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create-token.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let token = try await users.createToken( - userId: "<USER_ID>", - length: 4, // optional - expire: 60 // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/create.md b/docs/examples/1.6.x/server-swift/examples/users/create.md deleted file mode 100644 index 4bd7474519..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/create.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.create( - userId: "<USER_ID>", - email: "email@example.com", // optional - phone: "+12065550100", // optional - password: "", // optional - name: "<NAME>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete-identity.md b/docs/examples/1.6.x/server-swift/examples/users/delete-identity.md deleted file mode 100644 index 3003a4f514..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/delete-identity.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let result = try await users.deleteIdentity( - identityId: "<IDENTITY_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete-mfa-authenticator.md b/docs/examples/1.6.x/server-swift/examples/users/delete-mfa-authenticator.md deleted file mode 100644 index b96ce46d16..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/delete-mfa-authenticator.md +++ /dev/null @@ -1,15 +0,0 @@ -import Appwrite -import AppwriteEnums - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.deleteMfaAuthenticator( - userId: "<USER_ID>", - type: .totp -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete-session.md b/docs/examples/1.6.x/server-swift/examples/users/delete-session.md deleted file mode 100644 index f9e4856bfb..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/delete-session.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let result = try await users.deleteSession( - userId: "<USER_ID>", - sessionId: "<SESSION_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete-sessions.md b/docs/examples/1.6.x/server-swift/examples/users/delete-sessions.md deleted file mode 100644 index 87a73d5e13..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/delete-sessions.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let result = try await users.deleteSessions( - userId: "<USER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete-target.md b/docs/examples/1.6.x/server-swift/examples/users/delete-target.md deleted file mode 100644 index f628f39f4e..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/delete-target.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let result = try await users.deleteTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/delete.md b/docs/examples/1.6.x/server-swift/examples/users/delete.md deleted file mode 100644 index 76aabd11f8..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/delete.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let result = try await users.delete( - userId: "<USER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/get-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/users/get-mfa-recovery-codes.md deleted file mode 100644 index db8a01d9f2..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/get-mfa-recovery-codes.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let mfaRecoveryCodes = try await users.getMfaRecoveryCodes( - userId: "<USER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/get-prefs.md b/docs/examples/1.6.x/server-swift/examples/users/get-prefs.md deleted file mode 100644 index 732a00b65b..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/get-prefs.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let preferences = try await users.getPrefs( - userId: "<USER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/get-target.md b/docs/examples/1.6.x/server-swift/examples/users/get-target.md deleted file mode 100644 index 8217a3ec43..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/get-target.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let target = try await users.getTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/get.md b/docs/examples/1.6.x/server-swift/examples/users/get.md deleted file mode 100644 index 221d3c9338..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/get.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.get( - userId: "<USER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-identities.md b/docs/examples/1.6.x/server-swift/examples/users/list-identities.md deleted file mode 100644 index 21ed27b106..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/list-identities.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let identityList = try await users.listIdentities( - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-logs.md b/docs/examples/1.6.x/server-swift/examples/users/list-logs.md deleted file mode 100644 index e078c2a2eb..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/list-logs.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let logList = try await users.listLogs( - userId: "<USER_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-memberships.md b/docs/examples/1.6.x/server-swift/examples/users/list-memberships.md deleted file mode 100644 index 86fbf72326..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/list-memberships.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let membershipList = try await users.listMemberships( - userId: "<USER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-mfa-factors.md b/docs/examples/1.6.x/server-swift/examples/users/list-mfa-factors.md deleted file mode 100644 index 87b123bc40..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/list-mfa-factors.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let mfaFactors = try await users.listMfaFactors( - userId: "<USER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-sessions.md b/docs/examples/1.6.x/server-swift/examples/users/list-sessions.md deleted file mode 100644 index 3c494e35a8..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/list-sessions.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let sessionList = try await users.listSessions( - userId: "<USER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/list-targets.md b/docs/examples/1.6.x/server-swift/examples/users/list-targets.md deleted file mode 100644 index 541715c2a4..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/list-targets.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let targetList = try await users.listTargets( - userId: "<USER_ID>", - queries: [] // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/list.md b/docs/examples/1.6.x/server-swift/examples/users/list.md deleted file mode 100644 index 0bc4d85ed2..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/list.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let userList = try await users.list( - queries: [], // optional - search: "<SEARCH>" // optional -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-email-verification.md b/docs/examples/1.6.x/server-swift/examples/users/update-email-verification.md deleted file mode 100644 index de43107c44..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-email-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.updateEmailVerification( - userId: "<USER_ID>", - emailVerification: false -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-email.md b/docs/examples/1.6.x/server-swift/examples/users/update-email.md deleted file mode 100644 index 5cbf2ef6bf..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-email.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.updateEmail( - userId: "<USER_ID>", - email: "email@example.com" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-labels.md b/docs/examples/1.6.x/server-swift/examples/users/update-labels.md deleted file mode 100644 index 37341941c4..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-labels.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.updateLabels( - userId: "<USER_ID>", - labels: [] -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-mfa-recovery-codes.md b/docs/examples/1.6.x/server-swift/examples/users/update-mfa-recovery-codes.md deleted file mode 100644 index 48de0abe52..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-mfa-recovery-codes.md +++ /dev/null @@ -1,13 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let mfaRecoveryCodes = try await users.updateMfaRecoveryCodes( - userId: "<USER_ID>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-mfa.md b/docs/examples/1.6.x/server-swift/examples/users/update-mfa.md deleted file mode 100644 index 0612a31643..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-mfa.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.updateMfa( - userId: "<USER_ID>", - mfa: false -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-name.md b/docs/examples/1.6.x/server-swift/examples/users/update-name.md deleted file mode 100644 index 03914f95a5..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-name.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.updateName( - userId: "<USER_ID>", - name: "<NAME>" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-password.md b/docs/examples/1.6.x/server-swift/examples/users/update-password.md deleted file mode 100644 index 054875c23b..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-password.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.updatePassword( - userId: "<USER_ID>", - password: "" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-phone-verification.md b/docs/examples/1.6.x/server-swift/examples/users/update-phone-verification.md deleted file mode 100644 index b0a3fe89f3..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-phone-verification.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.updatePhoneVerification( - userId: "<USER_ID>", - phoneVerification: false -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-phone.md b/docs/examples/1.6.x/server-swift/examples/users/update-phone.md deleted file mode 100644 index d29676f2b8..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-phone.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.updatePhone( - userId: "<USER_ID>", - number: "+12065550100" -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-prefs.md b/docs/examples/1.6.x/server-swift/examples/users/update-prefs.md deleted file mode 100644 index 19d2aadaca..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-prefs.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let preferences = try await users.updatePrefs( - userId: "<USER_ID>", - prefs: [:] -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-status.md b/docs/examples/1.6.x/server-swift/examples/users/update-status.md deleted file mode 100644 index 90ea4f6c25..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-status.md +++ /dev/null @@ -1,14 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let user = try await users.updateStatus( - userId: "<USER_ID>", - status: false -) - diff --git a/docs/examples/1.6.x/server-swift/examples/users/update-target.md b/docs/examples/1.6.x/server-swift/examples/users/update-target.md deleted file mode 100644 index d06d616f3c..0000000000 --- a/docs/examples/1.6.x/server-swift/examples/users/update-target.md +++ /dev/null @@ -1,17 +0,0 @@ -import Appwrite - -let client = Client() - .setEndpoint("https://cloud.appwrite.io/v1") // Your API Endpoint - .setProject("<YOUR_PROJECT_ID>") // Your project ID - .setKey("<YOUR_API_KEY>") // Your secret API key - -let users = Users(client) - -let target = try await users.updateTarget( - userId: "<USER_ID>", - targetId: "<TARGET_ID>", - identifier: "<IDENTIFIER>", // optional - providerId: "<PROVIDER_ID>", // optional - name: "<NAME>" // optional -) -